Pearl REST API check system status, reboot, shut down, and factory reset
System endpoints report the hardware condition of a Pearl device and provide power and reset control. The reset and power endpoints act immediately and interrupt any recording or streaming in progress.
Applies to: Pearl-2, Pearl Mini, Pearl Nexus, Pearl Nano.
System status.
GET /api/v2.0/system/status
| Field | Meaning |
|---|---|
date |
Current system time |
uptime |
Seconds since the last reboot |
cpuload |
CPU load as a percentage, 0 to 100 |
cpuload_high |
Indicator that CPU load is high |
cputemp |
CPU temperature in degrees Celsius |
cputemp_threshold |
Temperature above which the CPU is considered too hot |
Compare cputemp against cputemp_threshold rather than against a fixed number, because the threshold is reported per device.
Power and reset control.
| Method and path | Effect |
|---|---|
POST /system/control/reboot |
Reboots the device |
POST /system/control/shutdown |
Shuts the device down |
POST /system/control/factoryreset |
Performs a factory reset |
Factory reset is destructive and cannot be undone. It deletes all data from the device and resets configuration settings to factory defaults, including recordings still stored on the device, channel and publisher configuration, and network settings. Export any configuration presets and download any recordings you need before calling it.
All three endpoints return {"status": "ok"} once the command has been accepted. Because the device goes offline immediately afterwards, do not expect any further response on the same connection, and allow time for the device to come back before polling it again.