Health
Liveness and readiness.
Note
Health checks need no authentication.
Liveness
Always 200 {"status": "ok"} while the process serves requests. No authentication.
Authentication: None.
Response
200 The process is up (application/json)
status"ok"RequiredErrors
| Status | Meaning |
|---|---|
500 | Unexpected server error. |
Example
Readiness
Pings the storage backend: 200 with status: ready when it answers, 503 with status: unavailable when it does not. checks.transport names the mail transport and checks.notify reports cross-machine notifications (informational, never part of readiness). No authentication.
Authentication: None.
Response
200 Ready (application/json)
status"ready" | "unavailable"Requiredready when storage answers; the HTTP status is then 200, otherwise 503.
checksobjectRequiredErrors
| Status | Meaning |
|---|---|
500 | Unexpected server error. |
503 | Not ready: storage did not answer |