EasyManua.ls Logo

Calnex Sentinel - Recovery API Interface Service List

Calnex Sentinel
93 pages
Print Icon
To Next Page IconTo Next Page
To Next Page IconTo Next Page
To Previous Page IconTo Previous Page
To Previous Page IconTo Previous Page
Loading...
Using Sentinel
CX3001 v7.0 © Calnex Solutions 78
calnexsol.com |
Summary
Load a new firmware version onto the Sentinel device.
Description
This service loads a new firmware version onto the Sentinel device as provided by Calnex. This firmware would
normally be uploaded via the About page of the System menu but can also be uploaded and applied via this
remote API service.
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" : "Installing firmware Version: 2.14.0.0.1234-20210924"
}
If the provided file cannot be installed then the following will be returned:
{
"result" : false,
"message" : "Update failed, check firmware file"
}
Example
Browser
Not Applicable
Curl
curl -k https://192.168.123.123/api/updatefirmware --data-binary @/home/user/sentinel_fw_R14.0.0.tar
10.3 Recovery API Interface Service List
The API service calls should not be used in normal operation and their equivalents in the API service list should
be utilised. These services are intended for recovering the Sentinel to a working state if it is being unresponsive
to API calls and there is no local access available to the unit to perform corrective actions.
These services are not limited to https, may not make use of any https certificate installed and also do not
require authentication for use. These limitations are all intended to aid recovery as some of these mechanisms
may be the cause of limited API access normally.
Clear
API Call
/api/clear
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 after calling this service. The API call will give an indication if any of the user
files could not be delete from Sentinel.
Parameters
Name
Description
Required

Related product manuals