Sign in

v1

latestOpenAPI 3.1.0raw.githubusercontent.com2026-02-1354131442.5 KB
v1
health

Basic API Health Check

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.

get/api/v1/health

Response

Basic health status including database, disk space, and temperature

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

versionstring 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

Example response

{
  "description": "All systems operational with normal status",
  "summary": "Healthy System",
  "value": {
    "database_connection": "ok",
    "disk_space": "ok",
    "raspi_hardware": {
      "cpu": {
        "frequency_mhz": 2400,
        "is_throttled": false,
        "max_frequency_mhz": 2400
      },
      "power": {
        "input_voltage_v": 5.14,
        "under_voltage_detected": false
      },
      "temperature": {
        "status": "healthy",
        "temperature_celsius": 59.7
      }
    },
    "status": "healthy",
    "version": "1.1.3"
  }
}
All 54 operations