Reset Device
The /actions/reset URL performs a device reset.
URL
/api/v1/actions/reset
HTTP Method
POST
Supported Request JSON Attributes
|
Attribute |
Type |
Value |
Description |
|---|---|---|---|
|
saveConfiguration |
Boolean |
true |
(Default) Store current configuration before reset. |
|
false |
Don't store current configuration. |
||
|
gracefulTimeout |
Number |
0 |
(Default) Perform a reset immediately. |
|
1 |
Wait for all calls to finish, and then perform a reset. |
||
|
<sec> |
Wait for a specified time (in seconds) for calls to finish, and then perform a reset. |
HTTP Responses
| ■ | 200 OK |
| ■ | 400 Bad request – provided attributes or values are incorrect. |
| ■ | 409 Conflict – reset can’t be performed due to current device state (e.g. synchronization with the redundant device is in progress). |
Example
| ■ | Request: |
POST /api/v1/actions/reset HTTP/1.1
Host: 10.4.219.229
Content-Type: application/json
{
"saveConfiguration": true,
"gracefulTimeout": 0
}
| ■ | Response: |
HTTP/1.1 200 OK
Content-Type: application/json
{
"description": "Device will reset now"
}
or
HTTP/1.1 409 Conflict
Content-Type: application/json
{
"description": "Device is currently performing HA synchronization"
}