Get Element Events (v2.0)

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

Get element events.

Request

Path Parameters

tenant_id stringrequired

ID of the tenant.

site_id stringrequired

The site ID.

element_id stringrequired

The element ID.

Responses

200

Successful Operation

application/json

Schema

Schema

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 element ID.

name string

The name of the element.

role string

Possible values: [NONE, HUB, SPOKE, PA_WE_BR, PA_WE_DC, PA_CONN]

The element role.

spoke_cluster_status string

Possible values: [init, active, backup, unknown]

The spoke cluster status.

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",
  "role": "NONE",
  "spoke_cluster_status": "init"
}

Loading...