Calnex Sentinel - Page 65

Using Sentinel
CX3001 v7.0 © Calnex Solutions 65
calnexsol.com |
Description
This logs into the API service and removes the need for authentication on future API calls. This API allows you to
authenticate against Sentinel for the IP address used to access Sentinel. Supplying authentication would not be
required for future API calls if this login remains valid. The login would be stopped if Sentinel is rebooted, the
login timeout expires, or the logout service is called. If multiple devices or users may access the Sentinel from the
same IP address then security should be considered before this option is used, and it may be better to
authenticate each API call.
Parameters
Name
Description
Required
key
Authentication key obtained from getkey where enabled and login has
not been used
✓
Returns
On success this call will return a JSON string indicating success. The JSON result will also indicate the period
when authentication will expire:
{
"result" : true,
"message" : "Session will expire in 3600 seconds"
}
On failure Sentinel will respond with a 401 Authorization Required error
Example
Browser
https://192.168.123.123/api/login?key=823de38663e1…
Curl
curl -k https://192.168.123.123/api/login?key=823de38663e1…
The keys have been shortened in the above examples for clarity, but calling this API requires the full key obtained
from the getkey API call.
StartMeasurement
API Call
/api/startmeasurement
Summary
Start a measurement for the current Sentinel configuration
Description
This starts a measurement for the current configuration and enabled channels. A measurement will be started for
the currently set duration or continuous if continuous mode is configured. If continuous mode is set the files will
be stored on internal memory within the continuous folder as normal. If continuous mode is not set the
measurement data will be stored a folder based on the start date and time as normal. No option is available to
change the save path for measurements or to save to external memory locations.
Parameters
Name
Description
Required
key
Authentication key obtained from getkey where enabled and login has
not been used
Returns
JSON status code indicating success status:
{
"result" : true,
}
On failure, Sentinel will give an indication of why a measurement could not be started.
{
"result" : false,
"message" : "Measurement already running"
}