Aurelia

Health API

GET/health

Whether the API can reach each of its three stores. Use it for uptime checks.

Parameters

None.

Response

FieldTypeMeaning
healthybooleantrue when all three services answer.
services.postgresstring"ok", or the error message.
services.clickhousestring"ok", or the error message.
services.dragonflystring"ok", or the error message.

Example

Captured 2026-09-28 18:03 UTC on a test instance.

curl -s -H 'Authorization: Bearer <key>' 'https://app.aurelia.build/api/health'
{
  "healthy": true,
  "services": {
    "postgres": "ok",
    "clickhouse": "ok",
    "dragonfly": "ok"
  }
}

Notes

  • 200 when healthy, 503 with the same body when any service is down.
  • Never cached: every call checks all three.
  • For a liveness probe that touches nothing, GET / answers {"name":"aurelia","status":"ok"}.
  • Open and not metered, like /, /plans and /auth/*: it needs no key and costs no credits.

Try it in the interactive docsCreate a free account