health
Liveness and readiness. The `machinemail health` commands: arguments, flags, examples and the API routes they call.
Liveness and readiness.
| Command | Summary |
|---|---|
health check | Check that the API is up (liveness) |
health ready | Check that the API can serve requests (readiness) |
Every command also takes the global flags.
health check
Check that the API is up (liveness).
Always 200 {“status”: “ok”} while the process serves requests. No authentication.
Examples
API
health ready
Check that the API can serve requests (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.