|
Request Parameters
Parameter
|
Description
|
Mandatory
|
delay
|
Station restart delay in seconds.
If not set, a station will be restarted with a 60-second delay.
|
no
|
id
|
Group ID.
This parameter can be repeated any number of times per request to restart stations in multiple groups at a time.
|
yes
|
message
|
Free-form message to a user about a restart reason
|
yes
|
Request Example
https://192.168.1.1:9081/api/groups/reboot.ds?id=4&message=reboot&delay=45
|
XML and JSON response structure examples are described below.
XML Response Structure
<drweb-es-api api_version="4.3.2" timestamp="1582030316" server="192.168.1.1" srv_version="13.00.1.202310121" status="true">
<stations total="2">
<station id="1002" status="failed"/>
<station id="1003" status="initiated"/>
</stations>
</drweb-es-api>
|
Description of XML Response Parameters
The <stations /> element contains information about restart initiated on stations in groups specified in the request.
The <stations /> element attribute:
Attribute
|
Description
|
total
|
Total number of stations in a response
|
•The <station /> element contains information about restart initiated on a specific station.
The <station /> element attributes:
Attribute
|
Description
|
id
|
Station ID
|
status
|
Status of initiated restart on a station:
•failed—attempt to restart a station failed,
•initiated—restart was initiated. |
JSON Response Structure
{ "head": {
"status": true,
"timestamp": 1582030573,
"api": {
"version": 40302,
"versionString": "4.3.2"},
"server": {
"name": "192.168.1.1",
"version": "13.00.1.202310121",
"uuid": "eae1a652-96d5-48fd-9169-4788a03688b8"}},
"data": {
"total": 2,
"list": {
"1002": "failed",
"1003": "initiated"}}}
|
Description of JSON Response Parameters
The data block contains information about restart initiated on stations in groups specified in the request.
The data block elements:
Field name
|
Description
|
total
|
Total number of stations in a response
|
list
|
Block containing initiated restart results for each station
|
•The list block elements:
Field name
|
Description
|
Station ID
|
Status of initiated restart on a station:
•failed—attempt to restart a station failed,
•initiated—restart was initiated. |
|