Sign in

v1

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

Detailed API Health Diagnostics

Perform comprehensive health diagnostics of the ReelAPI system.

Returns detailed system information including:

  • Database connectivity and latency metrics
  • Disk space utilization with detailed breakdowns
  • System identification (UUID, serial number, display name)
  • API and deployment environment information

Use this endpoint for thorough system diagnostics, monitoring dashboards, and asset tracking.

get/api/v1/health/detailed

Response

Comprehensive health diagnostics with performance metrics

status'healthy' | 'unhealthy' required

Overall system health status.

  • "healthy": All systems operational and within normal parameters
  • "unhealthy": One or more critical systems experiencing issues
database_connection'ok' | 'failed' required

Database connectivity status.

  • "ok": Database is accessible and responding normally
  • "failed": Unable to establish database connection
database_latencynumber required

Database connection latency in milliseconds.

versionstring semantic versioning (major.minor.patch) required

Current ReelAPI version number

api_versionstring version prefix (v1, v2, etc.) required

API endpoint version identifier

serial_numberstring

Hardware serial number for this reel system.

Factory or field-assigned serial number for hardware identification and warranty tracking. Can be updated by administrators.

display_namestring

User-friendly display name for this reel system.

Customizable name for easy identification in multi-reel environments or user interfaces. Can be updated by any authenticated user.

uuidstring uuid4

Unique identifier for this reel system.

Permanent UUID that uniquely identifies this specific reel hardware. Used for asset tracking, configuration management, and system identification.

environmentstring required

Deployment environment identifier.

Common Values:

  • "production": Live production deployment
  • "testing": Testing environment
  • "local": Local development instance

Usage: Helps identify which environment is being monitored

Example response

{
  "description": "Comprehensive health status showing optimal performance",
  "summary": "Healthy System - Detailed",
  "value": {
    "api_version": "v1",
    "database_connection": "ok",
    "database_latency": 23.5,
    "disk_space": {
      "free_bytes": 33739681792,
      "free_gb": 31.42,
      "percent_used": 40.74,
      "total_bytes": 62303657984,
      "total_gb": 58.02,
      "used_bytes": 25381072896,
      "used_gb": 23.64
    },
    "display_name": "Smart Winch",
    "environment": "production",
    "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
      }
    },
    "serial_number": "RWS-2024-001",
    "status": "healthy",
    "uuid": "550e8400-e29b-41d4-a716-446655440000",
    "version": "1.1.3"
  }
}