AISIX Cloud Admin API

AISIX Cloud Admin API reference for organization-scoped automation in AISIX Cloud and AISIX Cloud On-Premises, generated from the AISIX control plane OpenAPI source.

API version

List Environments — GET /environments
Create Environment — POST /environments
Get Environment by ID — GET /environments/{env_id}
Update Environment — PATCH /environments/{env_id}
Delete Environment — DELETE /environments/{env_id}
List Models — GET /environments/{env_id}/models
Create Model — POST /environments/{env_id}/models
Get Model by ID — GET /environments/{env_id}/models/{model_id}
Update Model — PATCH /environments/{env_id}/models/{model_id}
Delete Model — DELETE /environments/{env_id}/models/{model_id}
List Caller API Keys — GET /environments/{env_id}/api_keys
Create Caller API Key — POST /environments/{env_id}/api_keys
Update Caller API Key — PATCH /environments/{env_id}/api_keys/{api_key_id}
Delete Caller API Key — DELETE /environments/{env_id}/api_keys/{api_key_id}
Rotate Caller API Key — POST /environments/{env_id}/api_keys/{api_key_id}/rotate
List Provider Keys — GET /provider_keys
Create Provider Key — POST /provider_keys
Get Provider Key by ID — GET /provider_keys/{provider_key_id}
Update Provider Key — PATCH /provider_keys/{provider_key_id}
Delete Provider Key — DELETE /provider_keys/{provider_key_id}
Get Effective Permissions — GET /environments/{env_id}/api_keys/{api_key_id}/effective_permissions
List MCP Servers — GET /mcp_servers
Create MCP Server — POST /mcp_servers
Get MCP Server by ID — GET /mcp_servers/{mcp_server_id}
Update MCP Server — PATCH /mcp_servers/{mcp_server_id}
Delete MCP Server — DELETE /mcp_servers/{mcp_server_id}
List Generated MCP Tools — GET /mcp_servers/{mcp_server_id}/tools
Approve MCP Server — POST /mcp_servers/{mcp_server_id}/approve
Reject MCP Server — POST /mcp_servers/{mcp_server_id}/reject
Submit MCP Server for Review — POST /mcp_server_submissions
Revise a Submitted MCP Server — PATCH /mcp_server_submissions/{mcp_server_id}
List Members — GET /members
Create Member — POST /members
Update Member Organization Role — PATCH /members/{user_id}
Remove Organization Member — DELETE /members/{user_id}
List Member Environment Role Bindings — GET /members/{member_id}/role_bindings
Replace Member Environment Role Bindings — PUT /members/{member_id}/role_bindings
List Roles — GET /roles
Create Custom Role — POST /roles
Update Custom Role — PATCH /roles/{role_name}
Delete Custom Role — DELETE /roles/{role_name}
List A2A Agents — GET /a2a_agents
Create A2A Agent — POST /a2a_agents
Get A2A Agent by ID — GET /a2a_agents/{a2a_agent_id}
Update A2A Agent — PATCH /a2a_agents/{a2a_agent_id}
Delete A2A Agent — DELETE /a2a_agents/{a2a_agent_id}
List Guardrails — GET /environments/{env_id}/guardrails
Create Guardrail — POST /environments/{env_id}/guardrails
Test Guardrail Connection — POST /environments/{env_id}/guardrails/test-connection
Get Guardrail by ID — GET /environments/{env_id}/guardrails/{guardrail_id}
Update Guardrail — PATCH /environments/{env_id}/guardrails/{guardrail_id}
Delete Guardrail — DELETE /environments/{env_id}/guardrails/{guardrail_id}
List Guardrail Attachments — GET /environments/{env_id}/guardrails/{guardrail_id}/attachments
Attach Guardrail to a Scope — POST /environments/{env_id}/guardrails/{guardrail_id}/attachments
Detach Guardrail from a Scope — DELETE /environments/{env_id}/guardrails/{guardrail_id}/attachments/{attachment_id}
List Guardrail Providers — GET /guardrails/providers
Get Guardrail Config Schema — GET /guardrails/schema
List Cache Policies — GET /environments/{env_id}/cache_policies
Create Cache Policy — POST /environments/{env_id}/cache_policies
Get Cache Policy by ID — GET /environments/{env_id}/cache_policies/{cache_policy_id}
Update Cache Policy — PATCH /environments/{env_id}/cache_policies/{cache_policy_id}
Delete Cache Policy — DELETE /environments/{env_id}/cache_policies/{cache_policy_id}
Purge Cache Policy Entries — POST /environments/{env_id}/cache_policies/{cache_policy_id}/purge
List Observability Exporters — GET /environments/{env_id}/observability_exporters
Create Observability Exporter — POST /environments/{env_id}/observability_exporters
Get Observability Exporter by ID — GET /environments/{env_id}/observability_exporters/{exporter_id}
Update Observability Exporter — PATCH /environments/{env_id}/observability_exporters/{exporter_id}
Delete Observability Exporter — DELETE /environments/{env_id}/observability_exporters/{exporter_id}
List Rate Limit Policies — GET /environments/{env_id}/rate_limits
Create Rate Limit Policy — POST /environments/{env_id}/rate_limits
Get Rate Limit Policy by ID — GET /environments/{env_id}/rate_limits/{rate_limit_id}
Update Rate Limit Policy — PATCH /environments/{env_id}/rate_limits/{rate_limit_id}
Delete Rate Limit Policy — DELETE /environments/{env_id}/rate_limits/{rate_limit_id}
List OIDC Providers — GET /environments/{env_id}/oidc_providers
Create OIDC Provider — POST /environments/{env_id}/oidc_providers
Get OIDC Provider by ID — GET /environments/{env_id}/oidc_providers/{oidc_provider_id}
Update OIDC Provider — PATCH /environments/{env_id}/oidc_providers/{oidc_provider_id}
Delete OIDC Provider — DELETE /environments/{env_id}/oidc_providers/{oidc_provider_id}
List Claim Mappings — GET /environments/{env_id}/claim_mappings
Create Claim Mapping — POST /environments/{env_id}/claim_mappings
Get Claim Mapping by ID — GET /environments/{env_id}/claim_mappings/{claim_mapping_id}
Update Claim Mapping — PATCH /environments/{env_id}/claim_mappings/{claim_mapping_id}
Delete Claim Mapping — DELETE /environments/{env_id}/claim_mappings/{claim_mapping_id}
List Passthrough Routes — GET /environments/{env_id}/passthrough_routes
Create Passthrough Route — POST /environments/{env_id}/passthrough_routes
Get Passthrough Route by ID — GET /environments/{env_id}/passthrough_routes/{passthrough_route_id}
Update Passthrough Route — PATCH /environments/{env_id}/passthrough_routes/{passthrough_route_id}
Delete Passthrough Route — DELETE /environments/{env_id}/passthrough_routes/{passthrough_route_id}
Get MCP Access Policy — GET /environments/{env_id}/mcp_policy
Set MCP Access Policy — PUT /environments/{env_id}/mcp_policy
Delete MCP Access Policy — DELETE /environments/{env_id}/mcp_policy
Get Team Entitlements — GET /teams/{team_id}/entitlements
Set Team Entitlements — PUT /teams/{team_id}/entitlements
List Data Plane Nodes — GET /environments/{env_id}/dp_nodes
List Rejected Resources — GET /environments/{env_id}/rejected_resources
List Budgets — GET /budgets
Create Budget — POST /budgets
Get Budget — GET /budgets/{budget_id}
Update Budget — PATCH /budgets/{budget_id}
Delete Budget — DELETE /budgets/{budget_id}
List Notification Channels — GET /notification_channels
Create Notification Channel — POST /notification_channels
Get Notification Channel — GET /notification_channels/{channel_id}
Update Notification Channel — PATCH /notification_channels/{channel_id}
Delete Notification Channel — DELETE /notification_channels/{channel_id}
Test Notification Channel — POST /notification_channels/{channel_id}/test
List Usage Events — GET /environments/{env_id}/usage_events
Export Usage Events — GET /environments/{env_id}/usage_events/export
Get Usage Summary — GET /environments/{env_id}/usage_summary
Get Usage Metrics — GET /environments/{env_id}/usage_metrics
List Teams — GET /teams
Create Team — POST /teams
Get Team — GET /teams/{team_id}
Update Team — PATCH /teams/{team_id}
Delete Team — DELETE /teams/{team_id}
List Team Members — GET /teams/{team_id}/members
Add Team Member — POST /teams/{team_id}/members
Update Team Member Role — PATCH /teams/{team_id}/members/{user_id}
Remove Team Member — DELETE /teams/{team_id}/members/{user_id}
List Invitations — GET /invitations
Create Invitation — POST /invitations
Revoke Invitation — DELETE /invitations/{invitation_id}
List Model Prices — GET /model_pricing
Set Model Price Override — PUT /model_pricing
Delete Model Price Override — DELETE /model_pricing/{id}
List Notification Deliveries — GET /notification_deliveries