AISIX Admin API

Get model health levels and configuration-watch freshness for this gateway.

Process liveness: 200 while the process is alive, 503 once graceful shutdown has begun (an expected drain, not a crash). Use /readyz for traffic eligibility (readiness).

Traffic eligibility (readiness): 200 when the instance can serve, 503 while draining or before the first config apply. Stays 200 for as long as the instance keeps serving that configuration, however long ago the last config event was — see /admin/v1/health and /status/config...

Open the browser UI that loads /admin/openapi.json from the admin listener.

Get the machine-readable OpenAPI 3.1 document served by this gateway process.

List all configured model resources.

Returns runtime routing and exclusion state for every model.

Get a model resource by ID.

List caller API keys with plaintext credentials redacted.

Get a caller API key by ID with plaintext credentials redacted.

Alternate spelling of /admin/v1/api keys. Requests and responses are identical on both paths. List caller API keys with plaintext credentials redacted.

Alternate spelling of /admin/v1/api keys/{id}. Requests and responses are identical on both paths. Get a caller API key by ID with plaintext credentials redacted.

List all configured provider key resources.

Get a provider key resource by ID.

List registered upstream MCP server resources.

Get an upstream MCP server resource by ID.

List registered upstream A2A agent resources.

Get an upstream A2A agent resource by ID.

List all configured guardrail resources.

Get a guardrail resource by ID.

List all configured cache policy resources.

Get a cache policy resource by ID.

List all configured observability exporter resources.

Get an observability exporter resource by ID.

Forwards a chat completion through the proxy path for local playground testing. Use a proxy API key, not an admin key.