---
title: API: health
description: REST endpoints tagged health — generated from the platform's OpenAPI contract (3 operations).
locale: en
version: 0.2.0
canonical: https://enterium-developer-docs.pages.dev/developers/api/health/
---

> Documentation index: https://enterium-developer-docs.pages.dev/developers/llms.txt — every page of this portal has a Markdown twin at <route>.md; the frozen API contract is at https://enterium-developer-docs.pages.dev/developers/api/openapi.json.

:::note
Generated from the OpenAPI contract — do not edit by hand. Interactive explorer with full schemas: [https://entherium.duckdns.org:8443/reference](https://entherium.duckdns.org:8443/reference); frozen spec for this build: [openapi.json](/developers/api/openapi.json).
:::

## `GET /api/v1/health`

Liveness

[Open as a page →](./get-health/)

Always returns 200 if the process is up. No external dependencies.

**Auth:** no token required

**Responses:**

| Code | Meaning | Body |
| --- | --- | --- |
| `200` | Successful Response | `HealthStatus` |

## `GET /api/v1/health/db`

Db Health

[Open as a page →](./get-health-db/)

Verifies that the DB connection is alive (`SELECT 1`).

**Auth:** no token required

**Responses:**

| Code | Meaning | Body |
| --- | --- | --- |
| `200` | Successful Response | `DbHealth` |
| `503` | Service Unavailable | `DbHealth` |

## `GET /api/v1/health/ready`

Readiness

[Open as a page →](./get-health-ready/)

K8s-style /readyz — green only if both DB and Redis respond.

**Auth:** no token required

**Responses:**

| Code | Meaning | Body |
| --- | --- | --- |
| `200` | Successful Response | `ReadinessReport` |
| `503` | Service Unavailable | `ReadinessReport` |
