> ## Documentation Index
> Fetch the complete documentation index at: https://docs.qumo-deploy.com/llms.txt
> Use this file to discover all available pages before exploring further.

# Readiness probe

> Checks database and storage dependency connectivity.



## OpenAPI

````yaml /api-reference/openapi.yaml get /readyz
openapi: 3.1.0
info:
  title: Qumo Deploy REST API
  description: >
    The Qumo Deploy REST API provides programmatic control over edge relay
    clusters,

    ephemeral token issuance, tenant lifecycle, bot machine identities, and
    billing.
  version: 1.0.0
servers:
  - url: https://api.qumo-deploy.com
    description: Production Control Plane
  - url: http://localhost:8080
    description: Local Development / Sandbox
security:
  - BearerAuth: []
  - ApiKeyAuth: []
paths:
  /readyz:
    get:
      summary: Readiness probe
      description: Checks database and storage dependency connectivity.
      responses:
        '200':
          description: Ready to serve traffic
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HealthStatus'
        '503':
          description: Service Unavailable (database disconnect)
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
      security: []
components:
  schemas:
    HealthStatus:
      type: object
      required:
        - status
      properties:
        status:
          type: string
          example: ok
    ErrorResponse:
      type: object
      required:
        - error
      properties:
        error:
          type: string
          example: invalid or expired token
  securitySchemes:
    BearerAuth:
      type: http
      scheme: bearer
      bearerFormat: JWT
      description: |
        Bearer token (User session or Bot machine token).
    ApiKeyAuth:
      type: apiKey
      in: header
      name: X-API-Key
      description: |
        Project-scoped API key (`qumo_live_...` or `qumo_test_...`).

````