Health checks

Unauthenticated liveness and readiness probes for monitoring the API.

Two probes live outside /v1 and need no API key. They are meant for uptime monitors, not for your application logic.

Liveness

GET https://api-next.vitruve.fit/healthz

Answers 200 while the service process is running.

Readiness

GET https://api-next.vitruve.fit/readyz

Pings the database and the rate-limit store. Answers 200 with the text ready, or 503 with unready if either is unreachable. The database ping times out after 5 seconds.

curl -i "https://api-next.vitruve.fit/readyz"

Do not poll these from every client. A failing readyz means requests will fail with 503: retry with backoff.

On this page