Calnex Sentinel - Page 72

Using Sentinel
CX3001 v7.0 © Calnex Solutions 72
calnexsol.com |
The actual returned parameter list will vary depending on the current configuration of Sentinel and the installed
modules and options available.
Example
Browser
https://192.168.123.123/api/get/measure
Curl
curl http://192.168.123.123/api/get/api/http_enabled
Set
API Call
/api/set/[required setting]
Summary
Set a parameter within the Sentinel configuration
Description
This API call sets one individual setting within the Sentinel configuration. The required value is passed to the API.
In general, it is recommended to determine the required options via the Sentinel screen and identify which
setting requires to be changed to switch between various modes of operation. These parameters can then be
sent to the Sentinel using the set call.
There is no additional information available as to the range of values that are appropriate for each parameter
beyond that displayed on the Sentinel settings screens.
Parameters
Name
Description
Required
key
Authentication key obtained from getkey where enabled and login has
not been used.
value
Specify the new value required for the parameter being set.
✓
Returns
A JSON formatted status will be returned if the group name or parameter name is not valid:
{
"result" : false,
"message" : "No parameter match found - measure/unknown"
}
Or
{
"result" : false,
"message" : "Not a valid group name - measure1"
}
If the parameter and group name is valid the new setting for the parameter will be returned in the same format
as the get API call would return. If the parameter could not be set due to it falling outside its allowed range, the
current value will be returned.
Example
Browser
http://192.168.123.123/api/set/measure/meas_time?value=1800
Curl
curl -k https://192.168.123.123/api/set/api/http_enabled?value=0
LockScreen
API Call
/api/lockscreen