AISIX OSS Admin API
Optional operational API for inspecting a directly operated open-source AISIX gateway. Its read-only resource operations list loaded models, caller API keys, provider credentials, guardrails, MCP...
Health
GETGet Gateway Health/admin/v1/healthGet model health levels and configuration-watch freshness for this gateway.
GETGet Liveness Status/livezProcess liveness: should this instance be restarted? Answers 200 whenever it answers at all, including throughout a graceful drain — draining is deliberate work, and restarting an instance that is finishing the requests it accepted would kill exactly those. Use /readyz for...
GETGet Readiness Status/readyzTraffic 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...
OpenAPI
GETOpen Scalar UI/admin/openapi-scalarOpen the browser UI that loads /admin/openapi.json from the admin listener.
GETGet OpenAPI Document/admin/openapi.jsonGet the machine-readable OpenAPI 3.1 document served by this gateway process.
Models
GETList Models/admin/v1/modelsList all configured model resources.
GETList Model Runtime Status/admin/v1/models/statusReturns runtime routing and exclusion state for every model.
GETGet Model by ID/admin/v1/models/{id}Get a model resource by ID.
Caller API Keys
GETList Caller API Keys/admin/v1/api_keysList caller API keys with plaintext credentials redacted.
GETGet Caller API Key by ID/admin/v1/api_keys/{id}Get a caller API key by ID with plaintext credentials redacted.
GETList Caller API Keys (alternate path)/admin/v1/apikeysAlternate spelling of /admin/v1/api keys. Requests and responses are identical on both paths. List caller API keys with plaintext credentials redacted.
GETGet Caller API Key by ID (alternate path)/admin/v1/apikeys/{id}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.
Provider Keys
GETList Provider Keys/admin/v1/provider_keysList all configured provider key resources.
GETGet Provider Key by ID/admin/v1/provider_keys/{id}Get a provider key resource by ID.
MCP Servers
GETList MCP Servers/admin/v1/mcp_serversList registered upstream MCP server resources.
GETGet MCP Server by ID/admin/v1/mcp_servers/{id}Get an upstream MCP server resource by ID.
A2A Agents
GETList A2A Agents/admin/v1/a2a_agentsList registered upstream A2A agent resources.
GETGet A2A Agent by ID/admin/v1/a2a_agents/{id}Get an upstream A2A agent resource by ID.
Passthrough Routes
GETList Passthrough Routes/admin/v1/passthrough_routesList explicit passthrough route resources.
GETGet Passthrough Route by ID/admin/v1/passthrough_routes/{id}Get an explicit passthrough route resource by ID.
Guardrails
GETList Guardrails/admin/v1/guardrailsList all configured guardrail resources.
GETGet Guardrail by ID/admin/v1/guardrails/{id}Get a guardrail resource by ID.
Cache Policies
GETList Cache Policies/admin/v1/cache_policiesList all configured cache policy resources.
GETGet Cache Policy by ID/admin/v1/cache_policies/{id}Get a cache policy resource by ID.
Observability Exporters
GETList Observability Exporters/admin/v1/observability_exportersList all configured observability exporter resources.
GETGet Observability Exporter by ID/admin/v1/observability_exporters/{id}Get an observability exporter resource by ID.
Playground
POSTCreate Playground Chat Completion/playground/chat/completionsForwards a chat completion through the proxy path for local playground testing. Use a proxy API key, not an admin key.