Sign in
health

Health Readiness

Changed on

Readiness probe endpoint.

Checks if the gateway is ready to serve requests by validating:

  • Database connectivity
  • Service availability

Used by Kubernetes/container orchestrators for readiness probes. Returns HTTP 503 if any dependency is unavailable.

Returns: dict: Status object with health details

Raises: HTTPException: 503 if service is not ready

get/api/v1/health/readiness

Request

  • The document declares no server URL.
  • Auth: none declared

Response

Successful Response

object required

Changes