Calnex Sentinel - Page 64

Using Sentinel
CX3001 v7.0 © Calnex Solutions 64
calnexsol.com |
Parameters
Name
Description
Required
seed
The value of the currently configured seed key for the API stored within
settings
✓
Returns
The returns the required API key for the current session, an example would be as follows.
34954a1a5ac07c8ed130d4444badb1e524f812d10e2180ced8cbb52f4344e17e
This call returns a 403 Forbidden error if it is accessed via HTTP.
Example
Browser
https://192.168.123.123/api/getkey?seed=1234
Curl
curl -k https://192.168.123.123/api/getkey?seed=1234
The parameter -k for curl is used in this case as we have no valid SSL certificate configured and we are telling
curl to allow insecure connections.
Both examples assume that the seed is configured to 1234 in the Sentinel settings.
Logout
API Call
/api/logout
Summary
Logout of an authenticated session for the current source IP address
Description
This call logs the current IP address out of an authenticated session resulting in all further API calls now needing
authentication. If other users were sharing the same source IP for communication with Sentinel, they would also
be logged out. No error will be triggered if the current IP address is not logged into the Sentinel via
authentication.
Parameters
Name
Description
Required
No parameters required
Returns
JSON status code indicating success status:
{
"result" : true
}
Example
Browser
https://192.168.123.123/api/logout
Curl
curl -k https://192.168.123.123/api/logout
Login
API Call
/api/login
Summary
Log into the Sentinel using authentication