# Health

Service status.

## Endpoints

-   [GET `/v2/health`](https://public-api.dapi.digital/docs/reference/health.md#get_health)

## The health object

Service health report.

### Attributes

-   `status` (string): `ok` when every dependency is reachable, `degraded` otherwise.
-   `database` (string): Whether the database answered.
    
    Possible values: `up`, `down`.
    
-   `checked_at` (timestamp): When the check ran.

**The health object**

```json
{
  "status": "ok",
  "database": "up",
  "checked_at": "2026-10-14T09:30:00Z"
}
```

## 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.

### Returns 200 OK

Everything is reachable. Returns [the health object](https://public-api.dapi.digital/docs/reference/health.md#health_object).

### Responses

-   `200`: Everything is reachable.
-   `503`: A dependency is down; `status` is `degraded`.

Errors use [the error object](https://public-api.dapi.digital/docs/guides/errors.md#error-object).

**Request**

```bash
curl "https://public-api.dapi.digital/v2/health"
```

---

3DAPI API Docs. This page on the web: https://public-api.dapi.digital/docs/reference/health. Index of every page: https://public-api.dapi.digital/docs/llms.txt.