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

# Readiness check

> Returns service readiness status. Checks database, RLS enforcement, and Redis connectivity.



## OpenAPI

````yaml /api/openapi.json get /v1/ready
openapi: 3.1.0
info:
  title: MeshQu API
  description: >-
    Governance infrastructure for policy-aware AI decisions. MeshQu does not run
    tools. It governs decisions about them.
  version: 1.9.0
  contact:
    name: MeshQu Support
    email: support@meshqu.com
  license:
    name: Proprietary
servers:
  - url: https://api.meshqu.com
    description: Deployed environment
security:
  - apiKey: []
    tenantId: []
tags:
  - name: Operations
    description: Health, readiness, metrics, and signing keys
  - name: Policies
    description: Policy management
  - name: Policy Groups
    description: Policy group management
  - name: Decisions
    description: Policy evaluation and recording
  - name: Chains
    description: Decision chain verification and sealing
  - name: Receipts
    description: Public receipt and bundle retrieval
  - name: Forms
    description: Attestation forms and public submission
  - name: Alerts
    description: Alert management and webhooks
  - name: Audit
    description: Audit log retrieval and verification
  - name: API Keys
    description: API key administration
  - name: Admin
    description: Tenant and platform administration
  - name: Dashboard
    description: Console dashboard data
  - name: Metrics
    description: Decision and overview metrics
  - name: Fields
    description: Field catalogue
  - name: Settings
    description: Tenant settings
  - name: Rule Creation Logs
    description: Rule authoring telemetry
paths:
  /v1/ready:
    get:
      tags:
        - Operations
      summary: Readiness check
      description: >-
        Returns service readiness status. Checks database, RLS enforcement, and
        Redis connectivity.
      operationId: getV1Ready
      responses:
        '200':
          description: Default Response
          content:
            application/json:
              schema:
                type: object
                properties:
                  status:
                    anyOf:
                      - type: string
                        enum:
                          - ready
                      - type: string
                        enum:
                          - not_ready
                  timestamp:
                    format: date-time
                    type: string
                  components:
                    type: object
                    properties:
                      db:
                        anyOf:
                          - type: string
                            enum:
                              - ok
                          - type: string
                            enum:
                              - fail
                      redis:
                        anyOf:
                          - type: string
                            enum:
                              - ok
                          - type: string
                            enum:
                              - fail
                    required:
                      - db
                      - redis
                  checks:
                    type: object
                    properties:
                      database:
                        type: object
                        properties:
                          status:
                            anyOf:
                              - type: string
                                enum:
                                  - up
                              - type: string
                                enum:
                                  - down
                          latency_ms:
                            type: number
                        required:
                          - status
                          - latency_ms
                      redis:
                        type: object
                        properties:
                          status:
                            anyOf:
                              - type: string
                                enum:
                                  - up
                              - type: string
                                enum:
                                  - down
                              - type: string
                                enum:
                                  - not_configured
                          latency_ms:
                            type: number
                          error:
                            description: Error message if Redis check failed
                            type: string
                        required:
                          - status
                          - latency_ms
                      rls:
                        type: object
                        properties:
                          status:
                            anyOf:
                              - type: string
                                enum:
                                  - enforced
                              - type: string
                                enum:
                                  - not_enforced
                              - type: string
                                enum:
                                  - unknown
                          active_role:
                            description: Current database role after SET LOCAL ROLE
                            type: string
                          tenant_session:
                            anyOf:
                              - type: string
                                enum:
                                  - ok
                              - type: string
                                enum:
                                  - failed
                          error:
                            description: Error message if RLS check failed
                            type: string
                        required:
                          - status
                          - active_role
                          - tenant_session
                    required:
                      - database
                required:
                  - status
                  - timestamp
                  - checks
        '503':
          description: Default Response
          content:
            application/json:
              schema:
                type: object
                properties:
                  status:
                    anyOf:
                      - type: string
                        enum:
                          - ready
                      - type: string
                        enum:
                          - not_ready
                  timestamp:
                    format: date-time
                    type: string
                  components:
                    type: object
                    properties:
                      db:
                        anyOf:
                          - type: string
                            enum:
                              - ok
                          - type: string
                            enum:
                              - fail
                      redis:
                        anyOf:
                          - type: string
                            enum:
                              - ok
                          - type: string
                            enum:
                              - fail
                    required:
                      - db
                      - redis
                  checks:
                    type: object
                    properties:
                      database:
                        type: object
                        properties:
                          status:
                            anyOf:
                              - type: string
                                enum:
                                  - up
                              - type: string
                                enum:
                                  - down
                          latency_ms:
                            type: number
                        required:
                          - status
                          - latency_ms
                      redis:
                        type: object
                        properties:
                          status:
                            anyOf:
                              - type: string
                                enum:
                                  - up
                              - type: string
                                enum:
                                  - down
                              - type: string
                                enum:
                                  - not_configured
                          latency_ms:
                            type: number
                          error:
                            description: Error message if Redis check failed
                            type: string
                        required:
                          - status
                          - latency_ms
                      rls:
                        type: object
                        properties:
                          status:
                            anyOf:
                              - type: string
                                enum:
                                  - enforced
                              - type: string
                                enum:
                                  - not_enforced
                              - type: string
                                enum:
                                  - unknown
                          active_role:
                            description: Current database role after SET LOCAL ROLE
                            type: string
                          tenant_session:
                            anyOf:
                              - type: string
                                enum:
                                  - ok
                              - type: string
                                enum:
                                  - failed
                          error:
                            description: Error message if RLS check failed
                            type: string
                        required:
                          - status
                          - active_role
                          - tenant_session
                    required:
                      - database
                required:
                  - status
                  - timestamp
                  - checks
      security: []
components:
  securitySchemes:
    apiKey:
      type: http
      scheme: bearer
      bearerFormat: mqu_<token>
      description: >-
        MeshQu API key passed as a bearer token: `Authorization: Bearer mqu_…`.
        Mint one in the console (Settings → API keys).
    tenantId:
      type: apiKey
      name: X-MeshQu-Tenant-Id
      in: header
      description: >-
        Tenant UUID for multi-tenant isolation. Required on all authenticated
        routes — validated before authentication (middleware/tenant.ts), so a
        missing or non-UUID header returns 400 (MISSING_TENANT_ID /
        INVALID_TENANT_ID) before the API key is checked.

````