Get Site Correlation Events (v2.0)

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

Get site correlation events.

Request

Path Parameters

tenant_id stringrequired

ID of the tenant.

site_id stringrequired

The site ID.

Responses

200

Successful Operation

application/json

Schema

Schema

address Address

The address of the site where the event occurred.

city string

The name of the city. Max size = 100.

country string

The name of the country. Max size = 100.

post_code string

The postal code. Max size = 100.

state string

The name of the state. Max size = 100.

street string

The name of the street. Max size = 100.

street2 string

The name of the street. Max size = 100.

admin_state string

The site mode of operation, can be in one of three states: Active - the site is in Control mode and network policy is applied. Monitor - the site is in Analytics mode, no network policy is applied. Disabled: the site is disabled.

element_cluster_role string

This attribute describes the type i.e. SPOKE or HUB.

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

location Location

The geographical cordinates for the site address.

description

The decsription of the location.

latitude float

The latitude of the location. Max range = 90.

longitude float

The longitude of the location. Max range = 180.

name string

The site name (Max size = 128).

Example (from schema)

{
  "address": {
    "city": "string",
    "country": "string",
    "post_code": "string",
    "state": "string",
    "street": "string",
    "street2": "string"
  },
  "admin_state": "string",
  "element_cluster_role": "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-05-06"
      },
      "timestamp": 0
    }
  ],
  "id": "string",
  "location": {
    "latitude": 0,
    "longitude": 0
  },
  "name": "string"
}

Loading...