v1

latestOpenAPI 3.0.02026-07-243339471.1 MB

Events

List Events

This API endpoint retrieves a list of Network Events, based on the query parameters provided. Each Event in the returned list includes details like event name, category, source type, severity, etc. The query parameters allow you to narrow down the results that meet specific criteria, ensuring you receive only the relevant data.

get/network-troubleshooting/v1/events

Query parameters

Type of context (SITE, ACCESS_POINT, SWITCH, GATEWAY, WIRELESS_CLIENT, WIRED_CLIENT, BRIDGE).

context-identifierstring required

Context Identifier (site ID, device serial number or client MAC address).

start-atstring date-time required

Date-time in RFC 3339 format (ISO 8601) in UTC timezone with milliseconds.

Example:2025-08-06T12:34:56.124Z

Data is required starting from this timestamp, provided in RFC 3339 (and ISO 8601) format in the UTC timezone with milliseconds. The difference between end-at and start-at should be less than 30 days.

end-atstring date-time required

Date-time in RFC 3339 format (ISO 8601) in UTC timezone with milliseconds.

Example:2025-08-06T12:34:56.124Z

Data is required up to this timestamp, provided in RFC 3339 (and ISO 8601) format in the UTC timezone with milliseconds. The timestamp must be earlier than the current time and later than the start-at.

site-idstring required

Site ID to filter the event details for a specific site.

searchstring

Search events by name, serial number, host name, client MAC address or device MAC address. Full text search is not supported. Search is restricted to the metadata.

filterstring

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 below given table.

Field	Operators
eventId	eq and in
category	eq and in
sourceType	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.

sortstring

Sort expressions. A sort expression is a property name optionally followed by a direction indicator asc (ascending) or desc (descending).

If a direction indicator is omitted, the default direction is descending.

Supported fields are

Sort Field	Description
timeAt	The field timeAt denotes event timestamp.

nextstring

Specifies the pagination cursor for the next page of resources.

Example:1

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

limitinteger required

Example:100

Maximum number of events to be retrieved. Allowed range is 1 to 1000.

Response

Response schema for listing events

countinteger required

Number of events in current response.

totalinteger required

Total number of events matching the query criteria.

nextstring

Specifies the pagination cursor for the next page of resources.

Example response

{
  "events": [
    {
      "eventId": "55",
      "eventIdentifier": "c0975762-4662-463a-b35a-c0126f6ff052",
      "serialNumber": "CNW7DXQ123",
      "timeAt": "2025-08-06T12:34:56.124Z",
      "eventName": "Client 802.1x Radius Timeout",
      "category": "Connectivity",
      "sourceType": "Access Point",
      "sourceName": "AP-Floor1-001",
      "description": "Client authentication timeout occurred during 802.1x authentication process",
      "clientMacAddress": "aa:bb:cc:dd:ee:ff",
      "deviceMacAddress": "11:22:33:44:55:66",
      "stackId": "stack-001",
      "bssid": "aa:bb:cc:dd:ee:11",
      "reason": "Authentication timeout",
      "severity": "negative"
    }
  ],
  "count": 1,
  "total": 2,
  "next": "2"
}