Health checks
The API exposes public health routes outside and inside the configured API base path. With the default configuration, the base path is /api/v1.
| Method | Path | Purpose |
|---|---|---|
GET | /healthz | Liveness probe. Returns { "status": "ok" } when the process responds. |
GET | / | Service name, version, and environment. |
GET | /api/v1/health | Dependency health, including database status and runtime information. The path uses the configured API_BASE_PATH. |
The deep health endpoint can report a degraded state when a dependency check fails. A successful liveness response only confirms that the HTTP process is responding; it does not guarantee database or integration availability.
See the API configuration guide (opens in a new tab) for the port and base-path settings.