API Reference

System Info

Get static hardware information about the system.

The /api/system endpoint returns static system information that rarely changes, such as CPU model, GPU specs, and total RAM.

Endpoint

MethodURL
GET/api/system

Example Request

Request
curl http://192.168.1.100:9990/api/system

Response Schema

Response
{
    "hostname": "MY-GAMING-PC",
    "platform": "win32",
    "cpu": {
        "manufacturer": "Intel",
        "brand": "Core™ i9-14900K",
        "cores": 32,
        "physicalCores": 24,
        "baseSpeed": 3.2
    },
    "gpu": {
        "vendor": "NVIDIA",
        "model": "NVIDIA GeForce RTX 4070 Ti SUPER",
        "vram": 16384
    },
    "memory": {
        "total": 34268311552
    },
    "disks": [
        {
            "fs": "C:",
            "type": "NTFS",
            "size": 1024000000000,
            "mount": "C:"
        }
    ]
}

Field Reference

Root Object

FieldTypeDescription
hostnamestringComputer name (configurable in config).
platformstringAlways "win32" on Windows, "darwin" on macOS.
cpuobjectCPU specifications.
gpuobjectGPU specifications (null if not detected).
memoryobjectRAM information.
disksarrayList of disk drives.

CPU Object

FieldTypeDescription
manufacturerstringCPU manufacturer (e.g., "Intel", "AMD").
brandstringFull CPU name.
coresintTotal logical cores.
physicalCoresintPhysical core count.
baseSpeedfloatBase clock speed in GHz.

GPU Object

FieldTypeDescription
vendorstringGPU vendor (e.g., "NVIDIA", "AMD").
modelstringFull GPU model name.
vramintVideo RAM in MB.

Memory Object

FieldTypeDescription
totalintTotal RAM in bytes.

Disk Object

FieldTypeDescription
fsstringFilesystem identifier (e.g., "C:").
typestringFilesystem type (e.g., "NTFS", "APFS").
sizeintTotal size in bytes.
mountstringMount point.

On this page