v5.1_Devices

POST devices/command/shutdown

Resource Information

Requires Authentication?	Yes
Response Formats	json
HTTP Methods	POST

Complete shutdown of the selected device.

Resource URL

https://{{ip_address}}:{{port}}/api/{{version}}/devices/command/shutdown

Example Request

POST

https://192.168.10.53/api/5.1/devices/command/shutdown

{
    "device": "05011df5-87b1-4141-a3c0-c547657bf9b1"
}

{
    "data": {
        "uuid": "7e3909f1-5188-484b-bc50-fc0fcb3faf88",
        "created": "2024-06-20T09:52:33.460Z",
        "modified": "2024-06-20T09:52:33.460Z",
        "progress": 0,
        "state": "Starting",
        "type": "Device Shutdown",
        "attributes": {
            "device": "05011df5-87b1-4141-a3c0-c547657bf9b1"
        }
    },
    "metadata": {}
}

POST devices/command/reset

Resource Information

Requires Authentication?	Yes
Response Formats	json
HTTP Methods	POST

Restarts all software components. Unsaved configuration is kept.

Resource URL

https://{{ip_address}}:{{port}}/api/{{version}}/devices/command/reset

Example Request

POST

https://192.168.10.53/api/5.1/devices/command/reset

{
    "device": "05011df5-87b1-4141-a3c0-c547657bf9b1"
}

POST devices/command/reboot

Resource Information

Requires Authentication?	Yes
Response Formats	json
HTTP Methods	POST

Full restart of the device. If a standalone system, configuration will return to last saved one, removing all unsaved changes. If device connected to stack, configuration will be kept, as long as at least one device on the stack stays up.

Resource URL

https://{{ip_address}}:{{port}}/api/{{version}}/devices/command/reboot

Example Request

POST

https://192.168.10.53/api/5.1/devices/command/reboot

POST devices/command/sync

Resource Information

Requires Authentication?	Yes
Response Formats	json
HTTP Methods	POST

Device Clock sync.

Resource URL

https://{{ip_address}}:{{port}}/api/{{version}}/devices/command/sync

Example Request

POST

https://192.168.10.53/api/5.1/devices/command/sync