Reports whether the service is ready to take traffic.

GET

/health

Both a liveness and a readiness probe. The process only reaches [ServiceStatus::Ready] once migrations have run, and it flips to [ServiceStatus::Draining] the moment a shutdown signal arrives, so an orchestrator can stop routing before the listener actually closes.

Errors

Returns [Error::Unavailable] (503) while starting up or draining, and when the database round-trip fails.

Response Body

The service is ready

application/json

response

Body of a successful GET /health.

build_rev*string

Commit the running binary was built from, or unknown outside a git checkout. Between releases this is what identifies a build.

database*string

Relational backend currently in use.

status*ServiceStatus

Where the process is in its lifecycle.

Value in"starting""ready""draining"

uptime_seconds*integer

Whole seconds since the process started.

Formatint64

Range0 <= value

version*string

Version of the running binary.

curl -X GET 'https://example.com/health'

{  "build_rev": "string",  "database": "string",  "status": "starting",  "uptime_seconds": 0,  "version": "string"}