Dashboard

Health

View as Markdown

Service status.

Endpoints

The health object

Service health report.

Attributes

  • statusstring

    ok when every dependency is reachable, degraded otherwise.

    Possible valuesokdegraded
  • databasestring

    Whether the database answered.

    Possible valuesupdown
  • checked_attimestamp

    When the check ran.

The health object
{
  ,
  ,
  
}

Check service health

GET/v2/health

Public: no API key needed.

Credentials
None: the endpoint is public.
For
Designers and Integrators
Operation id
get_health

Reports whether the API and its database are up. Needs no credentials. Use it for uptime monitoring, not for business logic.

Returns200 OK

Everything is reachable. Returns the health object.

Responses

  • 200

    Everything is reachable.

  • 503

    A dependency is down; status is degraded.

Errors use the error object.

GET/v2/health
curl "https://public-api.dapi.digital/v2/health"
Response
{
  "status": "ok",
  "database": "up",
  "checked_at": "2026-10-14T09:30:00Z"
}