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

# Check service health

> Answers when CliqHub is up, with its version, the API version, when it started, and its command queue counts. Needs no token; load balancers and `cliq` use it.

No authentication: anyone can call this.



## OpenAPI

````yaml /openapi/hub-by-tag/hub-system.yaml get /v1/health
openapi: 3.0.3
info:
  title: 'CliqHub API: System'
  version: 1.0.0
  description: >-
    Service health, and re-running the seed of built-in data (site
    administrators).
servers:
  - url: https://{host}
    variables:
      host:
        default: cliqhub.io
        description: CliqHub host
security: []
tags:
  - name: System
    description: >-
      Service health, and re-running the seed of built-in data (site
      administrators).
paths:
  /v1/health:
    get:
      tags:
        - System
      summary: Check service health
      description: >-
        Answers when CliqHub is up, with its version, the API version, when it
        started, and its command queue counts. Needs no token; load balancers
        and `cliq` use it.


        No authentication: anyone can call this.
      operationId: GET_v1_health
      responses:
        '200':
          description: Success.
          content:
            application/json:
              schema:
                type: object
                properties:
                  ok:
                    type: boolean
                    enum:
                      - true
                    description: Always `true` on success.
                  timestamp:
                    type: number
                    description: Server time (epoch milliseconds).
                  version:
                    type: string
                    description: CliqHub Core version.
                  api_version:
                    type: integer
                    description: API version; clients compare it to what they support.
                  started_at:
                    type: number
                    description: When this CliqHub process started (epoch milliseconds).
                  command_outbox_pending:
                    type: integer
                    description: Commands waiting to be delivered to daemons.
                  command_outbox_failed:
                    type: integer
                    description: Commands that gave up.
                  inbound_dedup_count:
                    type: integer
                    description: Requests remembered for de-duplication.
                required:
                  - ok
              example:
                ok: true
                timestamp: 1759834200000
                version: 2.14.0
                api_version: 6
                started_at: 1759830000000
                command_outbox_pending: 0
                command_outbox_failed: 0
                inbound_dedup_count: 412
        '500':
          description: >-
            `internal_error`: An unexpected server fault. Retry later; if it
            persists, report it with the time of the request.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HubErr'
              examples:
                internal_error:
                  summary: internal_error
                  value:
                    ok: false
                    error: Internal server error
                    code: internal_error
      security: []
components:
  schemas:
    HubErr:
      type: object
      required:
        - ok
        - error
      description: >-
        Every failure. Route-policy denials (401/403/404, and 400 when neither
        realm_id nor org_id was sent) answer `error` as `{ code, message }`;
        errors raised by the endpoint answer `error` as the message with the
        code beside it in `code`. Every error has a code. See
        [Errors](/hub-api/errors).
      properties:
        ok:
          type: boolean
          description: Always false on error
        error:
          description: The message, or `{ code, message }` for an access denial.
          oneOf:
            - type: string
            - type: object
              required:
                - code
                - message
              properties:
                code:
                  type: string
                message:
                  type: string
        code:
          type: string
          description: Stable error code of an endpoint error.
        details:
          type: object
          additionalProperties: true
          description: Structured detail, when there is some.

````

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