Link Search Menu Expand Document

Edge Monitor Config API

Jan 1 2022 at 12:00 AM

  1. APIs within Edge Monitor Config API
    1. EdgeMonitorConfig
      1. API Calls

The Edge Monitor Config API contains functionality for updating the configuration of the Edge Monitor API.

APIs within Edge Monitor Config API

EdgeMonitorConfig

API Calls

GetGatewayHealthThresholds

GET

Permission

commander_config.dynamic_config:set

Accessible

All. See response and accessiblity information for more

URL

https://iotnxtinternal.commander.io/DAPI/v1/EdgeMonitorConfig/GetGatewayHealthThresholds

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

SetGatewayHealthThresholds

POST

Permission

commander_config.dynamic_config:set

Accessible

All. See response and accessiblity information for more

URL

https://iotnxtinternal.commander.io/DAPI/v1/EdgeMonitorConfig/SetGatewayHealthThresholds

URL Params

{
    "thresholds": "Dictionary<string>"
}

Data Params

{
 "thresholds": {
    "CPU": {
      "okay": {
        "min": 30,
        "max": 49
      },
      "warning": {
        "min": 49,
        "max": 60
      },
      "error": {
        "min": 60,
        "max": 90
      }
    } 
}
  • thresholds: Dictionary

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