Get Interface Correlation Events (v2.0)

GET 
/v2.0/api/tenants/:tenant_id/sites/:site_id/elements/:element_id/interfaces/:interface_id/correlationevents

Get interface correlation events.

Request

Path Parameters

tenant_id stringrequired

ID of the tenant.

site_id stringrequired

The site ID.

element_id stringrequired

The element ID.

interface_id stringrequired

The interface ID.

Responses

200

Successful Operation

application/json

Schema

Schema

admin_up boolean

The interface admin state.

bound_interfaces string[]

The bound interfaces.

element_id string

The element ID.

events BaseEventState[]
The details of the 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 interface ID.

ipv4_addresses string[]

The IPv4 addresses configured for the interface.

name string

The name of the interface.

parent string

The parent interface.

site_wan_interface_ids string[]

The site WAN interface IDs.

type string

Possible values: [SERVICE_LINK, LOOPBACK, BYPASSPAIR, SUBINTERFACE, PPPOE, PORTCHANNEL, PORT, VIRTUAL_INTERFACE, CELLULAR]

The interface type.

used_for string

Possible values: [NONE, PUBLIC, PRIVATE, LAN, PRIVATE_L2, PRIVATE_WAN]

The value of where the interface is used.

Example (from schema)

{
  "admin_up": true,
  "bound_interfaces": [
    "string"
  ],
  "element_id": "string",
  "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",
  "ipv4_addresses": [
    "string"
  ],
  "name": "string",
  "parent": "string",
  "site_wan_interface_ids": [
    "string"
  ],
  "type": "SERVICE_LINK",
  "used_for": "NONE"
}

Loading...