Health

Performs readiness checks for downstream dependencies.

get/health/ready

Request

  • Base URL
    http://localhost:8787
  • URL
    http://localhost:8787/health/ready
  • Auth
    none declared

Response

Service is ready

status'ready' | 'not_ready' required

Readiness status.

timestampstring date-time required

Readiness check timestamp.

revisionstring required

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

commitstring required

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

Example response

{
  "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"
  }
}

Changes

    • info

      added the required property to the response with the status

    • info

      added the required property to the response with the status

    • info

      added the optional property / to the response with the status

    • info

      added the optional property / to the response with the status