Menu

Health

Unauthenticated liveness check.

Endpoints


GET /api/v1/health

health.check · public

Health check.

Reports the API is reachable and what version is currently served. Public; no auth required.

Use when: You want to verify connectivity, latency, or which API version is live before issuing other requests.

Don't use for: Anything that needs authenticated data. This endpoint returns no company-specific information.

Pitfalls

  • A 200 here only means the API process responds: downstream Postgres/Supabase may still be degraded.

Risk: low · Idempotent: yes · Reversible: no · Dry-run supported: no

Response fields

NameType
status"ok" | "degraded"
service"gnubok"
api_versionstring
timestampstring

Example response

{
  "data": {
    "status": "ok",
    "service": "gnubok",
    "api_version": "2026-05-12",
    "timestamp": "2026-05-12T16:25:06Z"
  },
  "meta": {
    "request_id": "req_…",
    "api_version": "2026-05-12"
  }
}