v1

latestOpenAPI 3.0.02026-07-243339471.1 MB

Alerts

List all alerts

This API endpoint retrieves the list of Alerts based on the query parameters provided. The alerts list includes details such as name, type, category, severity, status, etc. The query parameters allow you to filter results that meet specific criteria, ensuring you receive only relevant data.

get/network-notifications/v1/alerts

Query parameters

filterstring

Example:typeId in ('102', '4') and siteId eq '1234567'

OData Version 4.0 filter string (limited functionality). Supports only 'and' conjunction ('or' and 'not' are NOT supported). Supported fields and operators are in the table below.

Field	Operators
siteId	eq and in
typeId	eq and in
status	eq and in
category	eq and in
deviceType	eq and in

The operators are implemented as follows:

eq: Only values exactly matching the given value are returned.
in: Only values present in the given list are returned.

List of applicable filters for field and terms:

Field	Applicable Terms
siteId	string
typeId	string
status	["Active", "Deferred", "Cleared"]
deviceType	["Access Point", "Gateway", "Switch", "Bridge", "Access Point, Switch", "Switch, Switch"]
category	["Clients", "System", "LAN", "WLAN", "WAN", "Cluster", "Routing", "Security"]

sortstring const

Example:status asc

Sort field followed by a direction indicator ASC (ascending) or DESC (descending). Supported fields are createdAt,severity,status,name,priority. createdAt field is used by default.

nextstring

Example:1

Specifies the pagination cursor for the next page of resources. Minimum value is 1.

limitinteger

Maximum number of alerts to be retrieved. Allowed range is 1 to 100.

Response

List of alerts, along with alert details and associated pagination information.

countinteger

Number of alerts returned in the current response.

totalinteger

Total number of alerts matching the query criteria.

nextstring

Specifies the pagination cursor for the next page of resources. Null if there are no further pages.

Example response

{
  "count": 2,
  "next": "2",
  "items": [
    {
      "updatedBy": null,
      "status": "Cleared",
      "category": "System",
      "key": "ad4c9f5b-25d2-37f9-a4ed-fc0e6b0f5825",
      "severity": "Critical",
      "clearedReason": null,
      "deviceType": "Access Point",
      "type": "network-notifications/alerts",
      "priority": "Very High",
      "id": "22071893000:47765082406",
      "createdAt": "2025-12-10T07:04:33.352Z",
      "updatedAt": "2025-12-10T08:37:02.475Z",
      "name": "Insufficient PoE Received",
      "summary": "AP LUHR000001 did not receive the requested PoE power which may limit its functions."
    },
    {
      "updatedBy": null,
      "status": "Active",
      "category": "System",
      "key": "ad4c9f5b-25d2-37f9-a4ed-fc0e6b0f5825",
      "severity": "Minor",
      "clearedReason": null,
      "deviceType": "Access Point",
      "type": "network-notifications/alerts",
      "priority": "Medium",
      "id": "22071893000:47764775046",
      "createdAt": "2025-12-10T08:31:36.710Z",
      "updatedAt": "",
      "name": "USB Device Removed from AP",
      "summary": "A USB device was removed from the AP LUHR000012's USB port."
    }
  ],
  "total": 85
}