Health · MachineMail Docs

Liveness

Health checks need no authentication.

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)

Errors

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 (checks.storage: true) when it answers, 503 with status: unavailable when it does not. No authentication.

Authentication: None.

Response

200 Ready (application/json)

Errors

Example

Request

curl "https://api.machinemail.dev/health/ready"

Response 200

{
  "status": "ready",
  "checks": {
    "storage": true
  }
}