System State

Retrieve state of the system

The health check of the hardware controller is documented on the Health Check page.

API

Get state of the system:

Path: /api/system/state
Method: GET
Minimum user role: admin

Response:

{
    "time": 1695036185,
    "uptime": 19397,
    "commit_id": "fb2d6b9",
    "hardware": {
        "hardware_ok": true,
        "hardware_version": null,
        "hardware_failure_reason": null,
        "hardware_failure_time": null
    },
    "software": {
        "software_version": "5.0.0",
        "software_release_timestamp": "2023.11"
    },
    "nvme": [
        {
            "name": "data1",
            "temperature": 37,
            "critical_warnings": 0,
            "available_spare": 100,
            "available_spare_threshold": 10,
            "percentage_used": 0
        },
        {
            "name": "data2",
            "temperature": 38,
            "critical_warnings": 0,
            "available_spare": 100,
            "available_spare_threshold": 10,
            "percentage_used": 0
        },
        {
            "name": "root",
            "temperature": 46,
            "critical_warnings": 0,
            "available_spare": 100,
            "available_spare_threshold": 10,
            "percentage_used": 0
        }
    ],
    "cpu": {
        "main_cpu_temperature": 68,
        "ipmi_cpu_temperature": 75
    },
    "fan": [
        {
            "name": "FAN1",
            "speed_rpm": 7300
        },
        {
            "name": "FAN2",
            "speed_rpm": 7500
        },
        {
            "name": "FANB",
            "speed_rpm": 7800
        }
    ]
}

time - current server timestamp (unix epoch, seconds)
uptime - system uptime in seconds
commit_id - git commit hash of the running hw-controller build
hardware - generic hardware health
- hardware_ok - true if no failure has been detected
- hardware_version - platform-specific hardware version (nullable)
- hardware_failure_reason / hardware_failure_time - populated when hardware_ok is false
software - installed IOTA software info
nvme - per-disk SMART data for every present NVMe drive (fields follow NVMe SMART/Health attributes)
cpu - CPU temperature readings (fields present depend on the platform)
fan - fan speed readings, one entry per fan present on the platform