DocsAPI ReferenceHealth probe
GET/health

Health probe

Returns 200 with `{status: "ok", version: "…"}` whenever the API process is running. Suitable for Docker healthchecks, Vercel cron probes, or load-balancer liveness checks. Does NOT verify DB / Redis connectivity — it's a process-up signal, not a full readiness probe.

Example

bash
curl http://localhost:3000/health

Response

bash
{
  "status": "ok",
  "version": "0.1.0"
}

Try it

Live preview only works when the API is running on your machine.

Run docker compose up and the Try-It panel will become interactive. Until then, copy the curl example below.