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

# Retrieve the health status



## OpenAPI

````yaml https://raw.githubusercontent.com/webhookx-io/webhookx/refs/heads/main/openapi-status.yml get /health
openapi: 3.0.3
info:
  title: WebhookX Status API
  contact:
    name: WebhookX
    url: https://github.com/webhookx-io/webhookx
  license:
    name: Apache 2.0
    url: https://www.apache.org/licenses/LICENSE-2.0.html
  version: 1.0.1
servers:
  - url: http://localhost:9602
security: []
paths:
  /health:
    get:
      summary: Retrieve the health status
      responses:
        '200':
          description: '200'
          content:
            application/json:
              schema:
                type: object
              example:
                status: UP
                components:
                  db:
                    status: UP
                  redis:
                    status: UP
        '503':
          description: '503'
          content:
            application/json:
              schema:
                type: object
              example:
                status: DOWN
                components:
                  db:
                    status: DOWN
                  redis:
                    status: UP

````