Skip to content

GET /api/v1/health/ready

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

Readiness

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

Auth: no token required

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

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

ReadinessReport — Successful Response

FieldTypeDescription
dbstring
redisstring
status"ok" | "degraded" | "fail"

None.

CodeMeaningBody
503Service UnavailableReadinessReport

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