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

# Health check endpoint

> Returns the health status of the API server



## OpenAPI

````yaml api-reference/pinpoint/openapi.json get /api/health
openapi: 3.0.1
info:
  title: Pinpoint API
  description: >-
    Weather forecast API providing hourly and daily forecasts, location
    information, and weather parameters
  version: 1.0.0
servers:
  - url: http://pinpoint.devops.arabiaweather.com
    description: Development API server
  - url: http://n01.pinpoint.devops.arabiaweather.com
    description: Development node n01
  - url: http://n02.pinpoint.devops.arabiaweather.com
    description: Development node n02
  - url: http://n03.pinpoint.devops.arabiaweather.com
    description: Development node n03
  - url: http://n04.pinpoint.devops.arabiaweather.com
    description: Development node n04
  - url: http://n05.pinpoint.devops.arabiaweather.com
    description: Development node n05
  - url: http://internal-tools-pinpoint.devops.arabiaweather.com
    description: Internal tools API server
security: []
tags:
  - name: forecast
  - name: parameters
  - name: location
  - name: admin
  - name: debug
paths:
  /api/health:
    get:
      tags:
        - admin
      summary: Health check endpoint
      description: Returns the health status of the API server
      parameters: []
      responses:
        '200':
          description: API is healthy
          content:
            application/json:
              schema:
                type: object
                properties:
                  status:
                    type: string
                    example: ok
                    description: Overall health status
                  dependencies:
                    type: object
                    description: Health status of various dependencies
                    additionalProperties:
                      type: object
                      properties:
                        ok:
                          type: boolean
                          description: Whether the dependency is healthy
                          example: true
                        time_ms:
                          type: number
                          description: Response time in milliseconds
                          example: 3
                      required:
                        - ok
                        - time_ms
                    example:
                      redis_cache_write:
                        ok: true
                        time_ms: 3
                      hijri_data:
                        ok: true
                        time_ms: 4
                      redis_overrides:
                        ok: true
                        time_ms: 0
                      redis_cache_read:
                        ok: true
                        time_ms: 3
                      modms:
                        ok: true
                        time_ms: 54
                required:
                  - status
                  - dependencies
                example:
                  dependencies:
                    redis_cache_write:
                      ok: true
                      time_ms: 3
                    hijri_data:
                      ok: true
                      time_ms: 4
                    redis_overrides:
                      ok: true
                      time_ms: 0
                    redis_cache_read:
                      ok: true
                      time_ms: 3
                    modms:
                      ok: true
                      time_ms: 54
                  status: ok
      deprecated: false
      security: []

````