AISIX AI 网关 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, before the first config apply, or when the etcd config watch is stale. Distinct from /livez (process liveness).

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.

Create a model resource. The gateway validates the payload against the Model schema, rejects duplicate display name values, and returns the stored resource entry.

Returns runtime routing and exclusion state for every model.

Get a model resource by ID.

Update a model resource by ID. The gateway validates the payload, rejects duplicate display name values, preserves the resource ID, and increments the revision.

Delete a model resource by ID.

List caller API keys with plaintext credentials redacted.

Create a caller API key. The gateway validates the payload, rejects duplicate key hash values, and returns the stored resource entry with plaintext credentials redacted.

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

Update a caller API key by ID. The gateway validates the payload, rejects duplicate key hash values, preserves the resource ID, and increments the revision.

Delete a caller API key by ID.

Rotate a caller API key by ID. The gateway generates a new plaintext key, stores only its SHA-256 hash, and returns the plaintext once.

List all configured provider key resources.

Create a provider key resource. The gateway validates the payload, rejects duplicate display name values, and returns the stored resource entry.

Get a provider key resource by ID.

Update a provider key resource by ID. The gateway validates the payload, rejects duplicate display name values, preserves the resource ID, and increments the revision.

Delete a provider key resource by ID.

List registered upstream MCP server resources.

Create an upstream MCP server resource. The gateway validates the payload, rejects duplicate display name values, and returns the stored resource entry.

Get an upstream MCP server resource by ID.

Update an upstream MCP server resource by ID. The gateway validates the payload, rejects duplicate display name values, preserves the resource ID, and increments the revision.

Delete an upstream MCP server resource by ID.

List registered upstream A2A agent resources.

Create an upstream A2A agent resource. The gateway validates the payload, rejects duplicate display name values, and returns the stored resource entry.

Get an upstream A2A agent resource by ID.

Update an upstream A2A agent resource by ID. The gateway validates the payload, rejects duplicate display name values, preserves the resource ID, and increments the revision.

Delete an upstream A2A agent resource by ID.

List all configured guardrail resources.

Create a guardrail resource. The gateway validates the payload, rejects duplicate name values, and returns the stored resource entry.

Get a guardrail resource by ID.

Update a guardrail resource by ID. The gateway validates the payload, rejects duplicate name values, preserves the resource ID, and increments the revision.

Delete a guardrail resource by ID.

List all configured cache policy resources.

Create a cache policy resource. The gateway validates the payload, rejects duplicate name values, and returns the stored resource entry.

Get a cache policy resource by ID.

Update a cache policy resource by ID. The gateway validates the payload, rejects duplicate name values, preserves the resource ID, and increments the revision.

Delete a cache policy resource by ID.

List all configured observability exporter resources.

Create an observability exporter resource. The gateway validates the payload, rejects duplicate name values, and returns the stored resource entry.

Get an observability exporter resource by ID.

Update an observability exporter resource by ID. The gateway validates the payload, rejects duplicate name values, preserves the resource ID, and increments the revision.

Delete 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.