API7 Docs
AISIX AI GatewayOpen-Source AISIX Gateway Admin APIGet Readiness Status

Get Readiness Status

GET /readyz

GET /readyz

Interactive request editor loads with JavaScript.

Query Parameters

verbose?string

When present, returns a detailed multi-line text report instead of the short ok response.

Response Body

text/plain

text/plain

curl -X GET "http://127.0.0.1:3001/readyz?verbose=1"

Ready to receive traffic

"string"
Complete operation details and schema variants

GET /readyz

Get Readiness Status

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 for configuration freshness. Distinct from /livez (process liveness).

Parameters

  • verbose (query, string, optional): When present, returns a detailed multi-line text report instead of the short ok response.

Responses

  • 200: Ready to receive traffic
  • 503: Not ready: shutting down (drain), or no configuration applied yet

cURL

curl -X GET 'http://127.0.0.1:3001/readyz'