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

# Get ready



## OpenAPI

````yaml /api-reference/openapi.json get /ready
openapi: 3.1.0
info:
  title: sndbox Control Plane API
  version: 0.5.0
  description: >-
    Versioned v1 route and transport contract. Resource schemas remain additive
    during the v0.5 GA candidate.
servers:
  - url: https://api.sndbox.app
security: []
paths:
  /ready:
    get:
      tags:
        - service
      operationId: get_ready
      parameters:
        - $ref: '#/components/parameters/CorrelationId'
      responses:
        '200':
          description: All required dependencies are ready.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ReadinessResponse'
        '429':
          $ref: '#/components/responses/RateLimited'
        '503':
          description: At least one required dependency is not ready.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ReadinessResponse'
      security: []
components:
  parameters:
    CorrelationId:
      name: x-correlation-id
      in: header
      required: false
      schema:
        type: string
        minLength: 8
        maxLength: 128
        pattern: ^[A-Za-z0-9][A-Za-z0-9._:-]+$
      description: Caller-supplied correlation ID; the server generates one when omitted.
  schemas:
    ReadinessResponse:
      type: object
      required:
        - status
        - checkedAt
        - checks
      properties:
        status:
          type: string
          enum:
            - ready
            - not_ready
        checkedAt:
          type: string
          format: date-time
        checks:
          type: array
          items:
            type: object
            required:
              - name
              - status
              - durationMs
            properties:
              name:
                type: string
              status:
                type: string
                enum:
                  - ready
                  - not_ready
              durationMs:
                type: integer
                minimum: 0
            additionalProperties: false
      additionalProperties: false
    ApiError:
      type: object
      required:
        - error
        - correlationId
      properties:
        error:
          type: object
          required:
            - code
            - message
          properties:
            code:
              type: string
            message:
              type: string
            details: {}
        correlationId:
          type: string
  responses:
    RateLimited:
      description: Rate limit exceeded.
      headers:
        retry-after:
          schema:
            type: integer
        x-ratelimit-limit:
          schema:
            type: integer
        x-ratelimit-remaining:
          schema:
            type: integer
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ApiError'

````