health · MachineMail Docs
health check
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.
machinemail health check [flags]
Examples
machinemail health check
API
health ready
Check that the API can serve requests (readiness).
Pings the storage backend: 200 with status: ready (checks.storage: true) when it answers, 503 with status: unavailable when it does not. No authentication.
machinemail health ready [flags]
Examples
machinemail health ready