Skip to Content
ReferenceAPI referenceHealth

Check that the app is ready for traffic

GET
/health/ready

Answers 200 with ready true when SELECT 1 against the database returns within two seconds, and 503 with ready false otherwise. The head runs the query on every request, so a ready app goes back to 503 when the database drops. An agent answers 503 without querying until its startup schema check passes. After that it queries like the head, and an agent whose check timed out stays at 503 until it restarts. No credentials needed.

Response Body

Request fulfilled, document follows

application/json
  1. response

Whether the app is ready for traffic.

ready*boolean
Example Request
curl -X GET 'https://geometrikks.example.com/health/ready'
Example Response
{  "ready": true}