GET /readyz

Whether this instance may be sent traffic.

GET /readyz

200 once a verified release is loaded and 503 until then, which is the question an orchestrator asks before it routes traffic. It is also 503 again from the moment a shutdown begins draining, so a rolling deploy stops receiving new work before the listener closes. Answered without a token.

Authentication

Answered without credentials.

Parameters

Parameter
X-Request-Id	A correlation id to answer under. A value the server cannot log safely — too long, or carrying anything outside its id alphabet — is discarded and a fresh id minted, because a log line is read by a human and must not be forgeable by a header. (in header)

Responses

200

A verified release is loaded, and which one.

application/json — Readiness

Response header
X-Request-Id	The correlation id this request was answered under. It is on every response, in the server’s log record for the request, and inside the error object of every refusal.

503

not_ready — no verified release is loaded yet, or the process has begun draining. The socket binds before the release is verified, so a listener that is not ready answers the probes and serves no regulation at all

application/json — Error

Response header
X-Request-Id	The correlation id this request was answered under. It is on every response, in the server’s log record for the request, and inside the error object of every refusal.