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

# Readiness

> Probes the database, the event bus, object storage, and the report encryption keyring individually, each with a 4 second timeout. Any failure makes the whole response 503. This is what a deployment platform should gate traffic on. Answers on any hostname.



## OpenAPI

````yaml /api-reference/openapi.json get /api/v1/ready
openapi: 3.1.0
info:
  title: Myrqen API
  version: 1.0.0
  description: >-
    The JSON API served by `apps/web` under `/api/v1`. Derived from the route
    handlers in `apps/web/app/api/v1` and the shared types in
    `packages/contracts`.


    This reference documents the surface a developer and the Myrqen CLI actually
    use. Platform-administration and billing endpoints exist in the application
    but are operator-only and are deliberately not published here.


    The hosted service at `https://api.myrqen.cc` is not deployed yet. Run your
    own deployment and use its origin.
  license:
    name: Myrqen Source-Available Licence 1.0
    url: https://github.com/stijnswapped/Myrqen/blob/main/LICENSE
servers:
  - url: http://localhost:3000
    description: >-
      A deployment you run yourself. Use this while the hosted service is
      unavailable.
  - url: https://api.myrqen.cc
    description: >-
      The hosted API. This is the CLI's shipped default, but the hosted service
      is NOT deployed yet, so requests to it do not resolve today.
security: []
tags:
  - name: Health
    description: >-
      Liveness and readiness probes. Unauthenticated, and answered on any
      hostname.
  - name: Authentication
    description: Browser sessions. Password plus recovery codes; no email is ever sent.
  - name: Device linking
    description: Binding a machine's CLI to an account, via browser approval.
  - name: Workspaces and projects
    description: Where a scanned repository belongs.
  - name: Sync and quota
    description: Creating, feeding, and finalizing a cloud report.
  - name: Reports
    description: Reading and exporting a synced report.
  - name: Sharing
    description: Share links and the server-side projections they resolve to.
  - name: Analytics
    description: Allowlisted product-event ingest.
  - name: Updates
    description: The signed release manifest.
paths:
  /api/v1/ready:
    get:
      tags:
        - Health
      summary: Readiness
      description: >-
        Probes the database, the event bus, object storage, and the report
        encryption keyring individually, each with a 4 second timeout. Any
        failure makes the whole response 503. This is what a deployment platform
        should gate traffic on. Answers on any hostname.
      operationId: getReady
      responses:
        '200':
          description: Every dependency answered.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ReadyResponse'
              example:
                status: ready
                dependencies:
                  database:
                    status: ok
                    durationMs: 3
                  eventBus:
                    status: ok
                    durationMs: 1
                  objectStorage:
                    status: ok
                    durationMs: 12
                  encryptionKeys:
                    status: ok
                    durationMs: 0
        '503':
          description: At least one dependency is unavailable. The failing one is named.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ReadyResponse'
              example:
                status: not_ready
                dependencies:
                  database:
                    status: unavailable
                    detail: The database did not answer within 4000ms.
                    durationMs: 4001
                  eventBus:
                    status: ok
                    durationMs: 1
                  objectStorage:
                    status: ok
                    durationMs: 9
                  encryptionKeys:
                    status: ok
                    durationMs: 0
      security: []
components:
  schemas:
    ReadyResponse:
      type: object
      required:
        - status
        - dependencies
      properties:
        status:
          type: string
          enum:
            - ready
            - not_ready
        dependencies:
          type: object
          required:
            - database
            - eventBus
            - objectStorage
            - encryptionKeys
          properties:
            database:
              $ref: '#/components/schemas/DependencyReport'
            eventBus:
              $ref: '#/components/schemas/DependencyReport'
            objectStorage:
              $ref: '#/components/schemas/DependencyReport'
            encryptionKeys:
              $ref: '#/components/schemas/DependencyReport'
    DependencyReport:
      type: object
      required:
        - status
        - durationMs
      properties:
        status:
          type: string
          enum:
            - ok
            - unavailable
        detail:
          type: string
        durationMs:
          type: integer

````