|
Request Parameters
Parameter
|
Description
|
Mandatory
|
delay
|
Delay of station reboot in seconds.
If parameter is not set, then station will be rebooted with a 60 seconds delay.
|
no
|
id
|
Station ID.
This parameter can be defined in the request several times to reboot multiple stations at a time.
|
yes
|
message
|
Message to a user in a free form about the reason of reboot
|
yes
|
Request Example
https://192.168.1.1:9081/api/stations/reboot.ds?id=d071625c-d21d-b211-9bc4-bc02713bf843&message=reboot%20now
|
XML and JSON response structure examples are described below.
XML Response Structure
<drweb-es-api api_version="4.3.2" timestamp="1582030328" server="192.168.1.1" srv_version="13.00.1.202310121" status="true">
<stations total="1">
<station id="d071625c-d21d-b211-9bc4-bc02713bf843" status="failed"/>
</stations>
</drweb-es-api>
|
Description of XML Response Parameters
The <stations/> element contains information on reboot launch on stations specified in a request.
The <stations /> element attribute:
Attribute
|
Description
|
total
|
Total number of stations in a response
|
•The <station /> element contains information on reboot launch of a specific station.
The <station /> element attributes:
Attribute
|
Description
|
id
|
Station identifier
|
status
|
Status of station reboot launch:
•failed—attempt to reboot a station failed,
•initiated—reboot is initiated. |
JSON Response Structure
{ "head": {
"status": true,
"timestamp": 1582030585,
"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": 1,
"list": {
"d071625c-d21d-b211-9bc4-bc02713bf843": "failed"}}}
|
Description of JSON Response Parameters
The data block contains information on reboot launch on stations specified in a request.
The data block elements:
Field name
|
Description
|
total
|
Total number of stations in a response
|
list
|
Block with results of reboot launch for each station
|
•The list block elements:
Field name
|
Description
|
Station ID
|
Status of station reboot launch:
•failed—attempt to reboot a station failed,
•initiated—reboot is initiated. |
|