|
Request Parameters
Parameter
|
Description
|
Mandatory
|
delay
|
Delay of station reboot in seconds.
If the parameter is not set, then delay is 60 seconds.
|
no
|
id
|
Group identifier.
This parameter can be defined in the request several times to reboot stations of several groups at a time.
|
yes
|
message
|
Message to a user in a free form about the reason of reboot
|
yes
|
Request Example
http://192.168.1.1:9080/api/groups/reboot.ds?id=4&message=reboot&delay=45
|
XML and JSON response structure examples are described below.
XML Response
<drweb-es-api api_version="4.3.0" timestamp="1558521934" server="192.168.1.1" srv_version="12.00.0.201909260" status="true">
<stations total="1">
<station id="70200e02-d21d-b211-8a39-a00ca2f8be36" status="failed"/>
<station id="2091ada3-ed5e-e611-3392-f0b9022a5484" status="initiated"/>
</stations>
</drweb-es-api>
|
Description of XML Response Parameters
The <stations /> element contains information on all stations for which reboot has been requested.
The <stations /> element attribute:
Attribute
|
Description
|
total
|
Total number of stations for which reboot has been requested
|
•The <station /> element contains information on specific stations on which reboot has been requested. The <station /> element attributes:
Attribute
|
Description
|
id
|
Station identifier
|
status
|
The state of reboot process. Can take the following values:
•failed—attempt to reboot a station is failed, •initiated—reboot is initiated. |
JSON Response
{ "head": {
"status": true,
"timestamp": 1558522021,
"api": {
"version": 40300,
"versionString": 4.3.0},
"server": {
"name": "192.168.1.1",
"version": "12.00.0.201909260",
"uuid": "27671337-e0b0-4f60-aeb0-ab1f2ca47f77"}},
"data": {
"total": 2,
"list": {
"70200e02-d21d-b211-8a39-a00ca2f8be36": "failed",
"2091ada3-ed5e-e611-3392-f0b9022a5484": "initiated"}}}
|
Description of JSON Response Parameters
The data block contains information on all stations for which reboot has been requested.
The data block elements:
Field name
|
Description
|
total
|
Total number of stations for which reboot has been requested
|
•The list array contains information on specific stations on which reboot has been requested. Elements in the list array:
Field name
|
Description
|
Identifier of station on which reboot has been requested
|
The state of reboot process. Can take the following values:
•failed—attempt to reboot a station is failed, •initiated—reboot is initiated. |
|