AISIX OSS Admin API 是直接运维开源网关时可选的运维接口。资源管理操作为只读;同一监听器上的 Playground 会转发测试推理请求。连接 AISIX Enterprise 或 AISIX Cloud 的网关不公开此监听器,请通过对应控制面配置。
GET Get Gateway Health /admin/v1/healthGet model health levels and configuration-watch freshness for this gateway.
GET Get 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 traffic eligibility (readiness), which is what reports the drain.
GET Get 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 for configuration freshness. Distinct from /livez (process liveness).
GET Open Scalar UI /admin/openapi-scalarOpen the browser UI that loads `/admin/openapi.json` from the admin listener.
GET Get OpenAPI Document /admin/openapi.jsonGet the machine-readable OpenAPI 3.1 document served by this gateway process.
GET List Models /admin/v1/modelsList all configured model resources.
GET List Model Runtime Status /admin/v1/models/statusReturns runtime routing and exclusion state for every model.
GET Get Model by ID /admin/v1/models/{id}Get a model resource by ID.
GET List Caller API Keys /admin/v1/api_keysList caller API keys with plaintext credentials redacted.
GET Get Caller API Key by ID /admin/v1/api_keys/{id}Get a caller API key by ID with plaintext credentials redacted.
GET List 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.
GET Get 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.
GET List Provider Keys /admin/v1/provider_keysList all configured provider key resources.
GET Get Provider Key by ID /admin/v1/provider_keys/{id}Get a provider key resource by ID.
GET List MCP Servers /admin/v1/mcp_serversList registered upstream MCP server resources.
GET Get MCP Server by ID /admin/v1/mcp_servers/{id}Get an upstream MCP server resource by ID.
GET List A2A Agents /admin/v1/a2a_agentsList registered upstream A2A agent resources.
GET Get A2A Agent by ID /admin/v1/a2a_agents/{id}Get an upstream A2A agent resource by ID.
GET List Passthrough Routes /admin/v1/passthrough_routesList explicit passthrough route resources.
GET Get Passthrough Route by ID /admin/v1/passthrough_routes/{id}Get an explicit passthrough route resource by ID.
GET List Guardrails /admin/v1/guardrailsList all configured guardrail resources.
GET Get Guardrail by ID /admin/v1/guardrails/{id}Get a guardrail resource by ID.
GET List Cache Policies /admin/v1/cache_policiesList all configured cache policy resources.
GET Get Cache Policy by ID /admin/v1/cache_policies/{id}Get a cache policy resource by ID.
GET List Observability Exporters /admin/v1/observability_exportersList all configured observability exporter resources.
GET Get Observability Exporter by ID /admin/v1/observability_exporters/{id}Get an observability exporter resource by ID.
POST Create 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.