Skip to main content

Health Check

A simple endpoint to confirm the API server is running and reachable. Use it with uptime monitors, load balancers, or Kubernetes liveness probes.

Endpoint​

MethodEndpointResponse
GET/health200 OK with { status: "ok" }

Usage examples​

curl:

curl https://api.yourdomain.com/health
# {"status":"ok"}

Kubernetes liveness probe:

livenessProbe:
  httpGet:
    path: /health
    port: 6600
  initialDelaySeconds: 10
  periodSeconds: 30

Uptime monitoring:
Point any uptime monitor (UptimeRobot, BetterUptime, etc.) at GET /health and alert on anything other than 200.