> ## Documentation Index
> Fetch the complete documentation index at: https://omniflow-vpn.mintlify.site/llms.txt
> Use this file to discover all available pages before exploring further.

# Get readyz

> Reports every registered dependency. Failures carry a stable classification, never an underlying driver message, so the response cannot leak a connection string or a credential.



## OpenAPI

````yaml https://raw.githubusercontent.com/kewldan/omniflow/main/api/openapi.yaml get /readyz
openapi: 3.0.3
info:
  title: Omniflow API
  version: 1.0.0
  description: >-
    Customer, commerce, payment, wallet, fulfillment, and operations API for
    Omniflow.
servers: []
security: []
paths:
  /readyz:
    get:
      tags:
        - system
      description: >-
        Reports every registered dependency. Failures carry a stable
        classification, never an underlying driver message, so the response
        cannot leak a connection string or a credential.
      operationId: getReadiness
      responses:
        '200':
          description: Every dependency answered
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Readiness'
        '503':
          description: At least one dependency is unavailable
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Readiness'
components:
  schemas:
    Readiness:
      type: object
      required:
        - status
        - checks
      properties:
        status:
          type: string
          enum:
            - ready
            - degraded
        checks:
          type: array
          items:
            $ref: '#/components/schemas/DependencyCheck'
    DependencyCheck:
      type: object
      required:
        - name
        - healthy
        - checkedAt
        - latencyMs
      properties:
        name:
          type: string
          description: Dependency name, such as postgres, valkey, or remnawave.
        healthy:
          type: boolean
        error:
          type: string
          enum:
            - timeout
            - unavailable
          description: Stable classification; never the underlying driver message.
        checkedAt:
          type: string
          format: date-time
        latencyMs:
          type: integer
          format: int64
        consecutiveFailures:
          type: integer

````

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