Edge Monitor API
Jan 1 2022 at 12:00 AM
The Edge Monitor Service is used to store the received heartbeat packets of registered gateways for a configurable period. It then enables the portal UI to display the historical health of gateways. It also enables users to set up gateway health thresholds based on Last Communication, CPU, Memory, Threads and Temperature.
Prerequisites
To use this service you will need access to Portal UI. At least one registered gateway that is actively sending heartbeats.
APIs within Edge Monitor API
EdgeMonitor
API Calls
GetLatestGatewayHealthsPaged
Permission
gateways:get
Accessible
All. See response and accessiblity information for more
URL
https://iotnxtinternal.commander.io/DAPI/v1/EdgeMonitor/GetLatestGatewayHealthsPaged
URL Params
NONE
Data Params
{
“currentPage”: 100,
“pageSize”: 100,
“searchText”: “string”
}
currentPage: int (required)
pageSize: int (required)
searchText: string (required)
Success Response
Response message with the following codes and JSON body formats. Refer to the API Response Types Success Response. See response and accessiblity information for more
Error Response
Response message with the following codes and HTMLs body formats. Refer to the API Response Types Error Response. See response and accessiblity information for more
Notes
None
GetLatestGatewayHealths
Permission
gateways:get
Accessible
All. See response and accessiblity information for more
URL
https://iotnxtinternal.commander.io/DAPI/v1/EdgeMonitor/GetLatestGatewayHealths
URL Params
NONE
Data Params
NONE
Success Response
Response message with the following codes and JSON body formats. Refer to the API Response Types Success Response. See response and accessiblity information for more
Error Response
Response message with the following codes and HTMLs body formats. Refer to the API Response Types Error Response. See response and accessiblity information for more
Notes
None
SearchLatestGatewayHealthsByGatewayId
Permission
gateways:get
Accessible
All. See response and accessiblity information for more
URL
https://iotnxtinternal.commander.io/DAPI/v1/EdgeMonitor/SearchLatestGatewayHealthsByGatewayId
URL Params
NONE
Data Params
{
“searchText”: “text”
}
- searchText: text (required)
Success Response
Response message with the following codes and JSON body formats. Refer to the API Response Types Success Response. See response and accessiblity information for more
Error Response
Response message with the following codes and HTMLs body formats. Refer to the API Response Types Error Response. See response and accessiblity information for more
Notes
None
GetHealthsForGateway
Permission
gateways:get
Accessible
All. See response and accessiblity information for more
URL
https://iotnxtinternal.commander.io/DAPI/v1/EdgeMonitor/GetHealthsForGateway
URL Params
NONE
Data Params
{
“gatewayId”: “string”
}
- gatewayId: string (required)
Success Response
Response message with the following codes and JSON body formats. Refer to the API Response Types Success Response. See response and accessiblity information for more
Error Response
Response message with the following codes and HTMLs body formats. Refer to the API Response Types Error Response. See response and accessiblity information for more
Notes
None
SubscribeToUpdates
Permission
gateways:get
Accessible
All. See response and accessiblity information for more
URL
https://iotnxtinternal.commander.io/DAPI/v1/EdgeMonitor/SubscribeToUpdates
URL Params
NONE
Data Params
NONE
Success Response
Response message with the following codes and JSON body formats. Refer to the API Response Types Success Response. See response and accessiblity information for more
Error Response
Response message with the following codes and HTMLs body formats. Refer to the API Response Types Error Response. See response and accessiblity information for more
Notes
None
UnsubscribeToUpdates
Permission
gateways:get
Accessible
All. See response and accessiblity information for more
URL
https://iotnxtinternal.commander.io/DAPI/v1/EdgeMonitor/UnsubscribeToUpdates
URL Params
NONE
Data Params
NONE
Success Response
Response message with the following codes and JSON body formats. Refer to the API Response Types Success Response. See response and accessiblity information for more
Error Response
Response message with the following codes and HTMLs body formats. Refer to the API Response Types Error Response. See response and accessiblity information for more
Notes
None
Continue
Permission
NONE
Accessible
All. See response and accessiblity information for more
URL
https://iotnxtinternal.commander.io/DAPI/v1/EdgeMonitor/Continue
URL Params
NONE
Data Params
NONE
Success Response
Response message with the following codes and JSON body formats. Refer to the API Response Types Success Response. See response and accessiblity information for more
Error Response
Response message with the following codes and HTMLs body formats. Refer to the API Response Types Error Response. See response and accessiblity information for more
Notes
None
Pause
Permission
NONE
Accessible
All. See response and accessiblity information for more
URL
https://iotnxtinternal.commander.io/DAPI/v1/EdgeMonitor/Pause
URL Params
NONE
Data Params
NONE
Success Response
Response message with the following codes and JSON body formats. Refer to the API Response Types Success Response. See response and accessiblity information for more
Error Response
Response message with the following codes and HTMLs body formats. Refer to the API Response Types Error Response. See response and accessiblity information for more
Notes
None
GetStatus
Permission
NONE
Accessible
All. See response and accessiblity information for more
URL
https://iotnxtinternal.commander.io/DAPI/v1/EdgeMonitor/GetStatus
URL Params
NONE
Data Params
NONE
Success Response
Response message with the following codes and JSON body formats. Refer to the API Response Types Success Response. See response and accessiblity information for more
Error Response
Response message with the following codes and HTMLs body formats. Refer to the API Response Types Error Response. See response and accessiblity information for more
Notes
None