Control the operating system and hardware: time, network, power, license, ZeroTier, logs
These endpoints are served by the hardware controller service of the device. All of them are under /api/system/. The minimum user role is admin for every endpoint except GET /api/system/time, which is available to viewer.
Firmware updates have their own page, Firmware Update. The service health check is on the Health Check page.
Responses use the standard {"message": ..., "data": ...} envelope; the pages linked below show the content of data. Errors reported by the hardware controller service carry the status code inside data, for example {"message": "network ID must be in range from 0 to 1, got 9", "data": {"status_code": 404}}. A request for a path that does not exist under /api/system/ returns 404 with the body { "response": "GET is not implemented for this path." }.
While a reboot, shutdown or factory reset is in progress the device reports restarting on the State page, and further such requests are rejected with 409.
| Endpoint | Method and path |
|---|---|
| List available time zones | GET /api/system/time/timezones |
| Get time settings | GET /api/system/time |
| Change time settings | PUT /api/system/time |
| Endpoint | Method and path |
|---|---|
| List network interfaces | GET /api/system/network |
| Get one network interface | GET /api/system/network/{ID} |
| Change network settings | PUT /api/system/network/{ID} |
| Endpoint | Method and path |
|---|---|
| Hardware and software state | GET /api/system/state |
| State of the watched applications | GET /api/system/state/components |
| Endpoint | Method and path |
|---|---|
| Reboot the device | POST /api/system/reboot |
| Shut the device down | POST /api/system/shutdown |
| Factory reset | POST /api/system/factory_reset |
| Endpoint | Method and path |
|---|---|
| Get license state | GET /api/system/license |
| Change the license key | PUT /api/system/license |
| Endpoint | Method and path |
|---|---|
| Get ZeroTier settings | GET /api/system/zerotier |
| Change ZeroTier settings | PUT /api/system/zerotier |
| Endpoint | Method and path |
|---|---|
| Reset the system log | DELETE /api/system/log/sys |
| Reset the application log | DELETE /api/system/log/app |
| List remote logging servers | GET /api/system/log/servers |
| Get a remote logging server | GET /api/system/log/servers/{ID} |
| Add a remote logging server | POST /api/system/log/servers |
| Edit a remote logging server | PUT /api/system/log/servers/{ID} |
| Delete a remote logging server | DELETE /api/system/log/servers/{ID} |
| Endpoint | Method and path |
|---|---|
| Get the device changelog | GET /api/system/changelog |
Available on IOTA 10 CORE PLUS only.
| Endpoint | Method and path |
|---|---|
| Get FPGA status | GET /api/system/fpga/status |
| Reprogram the FPGA | POST /api/system/fpga/reprogram |