Get WAN Interface Correlation Events (v2.0)

GET 
/sdwan/v2.0/api/sites/:site_id/waninterfaces/:wan_interface_id/correlationevents

Get wan interface correlation events.

Request

Path Parameters

site_id stringrequired

The site ID.

wan_interface_id stringrequired

The wan interface ID.

Responses

200

Successful Operation

application/json

Schema

Schema

events BaseEventState[]
The details of the WAN events occurred.
Array [
event_code string
The event code.
event_id string
The event ID.
id string
Id
priority int32
The priority set for the event.
standing boolean
The standing event. True or False.
suppressed boolean
The events are suppressed. True or False.
suppressed_info SuppressedInfo
The information on the suppressed events.
root_cause_event_ids string[]
The event IDs of the root causes.
suppressed_time date
The suppressed event time.
timestamp int64
The time stamp of the event.
]
id string

The WAN interface ID.

name string

The name of the WAN interface.

network_id string

The network ID.

type string

Possible values: [PUBLIC_WAN, PRIVATE_WAN]

The WAN interface type.

Example (from schema)

{
  "events": [
    {
      "event_code": "string",
      "event_id": "string",
      "id": "string",
      "priority": 0,
      "standing": true,
      "suppressed": true,
      "suppressed_info": {
        "root_cause_event_ids": [
          "string"
        ],
        "suppressed_time": "2024-07-29"
      },
      "timestamp": 0
    }
  ],
  "id": "string",
  "name": "string",
  "network_id": "string",
  "type": "PUBLIC_WAN"
}

Loading...