Readiness probe — checks the database is reachable

GET/ready

Authorization

Optional — this operation also accepts unauthenticated requests.

x-api-keyAPI key · header

API key issued from the dashboard. Optional: anonymous callers are served at a lower rate limit.

AuthorizationBearer token · header

The same API key, sent as a bearer token.

Responses

200Default Response

statusstringrequired

Allowed:ready

503Default Response

statusstringrequired

Allowed:degraded

detailstringrequired

Request

curl -X GET "http://localhost:8080/ready" \
  -H "x-api-key: YOUR_API_KEY"

const response = await fetch("http://localhost:8080/ready", {
  method: "GET",
  headers: {
    "x-api-key": "YOUR_API_KEY"
  }
});

import requests

response = requests.get(
    "http://localhost:8080/ready",
    headers={
        "x-api-key": "YOUR_API_KEY"
    },
)

Response

{
  "status": "ready"
}

{
  "status": "degraded",
  "detail": "string"
}