Skip to content

GET /api/v1/health/db

Status: GA Access: open, no token API contract: 0.3.0 · capability 2026-09-03.1 View as Markdown Open in Claude Open in ChatGPT

Db Health

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

Auth: no token required

Terminal window
curl -sS -X GET "https://entherium.duckdns.org:8443/api/v1/health/db"

The contract carries no example for this response; schema: DbHealth. Field-level shape: interactive explorer.

DbHealth — Successful Response

FieldTypeDescription
detailstring
status"ok" | "fail"

None.

CodeMeaningBody
503Service UnavailableDbHealth

Every error body is {detail, code?, request_id, doc_url} — request_id is the value to quote, doc_url points at the Errors reference.