Calnex Sentinel - Page 77

Using Sentinel
CX3001 v7.0 © Calnex Solutions 77
calnexsol.com |
Example
Browser
Not Applicable
Curl
curl -k https://192.168.123.123/api/installcertificate –data-binary @certificate.pem
ClearDevice
API Call
/api/cleardevice
Summary
Clear all user data from the Sentinel device.
Description
This service clears all user information from the device. All user measurements, settings and log files will be
deleted. This will also clear installed certificate files where present. action must be included in the request to
prevent accidental device erasure by calling this API. No mechanism is available to stop this service once it has
been called. Data is not recoverable, and any required data should be removed from the Sentinel before calling
this API. The API call will give an indication if any of the user files could not be delete from Sentinel.
Parameters
Name
Description
Required
key
Authentication key obtained from getkey where enabled and login has
not been used.
action
This parameter must be included and must be set equal to cleardevice for
the cleardevice to be actioned.
✓
Returns
JSON formatted status for the request:
{
"result" : true,
"message" : "Device data cleared. The device will now reboot."
}
If action is not included on the API call as a parameter the following response will be received:
{
"result" : false,
"message" : "Confirmation not provided"
}
If all user data cannot be deleted the following response will be received:
{
"result" : false,
"message" : "Device data could not all be removed. Please retry or reboot and then
retry."
}
Example
Browser
https://192.168.123.123/api/cleardevice?action=cleardevice
Curl
curl -k https://192.168.123.123/api/cleardevice?action=cleardevice
UpdateFirmware
API Call
/api/updatefirmware