---
title: "Basic API Health Check"
method: GET
path: "/api/v1/health"
tags: ["v1", "health"]
---

# Basic API Health Check

`GET /api/v1/health`

Perform a basic health check of the ReelAPI system.

Returns essential health status information including database connectivity, disk space availability, 
and API version. Use this endpoint for simple health monitoring and automated health checks.

## Response `200`

Basic health status including database, disk space, and temperature

- HealthCheckResponse — Basic system health check response. Provides essential health status information for quick system monitoring and automated health checks.
  - `status` 'healthy' | 'unhealthy', required — Overall system health status. - **"healthy"**: All systems operational and within normal parameters - **"unhealthy"**: One or more critical systems experiencing issues **Dependencies**: Database connectivity and disk space availability
  - `database_connection` 'ok' | 'failed', required — Database connectivity status. - **"ok"**: Database is accessible and responding normally - **"failed"**: Unable to establish database connection **Impact**: Database failure will result in overall unhealthy status
  - `version` string, semantic versioning (major.minor.patch), required — Current ReelAPI version number
  - `disk_space` 'ok' | 'low', required — Simple disk space status indicator. - **"ok"**: Disk utilization under 90% OR more than 8GB free space available - **"low"**: Disk utilization over 90% AND less than 8GB free space **Monitoring**: Monitor this field for storage capacity warnings
  - `raspi_hardware` RaspiHardwareStatus, required
    - `temperature` RaspiTempStatus, required
      - `status` string — The health of the Raspberry Pi 5 chip temperature.
      - `temperature_celsius` number — The current temperature of the Raspberry Pi 5 chip, in Celsius. -9999 is a sentinel values.
    - `cpu` CpuStatus, required — CPU frequency and throttle status
      - `frequency_mhz` integer, required — Current CPU frequency in MHz
      - `max_frequency_mhz` integer, required — Maximum CPU frequency in MHz
      - `is_throttled` boolean, required — CPU is currently throttled
    - `power` PowerStatus, required — Power supply status
      - `input_voltage_v` number, nullable — USB-C input voltage in volts
      - `under_voltage_detected` boolean, required — Under-voltage alarm active

## Other responses

- `500` — Internal server error during health check

---

[API](https://skmtc.net/reach-systems-tech/apis/reelapi-v1.md) · [All operations](https://skmtc.net/reach-systems-tech/apis/reelapi-v1/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/reach-systems-tech/reelapi-v1/revisions/1dd366a9c6a3/schema)