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 1.3.0 — the API as shipped in 1.3.0
• AISIX Cloud Admin API 1.2.0 — the API as shipped in 1.2.0
• AISIX Cloud Admin API 1.1.0 — the API as shipped in 1.1.0
• AISIX Cloud Admin API 1.0.0 — the API as shipped in 1.0.0
• AISIX Cloud Admin API 0.13.0 — the API as shipped in 0.13.0
• AISIX Cloud Admin API 0.12.0 — the API as shipped in 0.12.0
• 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

From 1.2.0 to 1.3.0

GET/data_export

POST/data_import

GET/notification_deliveries/{delivery_id}

Switch to Show all to see all changes

GET/environments/{env_id}/guardrails

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

POST/environments/{env_id}/guardrails

• Request Body
  • Newpropertyinput_messages
• Responses
  • Modified response: 201
    • Modifiedpropertyguardrail
      • Newpropertyinput_messages

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

• Responses
  • Modified response: 200
    • Modifiedpropertyguardrail
      • Newpropertyinput_messages

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

• Request Body
  • Newpropertyinput_messages
• Responses
  • Modified response: 200
    • Modifiedpropertyguardrail
      • Newpropertyinput_messages

GET/environments/{env_id}/models

• Responses
  • Modified response: 200
    • Modifiedpropertydata
      • Items changed
        • Modifiedpropertyeffort_mapping
          • AdditionalProperties changed
            • Nullable changed from false to true
            • MinLength changed from 0 to 1

POST/environments/{env_id}/models

• Request Body
  • Modifiedpropertyeffort_mapping
    • Modified schema: #/components/schemas/EffortMapping
      • AdditionalProperties changed
        • Nullable changed from false to true
        • MinLength changed from 0 to 1
• Responses
  • Modified response: 201
    • Modifiedpropertymodel
      • Modifiedpropertyeffort_mapping
        • AdditionalProperties changed
          • Nullable changed from false to true
          • MinLength changed from 0 to 1

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

• Responses
  • Modified response: 200
    • Modifiedpropertymodel
      • Modifiedpropertyeffort_mapping
        • AdditionalProperties changed
          • Nullable changed from false to true
          • MinLength changed from 0 to 1

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

• Request Body
  • Modifiedpropertyeffort_mapping
    • Modified schema: #/components/schemas/EffortMapping
      • AdditionalProperties changed
        • Nullable changed from false to true
        • MinLength changed from 0 to 1
• Responses
  • Modified response: 200
    • Modifiedpropertymodel
      • Modifiedpropertyeffort_mapping
        • AdditionalProperties changed
          • Nullable changed from false to true
          • MinLength changed from 0 to 1

GET/notification_channels

• Responses
  • Modified response: 200
    • Modifiedpropertydata
      • Items changed
        • Required changed
          • Newrequired propertybody_template
          • Newrequired propertyheaders
        • Newpropertybody_template
        • Newpropertyheaders

POST/notification_channels

• Request Body
  • Newpropertybody_template
  • Newpropertyheaders
• Responses
  • Modified response: 201
    • Modifiedpropertynotification_channel
      • Required changed
        • Newrequired propertybody_template
        • Newrequired propertyheaders
      • Newpropertybody_template
      • Newpropertyheaders

GET/notification_channels/{channel_id}

• Responses
  • Modified response: 200
    • Modifiedpropertynotification_channel
      • Required changed
        • Newrequired propertybody_template
        • Newrequired propertyheaders
      • Newpropertybody_template
      • Newpropertyheaders

PATCH/notification_channels/{channel_id}

• Request Body
  • Newpropertybody_template
  • Newpropertyheaders
• Responses
  • Modified response: 200
    • Modifiedpropertynotification_channel
      • Required changed
        • Newrequired propertybody_template
        • Newrequired propertyheaders
      • Newpropertybody_template
      • Newpropertyheaders

POST/notification_channels/{channel_id}/test

• Responses
  • Modified response: 200
    • Newpropertyrequest_body
    • Newpropertyresponse_body
    • Newpropertyresponse_status

GET/notification_deliveries

• Responses
  • Modified response: 200
    • Modifiedpropertydata
      • Items changed
        • Required changed
          • Newrequired propertylast_response_body
          • Newrequired propertylast_response_body_truncated
          • Newrequired propertylast_response_status
        • Newpropertylast_response_body
        • Newpropertylast_response_body_truncated
        • Newpropertylast_response_status

POST/provider_keys

• Request Body
  • Newpropertyresolve_addresses

GET/provider_keys/{provider_key_id}

• Responses
  • Modified response: 200
    • Modifiedpropertyprovider_key
      • Newpropertyresolve_addresses

PATCH/provider_keys/{provider_key_id}

• Request Body
  • Newpropertyresolve_addresses
• Responses
  • Modified response: 200
    • Modifiedpropertyprovider_key
      • Newpropertyresolve_addresses

POST/roles

• Request Body
  • Modifiedpropertypermissions
    • Items changed
      • Modified schema: #/components/schemas/RoleReadPermissionInput
        • Modifiedpropertyresource
          • New enum values: [data_export]

PATCH/roles/{role_name}

• Request Body
  • Modifiedpropertypermissions
    • Items changed
      • Modified schema: #/components/schemas/RoleReadPermissionInput
        • Modifiedpropertyresource
          • New enum values: [data_export]

From 1.1.0 to 1.2.0

Switch to Show all to see all changes

POST/a2a_agents

• Responses
  • New response: 422
  • Modified response: 201
    • Modifiedpropertywarnings
      • Items changed
        • Modifiedpropertycode
          • New enum values: [below_floor]
          • Deleted enum values: [row_rejected]

GET/a2a_agents/{a2a_agent_id}

• Responses
  • Modified response: 200
    • Modifiedpropertywarnings
      • Items changed
        • Modifiedpropertycode
          • New enum values: [below_floor]
          • Deleted enum values: [row_rejected]

PATCH/a2a_agents/{a2a_agent_id}

• Responses
  • New response: 422
  • Modified response: 200
    • Modifiedpropertywarnings
      • Items changed
        • Modifiedpropertycode
          • New enum values: [below_floor]
          • Deleted enum values: [row_rejected]

PATCH/environments/{env_id}

• Responses
  • New response: 422

POST/environments/{env_id}/api_keys

• Responses
  • New response: 422
  • Modified response: 201
    • Modifiedpropertywarnings
      • Items changed
        • Modifiedpropertycode
          • New enum values: [below_floor]
          • Deleted enum values: [row_rejected]

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

• Responses
  • New response: 422
  • Modified response: 200
    • Modifiedpropertywarnings
      • Items changed
        • Modifiedpropertycode
          • New enum values: [below_floor]
          • Deleted enum values: [row_rejected]

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

• Responses
  • New response: 422
  • Modified response: 200
    • Modifiedpropertywarnings
      • Items changed
        • Modifiedpropertycode
          • New enum values: [below_floor]
          • Deleted enum values: [row_rejected]

POST/environments/{env_id}/cache_policies

• Responses
  • New response: 422
  • Modified response: 201
    • Modifiedpropertywarnings
      • Items changed
        • Modifiedpropertycode
          • New enum values: [below_floor]
          • Deleted enum values: [row_rejected]

GET/environments/{env_id}/cache_policies/{cache_policy_id}

• Responses
  • Modified response: 200
    • Modifiedpropertywarnings
      • Items changed
        • Modifiedpropertycode
          • New enum values: [below_floor]
          • Deleted enum values: [row_rejected]

PATCH/environments/{env_id}/cache_policies/{cache_policy_id}

• Responses
  • New response: 422
  • Modified response: 200
    • Modifiedpropertywarnings
      • Items changed
        • Modifiedpropertycode
          • New enum values: [below_floor]
          • Deleted enum values: [row_rejected]

POST/environments/{env_id}/cache_policies/{cache_policy_id}/purge

• Responses
  • New response: 422
  • Modified response: 200
    • Modifiedpropertywarnings
      • Items changed
        • Modifiedpropertycode
          • New enum values: [below_floor]
          • Deleted enum values: [row_rejected]

POST/environments/{env_id}/claim_mappings

• Responses
  • New response: 422
  • Modified response: 201
    • Modifiedpropertywarnings
      • Items changed
        • Modifiedpropertycode
          • New enum values: [below_floor]
          • Deleted enum values: [row_rejected]

GET/environments/{env_id}/claim_mappings/{claim_mapping_id}

• Responses
  • Modified response: 200
    • Modifiedpropertywarnings
      • Items changed
        • Modifiedpropertycode
          • New enum values: [below_floor]
          • Deleted enum values: [row_rejected]

PATCH/environments/{env_id}/claim_mappings/{claim_mapping_id}

• Responses
  • New response: 422
  • Modified response: 200
    • Modifiedpropertywarnings
      • Items changed
        • Modifiedpropertycode
          • New enum values: [below_floor]
          • Deleted enum values: [row_rejected]

POST/environments/{env_id}/guardrails

• Responses
  • New response: 422
  • Modified response: 201
    • Modifiedpropertywarnings
      • Items changed
        • Modifiedpropertycode
          • New enum values: [below_floor]
          • Deleted enum values: [row_rejected]

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

• Responses
  • Modified response: 200
    • Modifiedpropertywarnings
      • Items changed
        • Modifiedpropertycode
          • New enum values: [below_floor]
          • Deleted enum values: [row_rejected]

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

• Responses
  • New response: 422
  • Modified response: 200
    • Modifiedpropertywarnings
      • Items changed
        • Modifiedpropertycode
          • New enum values: [below_floor]
          • Deleted enum values: [row_rejected]

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

• Responses
  • Modified response: 200
    • Modifiedpropertydata
      • Items changed
        • Modifiedpropertyscope_type
          • Extensions changed
            • Modified extension: x-enumDescriptions
              • Modified /model from 'Apply when the request targets the model identified byscope_id.' to 'Apply when the request is addressed to the model identified byscope_id. Scope follows the entry the caller addresses: a guardrail attached to a model runs only for requests addressed to that model. When the model is reached as a member of a routing, semantic, or ensemble group, its guardrails do not run — attach the guardrail to the group instead.'

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

• Request Body
  • Modifiedpropertyscope_type
    • Extensions changed
      • Modified extension: x-enumDescriptions
        • Modified /model from 'Apply when the request targets the model identified byscope_id.' to 'Apply when the request is addressed to the model identified byscope_id. Scope follows the entry the caller addresses: a guardrail attached to a model runs only for requests addressed to that model. When the model is reached as a member of a routing, semantic, or ensemble group, its guardrails do not run — attach the guardrail to the group instead.'
• Responses
  • New response: 422
  • Modified response: 201
    • Modifiedpropertydata
      • Modifiedpropertyscope_type
        • Extensions changed
          • Modified extension: x-enumDescriptions
            • Modified /model from 'Apply when the request targets the model identified byscope_id.' to 'Apply when the request is addressed to the model identified byscope_id. Scope follows the entry the caller addresses: a guardrail attached to a model runs only for requests addressed to that model. When the model is reached as a member of a routing, semantic, or ensemble group, its guardrails do not run — attach the guardrail to the group instead.'
    • Modifiedpropertywarnings
      • Items changed
        • Modifiedpropertycode
          • New enum values: [below_floor]
          • Deleted enum values: [row_rejected]

PUT/environments/{env_id}/mcp_policy

• Responses
  • New response: 422

POST/environments/{env_id}/models

• Responses
  • New response: 422
  • Modified response: 201
    • Modifiedpropertywarnings
      • Items changed
        • Modifiedpropertycode
          • New enum values: [below_floor]
          • Deleted enum values: [row_rejected]

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

• Responses
  • Modified response: 200
    • Modifiedpropertywarnings
      • Items changed
        • Modifiedpropertycode
          • New enum values: [below_floor]
          • Deleted enum values: [row_rejected]

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

• Responses
  • New response: 422
  • Modified response: 200
    • Modifiedpropertywarnings
      • Items changed
        • Modifiedpropertycode
          • New enum values: [below_floor]
          • Deleted enum values: [row_rejected]

POST/environments/{env_id}/observability_exporters

• Responses
  • New response: 422

PATCH/environments/{env_id}/observability_exporters/{exporter_id}

• Responses
  • New response: 422

POST/environments/{env_id}/oidc_providers

• Responses
  • New response: 422

PATCH/environments/{env_id}/oidc_providers/{oidc_provider_id}

• Responses
  • New response: 422

POST/environments/{env_id}/passthrough_routes

• Responses
  • New response: 422
  • Modified response: 201
    • Modifiedpropertywarnings
      • Items changed
        • Modifiedpropertycode
          • New enum values: [below_floor]
          • Deleted enum values: [row_rejected]

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

• Responses
  • Modified response: 200
    • Modifiedpropertywarnings
      • Items changed
        • Modifiedpropertycode
          • New enum values: [below_floor]
          • Deleted enum values: [row_rejected]

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

• Responses
  • New response: 422
  • Modified response: 200
    • Modifiedpropertywarnings
      • Items changed
        • Modifiedpropertycode
          • New enum values: [below_floor]
          • Deleted enum values: [row_rejected]

POST/environments/{env_id}/rate_limits

• Responses
  • New response: 422
  • Modified response: 201
    • Modifiedpropertywarnings
      • Items changed
        • Modifiedpropertycode
          • New enum values: [below_floor]
          • Deleted enum values: [row_rejected]

GET/environments/{env_id}/rate_limits/{rate_limit_id}

• Responses
  • Modified response: 200
    • Modifiedpropertywarnings
      • Items changed
        • Modifiedpropertycode
          • New enum values: [below_floor]
          • Deleted enum values: [row_rejected]

PATCH/environments/{env_id}/rate_limits/{rate_limit_id}

• Responses
  • New response: 422
  • Modified response: 200
    • Modifiedpropertywarnings
      • Items changed
        • Modifiedpropertycode
          • New enum values: [below_floor]
          • Deleted enum values: [row_rejected]

GET/environments/{env_id}/usage_events

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

GET/environments/{env_id}/usage_events/export

• Responses
  • Modified response: 200
    • Modifiedpropertydata
      • Items changed
        • Modified schema: #/components/schemas/UsageEvent
          • Newpropertycache_write_tokens

POST/mcp_server_submissions

• Responses
  • Modified response: 201
    • Modifiedpropertywarnings
      • Items changed
        • Modifiedpropertycode
          • New enum values: [below_floor]
          • Deleted enum values: [row_rejected]

PATCH/mcp_server_submissions/{mcp_server_id}

• Responses
  • New response: 422
  • Modified response: 200
    • Modifiedpropertywarnings
      • Items changed
        • Modifiedpropertycode
          • New enum values: [below_floor]
          • Deleted enum values: [row_rejected]

POST/mcp_servers

• Responses
  • New response: 422
  • Modified response: 201
    • Modifiedpropertywarnings
      • Items changed
        • Modifiedpropertycode
          • New enum values: [below_floor]
          • Deleted enum values: [row_rejected]

GET/mcp_servers/{mcp_server_id}

• Responses
  • Modified response: 200
    • Modifiedpropertywarnings
      • Items changed
        • Modifiedpropertycode
          • New enum values: [below_floor]
          • Deleted enum values: [row_rejected]

PATCH/mcp_servers/{mcp_server_id}

• Responses
  • New response: 422
  • Modified response: 200
    • Modifiedpropertywarnings
      • Items changed
        • Modifiedpropertycode
          • New enum values: [below_floor]
          • Deleted enum values: [row_rejected]

POST/mcp_servers/{mcp_server_id}/approve

• Responses
  • New response: 422
  • Modified response: 200
    • Modifiedpropertywarnings
      • Items changed
        • Modifiedpropertycode
          • New enum values: [below_floor]
          • Deleted enum values: [row_rejected]

POST/mcp_servers/{mcp_server_id}/reject

• Responses
  • Modified response: 200
    • Modifiedpropertywarnings
      • Items changed
        • Modifiedpropertycode
          • New enum values: [below_floor]
          • Deleted enum values: [row_rejected]

PUT/model_pricing

• Responses
  • New response: 422

POST/provider_keys

• Responses
  • New response: 422
  • Modified response: 201
    • Modifiedpropertywarnings
      • Items changed
        • Modifiedpropertycode
          • New enum values: [below_floor]
          • Deleted enum values: [row_rejected]

GET/provider_keys/{provider_key_id}

• Responses
  • Modified response: 200
    • Modifiedpropertywarnings
      • Items changed
        • Modifiedpropertycode
          • New enum values: [below_floor]
          • Deleted enum values: [row_rejected]

PATCH/provider_keys/{provider_key_id}

• Responses
  • New response: 422
  • Modified response: 200
    • Modifiedpropertywarnings
      • Items changed
        • Modifiedpropertycode
          • New enum values: [below_floor]
          • Deleted enum values: [row_rejected]

From 1.0.0 to 1.1.0

Switch to Show all to see all changes

GET/a2a_agents

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

POST/a2a_agents

• Request Body
  • Newpropertyforward_client_headers
• Responses
  • Modified response: 201
    • Newpropertywarnings
    • Modifiedpropertya2a_agent
      • Newpropertyforward_client_headers

GET/a2a_agents/{a2a_agent_id}

• Responses
  • Modified response: 200
    • Newpropertywarnings
    • Modifiedpropertya2a_agent
      • Newpropertyforward_client_headers

PATCH/a2a_agents/{a2a_agent_id}

• Request Body
  • Newpropertyforward_client_headers
• Responses
  • Modified response: 200
    • Newpropertywarnings
    • Modifiedpropertya2a_agent
      • Newpropertyforward_client_headers

From 0.13.0 to 1.0.0

Switch to Show all to see all changes

GET/environments/{env_id}/guardrails

• Responses
  • Modified response: 200
    • Modifiedpropertydata
      • Items changed
        • Modifiedpropertyenforcement_mode
          • Extensions changed
            • Modified extension: x-enumDescriptions
              • Modified /monitor from 'Record what would have happened without blocking or redacting caller-visible content.' to 'Record what the verdict would have done, without blocking or redacting caller-visible content. Does not exempt the row from a refusal raised because the gateway could not read the content the guardrail would have scanned — that carries no verdict to downgrade, andfail_opengoverns it.'

POST/environments/{env_id}/guardrails

• Request Body
  • Modifiedpropertyenforcement_mode
    • Extensions changed
      • Modified extension: x-enumDescriptions
        • Modified /monitor from 'Record what would have happened without blocking or redacting caller-visible content.' to 'Record what the verdict would have done, without blocking or redacting caller-visible content. Does not exempt the row from a refusal raised because the gateway could not read the content the guardrail would have scanned — that carries no verdict to downgrade, andfail_opengoverns it.'
• Responses
  • Modified response: 201
    • Modifiedpropertyguardrail
      • Modifiedpropertyenforcement_mode
        • Extensions changed
          • Modified extension: x-enumDescriptions
            • Modified /monitor from 'Record what would have happened without blocking or redacting caller-visible content.' to 'Record what the verdict would have done, without blocking or redacting caller-visible content. Does not exempt the row from a refusal raised because the gateway could not read the content the guardrail would have scanned — that carries no verdict to downgrade, andfail_opengoverns it.'

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

• Responses
  • Modified response: 200
    • Modifiedpropertyguardrail
      • Modifiedpropertyenforcement_mode
        • Extensions changed
          • Modified extension: x-enumDescriptions
            • Modified /monitor from 'Record what would have happened without blocking or redacting caller-visible content.' to 'Record what the verdict would have done, without blocking or redacting caller-visible content. Does not exempt the row from a refusal raised because the gateway could not read the content the guardrail would have scanned — that carries no verdict to downgrade, andfail_opengoverns it.'

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

• Request Body
  • Modifiedpropertyenforcement_mode
    • Extensions changed
      • Modified extension: x-enumDescriptions
        • Modified /monitor from 'Record what would have happened without blocking or redacting caller-visible content.' to 'Record what the verdict would have done, without blocking or redacting caller-visible content. Does not exempt the row from a refusal raised because the gateway could not read the content the guardrail would have scanned — that carries no verdict to downgrade, andfail_opengoverns it.'
• Responses
  • Modified response: 200
    • Modifiedpropertyguardrail
      • Modifiedpropertyenforcement_mode
        • Extensions changed
          • Modified extension: x-enumDescriptions
            • Modified /monitor from 'Record what would have happened without blocking or redacting caller-visible content.' to 'Record what the verdict would have done, without blocking or redacting caller-visible content. Does not exempt the row from a refusal raised because the gateway could not read the content the guardrail would have scanned — that carries no verdict to downgrade, andfail_opengoverns it.'

GET/environments/{env_id}/models

• Responses
  • Modified response: 200
    • Modifiedpropertydata
      • Items changed
        • Newpropertyeffort_mapping
        • Modifiedpropertycooldown
          • Modifiedpropertyenabled
            • Default changed from null to false

POST/environments/{env_id}/models

• Request Body
  • Newpropertyeffort_mapping
  • Modifiedpropertycooldown
    • Modifiedpropertyenabled
      • Default changed from null to false
• Responses
  • Modified response: 201
    • Modifiedpropertymodel
      • Newpropertyeffort_mapping
      • Modifiedpropertycooldown
        • Modifiedpropertyenabled
          • Default changed from null to false

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

• Responses
  • Modified response: 200
    • Modifiedpropertymodel
      • Newpropertyeffort_mapping
      • Modifiedpropertycooldown
        • Modifiedpropertyenabled
          • Default changed from null to false

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

• Request Body
  • Newpropertyeffort_mapping
  • Modifiedpropertycooldown
    • Modifiedpropertyenabled
      • Default changed from null to false
• Responses
  • Modified response: 200
    • Modifiedpropertymodel
      • Newpropertyeffort_mapping
      • Modifiedpropertycooldown
        • Modifiedpropertyenabled
          • Default changed from null to false

GET/environments/{env_id}/passthrough_routes

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

POST/environments/{env_id}/passthrough_routes

• Request Body
  • Newpropertyforward_client_headers
• Responses
  • Modified response: 201
    • Modifiedpropertypassthrough_route
      • Newpropertyforward_client_headers

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

• Responses
  • Modified response: 200
    • Modifiedpropertypassthrough_route
      • Newpropertyforward_client_headers

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

• Request Body
  • Newpropertyforward_client_headers
• Responses
  • Modified response: 200
    • Modifiedpropertypassthrough_route
      • Newpropertyforward_client_headers

GET/environments/{env_id}/usage_events

• Newquery paramrequested_model_exact
• Responses
  • Modified response: 200
    • Modifiedpropertydata
      • Items changed
        • Newpropertyguardrail_scores

GET/environments/{env_id}/usage_events/export

• Newquery paramrequested_model_exact
• Responses
  • Modified response: 200
    • Modifiedpropertydata
      • Items changed
        • Modified schema: #/components/schemas/UsageEvent
          • Newpropertyguardrail_scores

POST/mcp_server_submissions

• Request Body
  • Newpropertyforward_client_headers
• Responses
  • Modified response: 201
    • Modifiedpropertymcp_server
      • Newpropertyforward_client_headers

PATCH/mcp_server_submissions/{mcp_server_id}

• Request Body
  • Newpropertyforward_client_headers
• Responses
  • Modified response: 200
    • Modifiedpropertymcp_server
      • Newpropertyforward_client_headers

GET/mcp_servers

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

POST/mcp_servers

• Request Body
  • Newpropertyforward_client_headers
• Responses
  • Modified response: 201
    • Modifiedpropertymcp_server
      • Newpropertyforward_client_headers

GET/mcp_servers/{mcp_server_id}

• Responses
  • Modified response: 200
    • Modifiedpropertymcp_server
      • Newpropertyforward_client_headers

PATCH/mcp_servers/{mcp_server_id}

• Request Body
  • Newpropertyforward_client_headers
• Responses
  • Modified response: 200
    • Modifiedpropertymcp_server
      • Newpropertyforward_client_headers

POST/mcp_servers/{mcp_server_id}/approve

• Responses
  • Modified response: 200
    • Modifiedpropertymcp_server
      • Newpropertyforward_client_headers

POST/mcp_servers/{mcp_server_id}/reject

• Responses
  • Modified response: 200
    • Modifiedpropertymcp_server
      • Newpropertyforward_client_headers

From 0.12.0 to 0.13.0

Switch to Show all to see all changes

GET/environments/{env_id}/usage_events

• Newquery paramoperation
• Responses
  • Modified response: 200
    • Modifiedpropertydata
      • Items changed
        • Newpropertyoperation

GET/environments/{env_id}/usage_events/export

• Newquery paramoperation
• Responses
  • Modified response: 200
    • Modifiedpropertydata
      • Items changed
        • Modified schema: #/components/schemas/UsageEvent
          • Newpropertyoperation

POST/provider_keys

• Request Body
  • Newpropertyapis
• Responses
  • Modified response: 201
    • Newpropertywarnings

GET/provider_keys/{provider_key_id}

• Responses
  • Modified response: 200
    • Newpropertywarnings
    • Modifiedpropertyprovider_key
      • Newpropertyapis
      • Newpropertyapis_source

PATCH/provider_keys/{provider_key_id}

• Request Body
  • Newpropertyapis
• Responses
  • Modified response: 200
    • Newpropertywarnings
    • Modifiedpropertyprovider_key
      • Newpropertyapis
      • Newpropertyapis_source

From 0.11.0 to 0.12.0

GET/environments/{env_id}/usage_events

GET/environments/{env_id}/usage_events/export

GET/environments/{env_id}/usage_metrics

GET/environments/{env_id}/usage_summary

GET/invitations

POST/invitations

DELETE/invitations/{invitation_id}

DELETE/members/{user_id}

GET/model_pricing

PUT/model_pricing

DELETE/model_pricing/{id}

GET/notification_deliveries

GET/teams

POST/teams

DELETE/teams/{team_id}

GET/teams/{team_id}

PATCH/teams/{team_id}

GET/teams/{team_id}/members

POST/teams/{team_id}/members

DELETE/teams/{team_id}/members/{user_id}

PATCH/teams/{team_id}/members/{user_id}

Switch to Show all to see all changes

DELETE/environments/{env_id}/api_keys/{api_key_id}

• Responses
  • New response: 409

DELETE/environments/{env_id}/oidc_providers/{oidc_provider_id}

• Responses
  • Modified response: 200
    • Newpropertywarnings

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_policyBreaking
      • 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
          • DeletedpropertymodeBreaking

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