AISIX Cloud Admin API Changelog

Every released version of the AISIX Cloud Admin API is published in full, so you can read the API exactly as the version you run exposes it, and see what changed before you upgrade. The sections below list the differences between adjacent releases; a change marked Breaking requires a caller update.

• AISIX Cloud Admin API 0.11.0 — the API as shipped in 0.11.0
• AISIX Cloud Admin API 0.10.0 — the API as shipped in 0.10.0
• AISIX Cloud Admin API 0.9.0 — the API as shipped in 0.9.0

The current reference always tracks the latest release, which is 0.11.0.

From 0.10.0 to 0.11.0

Switch to Show all to see all changes

PATCH/environments/{env_id}

• Request Body
  • Newpropertydisplay_name

GET/environments/{env_id}/dp_nodes

• Responses
  • Modified response: 200
    • Modifiedpropertydata
      • Items changed
        • Required changed
          • Newrequired propertystatus
        • Newpropertystatus

GET/environments/{env_id}/guardrails

• Responses
  • Modified response: 200
    • Modifiedpropertydata
      • Items changed
        • Deletedpropertymandatory
        • Modifiedpropertykind
          • New enum values: [semantic custom]

POST/environments/{env_id}/guardrails

• Request Body
  • Deletedpropertymandatory
  • Modifiedpropertykind
    • New enum values: [semantic custom]
• Responses
  • Modified response: 201
    • Newpropertywarnings
    • Modifiedpropertyguardrail
      • Deletedpropertymandatory
      • Modifiedpropertykind
        • New enum values: [semantic custom]

POST/environments/{env_id}/guardrails/test-connection

• Request Body
  • Modifiedpropertykind
    • New enum values: [semantic custom]

GET/environments/{env_id}/guardrails/{guardrail_id}

• Responses
  • Modified response: 200
    • Newpropertywarnings
    • Modifiedpropertyguardrail
      • Deletedpropertymandatory
      • Modifiedpropertykind
        • New enum values: [semantic custom]

PATCH/environments/{env_id}/guardrails/{guardrail_id}

• Responses
  • Modified response: 200
    • Newpropertywarnings
    • Modifiedpropertyguardrail
      • Deletedpropertymandatory
      • Modifiedpropertykind
        • New enum values: [semantic custom]

GET/environments/{env_id}/mcp_policy

• Responses
  • Modified response: 200
    • Modifiedpropertymcp_policyBreakingBreaking
      • Schemas added: #/components/schemas/McpAccessPolicy
      • Type changed from 'object' to ''
      • AdditionalProperties changed from false to null
      • Nullable changed from false to true
      • Required changed
        • Deleted required property: allow
        • Deleted required property: created_at
        • Deleted required property: deny
        • Deleted required property: enabled
        • Deleted required property: id
        • Deleted required property: scope
        • Deleted required property: updated_at
      • DeletedpropertyallowBreaking
      • Deletedpropertycreated_atBreaking
      • DeletedpropertydenyBreaking
      • DeletedpropertyenabledBreaking
      • Deletedpropertyenv_id
      • DeletedpropertyidBreaking
      • DeletedpropertyscopeBreaking
      • Deletedpropertyteam_id
      • Deletedpropertyupdated_atBreaking

From 0.9.0 to 0.10.0

PATCH/environments/{env_id}

GET/environments/{env_id}/passthrough_routes

POST/environments/{env_id}/passthrough_routes

DELETE/environments/{env_id}/passthrough_routes/{passthrough_route_id}

GET/environments/{env_id}/passthrough_routes/{passthrough_route_id}

PATCH/environments/{env_id}/passthrough_routes/{passthrough_route_id}

GET/members/{member_id}/role_bindings

PUT/members/{member_id}/role_bindings

PATCH/members/{user_id}

GET/roles

POST/roles

DELETE/roles/{role_name}

PATCH/roles/{role_name}

POST/environments/{env_id}/mcp_policy/apply

POST/environments/{env_id}/mcp_policy/preview

Switch to Show all to see all changes

GET/environments

• Responses
  • Modified response: 200
    • Modifiedpropertydata
      • Items changed
        • Newpropertymcp_anonymous
        • Newpropertymcp_resource_url

POST/environments

• Responses
  • Modified response: 201
    • Modifiedpropertyenvironment
      • Newpropertymcp_anonymous
      • Newpropertymcp_resource_url

GET/environments/{env_id}

• Responses
  • Modified response: 200
    • Modifiedpropertyenvironment
      • Newpropertymcp_anonymous
      • Newpropertymcp_resource_url

GET/environments/{env_id}/api_keys

• Responses
  • Modified response: 200
    • Modifiedpropertydata
      • Items changed
        • Newpropertyallowed_routes
        • Deletedpropertyallowed_tools
        • Modifiedpropertymcp_access
          • Modified schema: #/components/schemas/McpAccess
            • Required changed
              • Newrequired propertyallow
              • Deleted required property: mode
            • DeletedpropertymodeBreaking

POST/environments/{env_id}/api_keys

• Request Body
  • Newpropertyallowed_routes
  • Deletedpropertyallowed_tools
  • Modifiedpropertymcp_access
    • Modified schema: #/components/schemas/McpAccess
      • Required changed
        • Newrequired propertyallowBreaking
        • Deleted required property: mode
      • DeletedpropertymodeBreaking
• Responses
  • Modified response: 201
    • Newpropertywarnings
    • Modifiedpropertyapi_key
      • Newpropertyallowed_routes
      • Deletedpropertyallowed_tools
      • Modifiedpropertymcp_access
        • Modified schema: #/components/schemas/McpAccess
          • Required changed
            • Newrequired propertyallowBreaking
            • Deleted required property: mode
          • DeletedpropertymodeBreaking

PATCH/environments/{env_id}/api_keys/{api_key_id}

• Request Body
  • Newpropertyallowed_routes
  • Deletedpropertyallowed_tools
  • Modifiedpropertymcp_access
    • Modified schema: #/components/schemas/McpAccess
      • Required changed
        • Newrequired propertyallowBreaking
        • Deleted required property: mode
      • DeletedpropertymodeBreaking
• Responses
  • Modified response: 200
    • Newpropertywarnings
    • Modifiedpropertyapi_key
      • Newpropertyallowed_routes
      • Deletedpropertyallowed_tools
      • Modifiedpropertymcp_access
        • Modified schema: #/components/schemas/McpAccess
          • Required changed
            • Newrequired propertyallowBreaking
            • Deleted required property: mode
          • DeletedpropertymodeBreaking

GET/environments/{env_id}/api_keys/{api_key_id}/effective_permissions

• Responses
  • Modified response: 200
    • Modifiedpropertyeffective_permissions
      • Modifiedpropertymcp
        • Required changed
          • Newrequired propertylayers
          • Deleted required property: base_source
          • Deleted required property: key_mode
        • Newpropertylayers
        • Deletedpropertybase_policy_id
        • Deletedpropertybase_sourceBreaking
        • Deletedpropertykey_modeBreaking

POST/environments/{env_id}/api_keys/{api_key_id}/rotate

• Responses
  • Modified response: 200
    • Newpropertywarnings
    • Modifiedpropertyapi_key
      • Newpropertyallowed_routes
      • Deletedpropertyallowed_tools
      • Modifiedpropertymcp_access
        • Modified schema: #/components/schemas/McpAccess
          • Required changed
            • Newrequired propertyallow
            • Deleted required property: mode
          • DeletedpropertymodeBreakingBreaking

GET/environments/{env_id}/guardrails/{guardrail_id}/attachments

• Responses
  • Modified response: 200
    • Modifiedpropertydata
      • Items changed
        • Modifiedpropertyscope_type
          • Extensions changed
            • Modified extension: x-enumDescriptions
              • Added /mcp_server with value: 'Apply to MCP tool calls routed to the MCP server identified byscope_id; the tool arguments and the tool result are both inspected.'
              • Added /passthrough_route with value: 'Apply to traffic served by the passthrough route identified byscope_id; the forwarded request body and the relayed response (including streamed frames, with hold-back) are both inspected.'
          • New enum values: [mcp_server passthrough_route]

POST/environments/{env_id}/guardrails/{guardrail_id}/attachments

• Request Body
  • Modifiedpropertyscope_type
    • Extensions changed
      • Modified extension: x-enumDescriptions
        • Added /mcp_server with value: 'Apply to MCP tool calls routed to the MCP server identified byscope_id; the tool arguments and the tool result are both inspected.'
        • Added /passthrough_route with value: 'Apply to traffic served by the passthrough route identified byscope_id; the forwarded request body and the relayed response (including streamed frames, with hold-back) are both inspected.'
    • New enum values: [mcp_server passthrough_route]
• Responses
  • Modified response: 201
    • Newpropertywarnings
    • Modifiedpropertydata
      • Modifiedpropertyscope_type
        • Extensions changed
          • Modified extension: x-enumDescriptions
            • Added /mcp_server with value: 'Apply to MCP tool calls routed to the MCP server identified byscope_id; the tool arguments and the tool result are both inspected.'
            • Added /passthrough_route with value: 'Apply to traffic served by the passthrough route identified byscope_id; the forwarded request body and the relayed response (including streamed frames, with hold-back) are both inspected.'
        • New enum values: [mcp_server passthrough_route]

GET/environments/{env_id}/mcp_policy

• Responses
  • Modified response: 200
    • Modifiedpropertymcp_policy
      • Required changed
        • Deleted required property: mode
      • DeletedpropertymodeBreaking

PUT/environments/{env_id}/mcp_policy

• Request Body
  • Required changed
    • Newrequired propertyallowBreaking
    • Deleted required property: mode
  • DeletedpropertymodeBreaking
• Responses
  • Modified response: 200
    • Modifiedpropertymcp_policy
      • Required changed
        • Deleted required property: mode
      • DeletedpropertymodeBreaking

GET/environments/{env_id}/models

• Responses
  • Modified response: 200
    • Modifiedpropertydata
      • Items changed
        • Modifiedpropertyrouting
          • Newpropertyhash_on
          • Deletedpropertysticky
          • Modifiedpropertystrategy
            • New enum values: [consistent_hash]
            • Deleted enum values: [weighted]
          • Modifiedpropertytargets
            • Items changed
              • Newpropertypriority

POST/environments/{env_id}/models

• Request Body
  • Modifiedpropertyrouting
    • Newpropertyhash_on
    • Deletedpropertysticky
    • Modifiedpropertystrategy
      • New enum values: [consistent_hash]
      • Deleted enum values: [weighted]
    • Modifiedpropertytargets
      • Items changed
        • Newpropertypriority
• Responses
  • Modified response: 201
    • Modifiedpropertymodel
      • Modifiedpropertyrouting
        • Newpropertyhash_on
        • Deletedpropertysticky
        • Modifiedpropertystrategy
          • New enum values: [consistent_hash]
          • Deleted enum values: [weighted]
        • Modifiedpropertytargets
          • Items changed
            • Newpropertypriority

GET/environments/{env_id}/models/{model_id}

• Responses
  • Modified response: 200
    • Modifiedpropertymodel
      • Modifiedpropertyrouting
        • Newpropertyhash_on
        • Deletedpropertysticky
        • Modifiedpropertystrategy
          • New enum values: [consistent_hash]
          • Deleted enum values: [weighted]
        • Modifiedpropertytargets
          • Items changed
            • Newpropertypriority

PATCH/environments/{env_id}/models/{model_id}

• Request Body
  • Modifiedpropertyrouting
    • Newpropertyhash_on
    • Deletedpropertysticky
    • Modifiedpropertystrategy
      • New enum values: [consistent_hash]
      • Deleted enum values: [weighted]
    • Modifiedpropertytargets
      • Items changed
        • Newpropertypriority
• Responses
  • Modified response: 200
    • Modifiedpropertymodel
      • Modifiedpropertyrouting
        • Newpropertyhash_on
        • Deletedpropertysticky
        • Modifiedpropertystrategy
          • New enum values: [consistent_hash]
          • Deleted enum values: [weighted]
        • Modifiedpropertytargets
          • Items changed
            • Newpropertypriority

POST/mcp_server_submissions

• Request Body
  • Newpropertyprotocol_version
• Responses
  • Modified response: 201
    • Newpropertywarnings
    • Modifiedpropertymcp_server
      • Newpropertyprotocol_version

PATCH/mcp_server_submissions/{mcp_server_id}

• Request Body
  • Newpropertyprotocol_version
• Responses
  • Modified response: 200
    • Newpropertywarnings
    • Modifiedpropertymcp_server
      • Newpropertyprotocol_version

GET/mcp_servers

• Responses
  • Modified response: 200
    • Modifiedpropertydata
      • Items changed
        • Newpropertyprotocol_version

POST/mcp_servers

• Request Body
  • Newpropertyprotocol_version
• Responses
  • Modified response: 201
    • Newpropertywarnings
    • Modifiedpropertymcp_server
      • Newpropertyprotocol_version

GET/mcp_servers/{mcp_server_id}

• Responses
  • Modified response: 200
    • Newpropertywarnings
    • Modifiedpropertymcp_server
      • Newpropertyprotocol_version

PATCH/mcp_servers/{mcp_server_id}

• Request Body
  • Newpropertyprotocol_version
• Responses
  • Modified response: 200
    • Newpropertywarnings
    • Modifiedpropertymcp_server
      • Newpropertyprotocol_version

POST/mcp_servers/{mcp_server_id}/approve

• Responses
  • Modified response: 200
    • Newpropertywarnings
    • Modifiedpropertymcp_server
      • Newpropertyprotocol_version

POST/mcp_servers/{mcp_server_id}/reject

• Responses
  • Modified response: 200
    • Newpropertywarnings
    • Modifiedpropertymcp_server
      • Newpropertyprotocol_version

GET/members

• Responses
  • Modified response: 200
    • Modifiedpropertydata
      • Items changed
        • Modifiedpropertyrole
          • Deleted enum values: [owner admin member]
          • MinLength changed from 0 to 1

POST/members

• Responses
  • Modified response: 201
    • Modifiedpropertymember
      • Modifiedpropertyrole
        • Deleted enum values: [owner admin member]
        • MinLength changed from 0 to 1

GET/teams/{team_id}/entitlements

• Responses
  • Modified response: 200
    • Modifiedpropertyentitlements
      • Modifiedpropertymcp
        • Modified schema: #/components/schemas/McpAccessPolicy
          • Required changed
            • Deleted required property: mode
          • DeletedpropertymodeBreaking

PUT/teams/{team_id}/entitlements

• Request Body
  • Modifiedpropertymcp
    • Modified schema: #/components/schemas/PutMcpPolicyRequest
      • Required changed
        • Newrequired propertyallowBreaking
        • Deleted required property: mode
      • DeletedpropertymodeBreaking
• Responses
  • Modified response: 200
    • Modifiedpropertyentitlements
      • Modifiedpropertymcp
        • Modified schema: #/components/schemas/McpAccessPolicy
          • Required changed
            • Deleted required property: mode
          • DeletedpropertymodeBreaking