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

# Check readiness

> Whether the server takes new workspaces: 503 while it drains for
shutdown or holds `max_workspaces`, so a load balancer sends new
work elsewhere. `/v1/health` only says the process is up.



## OpenAPI

````yaml /openapi.yaml get /v1/ready
openapi: 3.1.0
info:
  title: Mirage API
  version: '0.1'
servers:
  - url: http://127.0.0.1:8765
    description: A local daemon on its default port
security:
  - bearerAuth: []
paths:
  /v1/ready:
    get:
      tags:
        - Server
      summary: Check readiness
      description: |-
        Whether the server takes new workspaces: 503 while it drains for
        shutdown or holds `max_workspaces`, so a load balancer sends new
        work elsewhere. `/v1/health` only says the process is up.
      operationId: ready_v1_ready_get
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema: {}
      security: []
components:
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer
      description: >-
        The server's token (MIRAGE_AUTH_TOKEN) or a JWT. A daemon in the default
        local mode with no token accepts requests without one.

````

This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.