Health

Readiness Check

Readiness probe — checks that database and Redis are reachable.

Returns 200 with status “ok” if all dependencies are healthy.

When HEALTH_READY_TOLERANCE_ENABLED is set (opt-in; default OFF), a single transient failure (e.g. a slow DB-ping during the bulk-poller burst) returns 200 with status “tolerating” — the endpoint only flips to 503 with status “degraded” after HEALTH_READY_FAIL_THRESHOLD consecutive failed probes (see the tolerance block above for the WHY). With the flag OFF (the default) the endpoint is strict fail-fast: any failed probe returns 503 immediately, exactly as it did pre-#1850.

Use this for docker HEALTHCHECK, monitoring (Prometheus blackbox), and alerting. Do NOT use this as the Traefik routing probe — when the DB is sustained-unhealthy this endpoint returns 503, which would cause Traefik to de-register the backend and 404 every request at the edge (incident 2026-05-17). For routing, use /v1/health/live, which proves the process is alive without touching DB/Redis.

GET

health

ready

Readiness Check

curl --request GET \
  --url https://api.polysimulator.com/v1/health/ready

{
  "status": "<string>",
  "timestamp": "<string>",
  "checks": {}
}

Response

Successful Response

status

string

required

timestamp

string

required

checks

Checks · object

required

Show child attributes

System StatusDetailed system status for monitoring dashboards. Includes database latency, Redis stats, WebSocket connections, and market cache information.

Readiness Check

curl --request GET \
  --url https://api.polysimulator.com/v1/health/ready

{
  "status": "<string>",
  "timestamp": "<string>",
  "checks": {}
}