API reference
Operations
One tag: method, path, summary, auth, and scopes. Request and response fields ship in this page — expand a row to read the contract.
Endpoints
3
GET
/health
Application liveness
/health
Application liveness
Description
Returns no-cache JSON when the Phoenix application is running. This is a liveness probe; use /ready for dependency checks.
Auth
NoneResponses
200
Application process is alive
Application process is alive
Response Body
| Field | Type | Required | Description |
|---|---|---|---|
| status | string | Yes | ok |
| timestamp | string | Yes | ISO 8601 probe time |
GET
/ready
Application readiness
/ready
Application readiness
Description
Checks PostgreSQL connectivity, pending Ecto migrations, and the required Oban queues. Returns 503 when any required check is unhealthy.
Auth
NoneResponses
200
Dependencies are ready
Dependencies are ready
Response Body
| Field | Type | Required | Description |
|---|---|---|---|
| status | string | Yes | ok or degraded |
| timestamp | string | Yes | ISO 8601 probe time |
| checks | object | Yes | repo, migrations, and oban results |
503
At least one required dependency is unhealthy
At least one required dependency is unhealthy
GET
/metrics
Metrics Token
Prometheus metrics
/metrics
Metrics Token
Prometheus metrics
Description
Returns a no-cache Prometheus text export. Metrics bearer authentication is mandatory in production and requires Authorization: Bearer {METRICS_BEARER_TOKEN}.
Auth
Metrics TokenResponses
200
Prometheus text exposition
Prometheus text exposition
401
Missing or invalid metrics token
Missing or invalid metrics token