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

# Detailed health check

> Returns detailed health status including MQTT connection, cloud status,
memory usage, and state file status. Use this for monitoring and diagnostics.




## OpenAPI

````yaml get /health
openapi: 3.1.0
info:
  title: Aris API
  version: 1.0.0
  description: >
    REST API for controlling Aris home comfort systems.


    Aris is an air-to-water heat pump system that heats, cools, and provides hot
    water for homes.

    The Aris Brain is the central controller, managing zones, fan-coil units
    (FCUs), heat pumps,

    domestic hot water (DHW), and thermal energy storage (TES).


    ## Base URL


    The Aris Brain runs on your local network. Find your Brain's address via:

    - mDNS: `http://aris.local` (if your network supports mDNS)

    - Router admin panel: Look for a device named "aris-brain"


    ## Authentication


    Most API endpoints require authentication via Bearer token. Create an API
    token in the Aris web UI under **Settings → API Tokens**.


    Include the token in the `Authorization` header:

    ```

    Authorization: Bearer your-api-token

    ```


    ## Real-time Updates


    For real-time updates, connect to the WebSocket at
    `ws://aris.local?token=YOUR_API_TOKEN`.

    The WebSocket broadcasts zone state changes, system events, and device
    telemetry.
servers:
  - url: http://aris.local
    description: Local network (mDNS)
  - url: http://{brainIp}
    description: Local network (IP address)
    variables:
      brainIp:
        default: 192.168.1.100
        description: Your Aris Brain's IP address
security: []
tags:
  - name: Health
    description: Health check and readiness endpoints
  - name: System
    description: System-wide state and mode control
  - name: Zones
    description: Zone management, setpoints, and temperature control
  - name: DHW
    description: Domestic Hot Water tank status and history
  - name: TES
    description: Thermal Energy Storage tank status
  - name: HCU
    description: Hydronic Control Unit status
  - name: Heat Pumps
    description: Heat pump telemetry and diagnostics
  - name: FCUs
    description: Fan Coil Unit telemetry and status
  - name: Weather
    description: Weather data and forecasts
  - name: Events
    description: System event log and audit trail
  - name: Metrics
    description: VictoriaMetrics time-series data proxy
  - name: Prometheus
    description: Prometheus-compatible API for Grafana
  - name: Tokens
    description: API token management
  - name: Config
    description: System configuration (read-only)
  - name: Firmware
    description: FCU firmware OTA updates
paths:
  /health:
    get:
      tags:
        - Health
      summary: Detailed health check
      description: >
        Returns detailed health status including MQTT connection, cloud status,

        memory usage, and state file status. Use this for monitoring and
        diagnostics.
      operationId: getHealth
      responses:
        '200':
          description: System is healthy or degraded
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HealthResponse'
              example:
                status: ok
                version: 1.0.0
                uptime_seconds: 86400
                timestamp: '2024-01-15T10:30:00Z'
                checks:
                  mqtt:
                    status: ok
                    connected: true
                  cloud:
                    status: ok
                    state: connected
                    connected: true
                  memory:
                    heap_used_mb: 45
                    heap_total_mb: 64
                    rss_mb: 120
                  state_file:
                    status: ok
                    last_modified: '2024-01-15T10:29:00Z'
        '503':
          description: System is unhealthy (MQTT disconnected)
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HealthResponse'
      security: []
components:
  schemas:
    HealthResponse:
      type: object
      properties:
        status:
          type: string
          enum:
            - ok
            - degraded
            - unhealthy
        version:
          type: string
        uptime_seconds:
          type: integer
        timestamp:
          type: string
          format: date-time
        checks:
          type: object
          properties:
            mqtt:
              type: object
              properties:
                status:
                  type: string
                  enum:
                    - ok
                    - error
                connected:
                  type: boolean
            cloud:
              type: object
              properties:
                status:
                  type: string
                  enum:
                    - ok
                    - error
                    - disabled
                state:
                  type: string
                connected:
                  type: boolean
            memory:
              type: object
              properties:
                heap_used_mb:
                  type: integer
                heap_total_mb:
                  type: integer
                rss_mb:
                  type: integer
            state_file:
              type: object
              properties:
                status:
                  type: string
                  enum:
                    - ok
                    - error
                last_modified:
                  type: string
                  format: date-time

````