Sign in

v1

latestOpenAPI 3.0.02026-07-243339471.1 MB
Alert Configurations

List alert configurations

Retrieves alert configurations for a given scope. Each configuration defines the threshold rules, severity mappings, and settings for a specific alert type. Configurations may be locally defined or inherited from a parent scope.

Scope types:

ValueDescription
GLOBALTenant-level scope (default)
SITESite-level scope
DEVICEDevice-level scope

Pagination:

Use limit and next together to page through large result sets. When limit is supplied the response includes total (total available configurations) and offset (zero-based index of the first item returned), enabling clients to determine whether additional pages exist.

get/network-notifications/v1/alert-config

Query parameters

scope-idstring required
Example:1021882040

The scope identifier for which alert configurations are retrieved.

scope-type'GLOBAL' | 'SITE' | 'DEVICE'
Example:SITE

The scope type. Determines the level at which the configuration applies.

ValueDescription
GLOBALTenant-level scope (default)
SITESite-level scope
DEVICEDevice-level scope
limitinteger
Example:20

Maximum number of alert configurations to return per page. Defaults to 20 when not specified.

nextinteger

Zero-based offset of the first alert configuration to return. Use together with limit to paginate through results. Defaults to 0 when not specified.

Response

List of alert configurations for the requested scope.

idstring required

Unique identifier for this collection resource.

typestring required

Resource type identifier.

countinteger required

Number of alert configurations returned in the current page.

totalinteger

Total number of alert configurations available across all pages. Present only when the request includes a limit parameter.

offsetinteger

Zero-based index of the first item returned in this page. Present only when the request includes a limit parameter.

Example response

{
  "count": 2,
  "total": 99,
  "offset": 0,
  "items": [
    {
      "name": "AP CPU Utilization",
      "description": "Triggers when access point CPU usage exceeds configured thresholds.",
      "label": "CPU",
      "category": "System",
      "deviceType": "Access Point",
      "enabled": true,
      "ruleSource": "USER",
      "clearTimeout": "1H",
      "inherited": false,
      "scopeId": "1021882040",
      "scopeType": "GLOBAL",
      "rules": [
        {
          "ruleNumber": 0,
          "rule": {
            "duration": 5,
            "metric": "cpu_utilization",
            "condition": [
              {
                "severity": "CRITICAL",
                "expression": {
                  "metric": "cpu_utilization",
                  "operator": "GTE",
                  "valueNumber": 90
                }
              },
              {
                "severity": "MAJOR",
                "expression": {
                  "metric": "cpu_utilization",
                  "operator": "GTE",
                  "valueNumber": 80
                }
              },
              {
                "severity": "MINOR",
                "expression": {
                  "metric": "cpu_utilization",
                  "operator": "GTE",
                  "valueNumber": 70
                }
              }
            ],
            "additionalCondition": []
          }
        }
      ]
    },
    {
      "name": "Switch CPU Utilization",
      "description": "Triggers when switch CPU usage exceeds configured thresholds.",
      "label": "CPU",
      "category": "System",
      "deviceType": "Switch",
      "enabled": true,
      "ruleSource": "SYSTEM",
      "clearTimeout": null,
      "inherited": false,
      "scopeId": "1021882040",
      "scopeType": "GLOBAL",
      "rules": []
    }
  ]
}