Calnex Sentinel - API Interface Service List

Using Sentinel
CX3001 v7.0 © Calnex Solutions 63
calnexsol.com |
The key obtained via getkey is valid until the next power cycle of the Sentinel or until the Key Seed is changed
within settings.
Login
Sentinel considers authentication against a particular IP address. Once you have logged in to the interface, any
access from the same source IP address will be accepted without the need for the key to be provided on each
request. Where this is an issue, you should avoid using the login function and instead should provide the key on
each API request.
A login will remain valid until logout has been called or the timeout period as set via the HTTP(S) API option
screen has passed.
10.2 API Interface Service List
List
API Call
/api/list
Summary
Display a list of available API calls
Description
This call displays a list of all available API calls available for the interface. The access modes allowed for the
current configuration is also displayed. Examples of where the access modes allowed can change are as follows.
• When authentication is enabled only HTTPS access is allowed.
• getkey and login are only ever available via HTTPS as these services deal with accessing the API via
authentication.
• The access mode will not be available if that access mode has been disabled in the configuration of the
API
Parameters
Name
Description
Required
key
Authentication key obtained from getkey where enabled and login has
not been used
Returns
Basic HTML table of all services available via the remote-control API
Example
Browser
http://192.168.123.123/api/list
Curl
curl http://192.168.123.123/api/list
GetKey
API Call
/api/getkey
Summary
Obtain API key for authentication
Description
This call is used to obtain the current API key required for authentication. The key is based on the seed set within
the configuration and another random seed internal to the Sentinel. The current security seed must be provided
to this call as a parameter. If the correct seed is provided as e.g., seed=1234, the required API key will be
returned as plain text. The returned key should be used for all subsequent API calls requiring authentication. The
API key changes each time Sentinel is restarted, or the API seed is changed.