Skip to content

Health

Use this endpoint to verify that the public API is reachable and to read its current region and build identifier. It also reports database connectivity.

Endpoint

GET /health

Response

json
{
  "status": "ok",
  "region": "eu",
  "build": "2026.01.09-abcdef123456",
  "uptimeSeconds": 86400,
  "db": {
    "status": "ok",
    "ok": true,
    "latencyMs": 12
  }
}

region is taken from PUBLIC_API_REGION and is null if the API is running without a region configuration. build comes from PUBLIC_API_BUILD and defaults to unknown. uptimeSeconds is the elapsed time since process start. db reports a MongoDB ping with the measured latency in milliseconds. If the database is unreachable, db.status becomes error and an error string is returned.