Service liveness probe

Search Documentation

Search across all developer documentation

meta

Service liveness probe

GET /v1/_health
Public

Unauthenticated liveness probe for uptime monitors and status pages. Returns a static {status: "ok", commit, built_at, time} payload — a 200 means the API is serving requests, not that every dependency is healthy. For dependency-aware health, watch the platform status page instead. The commit and built_at fields identify the deployed build, useful for confirming which version of the API is responding.

Responses

Errors follow the RFC 7807 problem format — see the error reference.

200 Service is up application/json
status string required
commit string required

Build SHA (or unknown outside CI builds).

built_at string required

RFC 3339 UTC timestamp of when the running build was compiled (or unknown outside CI builds). Together with commit, identifies exactly what is deployed.

time string<date-time> required
404 Resource not found application/problem+json