API Reference
Usage Data
Get dynamic system usage metrics.
The /api/usage endpoint returns real-time usage data that changes frequently, such as CPU load, memory usage, and temperatures.
curl http://192.168.1.100:9990/api/usage
{
"uptime": 86400,
"cpu": {
"currentLoad": 12.5,
"currentSpeed": 5.2
},
"memory": {
"used": 12456789012,
"free": 21811522540,
"usedPercent": 36.35
},
"gpu": {
"utilizationGpu": 5,
"temperatureGpu": 42,
"vramUsed": 1024
},
"disks": [
{
"fs": "C:",
"used": 450000000000,
"available": 574000000000,
"usedPercent": 43.95
}
]
}
| Field | Type | Description |
|---|
uptime | int | System uptime in seconds. |
cpu | object | Current CPU usage metrics. |
memory | object | Current memory usage. |
gpu | object | Current GPU usage (null if not detected). |
disks | array | Current disk usage for each drive. |
| Field | Type | Description |
|---|
currentLoad | float | Current CPU usage percentage. |
currentSpeed | float | Current clock speed in GHz. |
| Field | Type | Description |
|---|
used | int | Used RAM in bytes. |
free | int | Free RAM in bytes. |
usedPercent | float | Usage as a percentage. |
| Field | Type | Description |
|---|
utilizationGpu | int | GPU usage percentage. |
temperatureGpu | int | GPU temperature in °C. |
vramUsed | int | VRAM usage in MB. |
| Field | Type | Description |
|---|
fs | string | Filesystem identifier. |
used | int | Used space in bytes. |
available | int | Available space in bytes. |
usedPercent | float | Usage as a percentage. |
Polling Recommendation
For dashboards, poll this endpoint every 2-5 seconds.
More frequent polling provides smoother updates but increases network traffic.