Docs

Health and readiness

Health, readiness, and liveness endpoints for Apache APISIX and how to use them in load balancers and Kubernetes probes.

APISIX exposes a small set of health, readiness, and liveness endpoints. This page documents each endpoint, its expected response, and how to wire it into load balancers and Kubernetes probes.

Endpoints overview

[TODO] Complete the endpoint table with paths, methods, ports, expected HTTP codes, and response bodies. The engineering/QA owner must confirm for APISIX 3.18.0.

EndpointPurposeDefault portExpected response
/apisix/statusHealth check9080[TODO]
/healthzLiveness9080[TODO]
/readyReadiness9080[TODO]

Health check

[TODO] Document the /apisix/status endpoint, including what it verifies and what it does not verify.

Liveness check

[TODO] Document the liveness endpoint and Kubernetes livenessProbe configuration.

Readiness check

[TODO] Document the readiness endpoint and Kubernetes readinessProbe configuration.

Kubernetes probes

[TODO] Provide example livenessProbe and readinessProbe snippets for the APISIX Helm chart.