Readiness check

Performs readiness checks for downstream dependencies.

GET/health/ready

Public: this route takes no API key.

Responses

  • 200 Service is ready

    • status · string · required · one of ready, not_ready · example ready

      Readiness status.

    • timestamp · string · required · format date-time · example 2025-01-01T00:00:00.000Z

      Readiness check timestamp.

    • revision · string · required · example sdp-prod-api-public-00042-abc

      Cloud Run revision serving the request, or local outside Cloud Run.

    • commit · string · required · example 0123456789abcdef0123456789abcdef01234567

      Git commit the serving image was built from, or local when the image carries none.

    • checks · object · required

      Dependency health checks.

      • database · string · required · one of ok, error · example ok

        Database connectivity status.

      • redis · string · required · one of ok, error · example ok

        Redis connectivity status.

      • egress · string · one of pending, ok, unverified · example ok

        Outbound internet connectivity of this instance. pending (not ready) while a fresh instance waits for working egress, ok once an outbound call succeeded, unverified when it stopped waiting and serves anyway. Absent where the deployment does not wait for egress.

  • 503 Service is not ready

    Same fields as 200.

Example request

curl 'https://api.solana.com/health/ready'

Example responses

{
  "status": "ready",
  "timestamp": "2025-01-01T00:00:00.000Z",
  "revision": "sdp-prod-api-public-00042-abc",
  "commit": "0123456789abcdef0123456789abcdef01234567",
  "checks": {
    "database": "ok",
    "redis": "ok",
    "egress": "ok"
  }
}
Is this page helpful?