Skip to content
machinemail

Health

Liveness and readiness.

Note

Health checks need no authentication.
MethodPathSummary
GET/healthLiveness
GET/health/readyReadiness

Liveness

http
GET /health

Always 200 {"status": "ok"} while the process serves requests. No authentication.

Authentication: None.

Response

200 The process is up (application/json)

status"ok"Required

Errors

StatusMeaning
500Unexpected server error.

Example

Request
curl "https://api.machinemail.dev/health"
Response 200
{
  "status": "ok"
}

Readiness

http
GET /health/ready

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"Required
ready when storage answers; the HTTP status is then 200, otherwise 503.
checksobjectRequired

Errors

StatusMeaning
500Unexpected server error.
503Not ready: storage did not answer

Example

Request
curl "https://api.machinemail.dev/health/ready"
Response 200
{
  "status": "ready",
  "checks": {
    "storage": false,
    "transport": "string",
    "notify": "listening"
  }
}

On this page

0% read