GET /healthz
Whether this process is alive.
GET /healthz200 from the moment the socket is bound, whether or not a release has been loaded — a container runtime’s health check must not be answered ‘no’ during a boot that has not finished. The body says separately whether the process is ready and whether it is draining. Answered without a token.
Authentication
Section titled “Authentication”Answered without credentials.
Parameters
Section titled “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
Section titled “Responses”The process is alive; whether it is ready is a separate field.
application/json — Liveness
| 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. |
Rendered from openregs/openregs@f3a2d10:docs/reference/openapi.json