Skip to main content

Get Site Correlation Events (v2.0)



Get site correlation events.


Path Parameters

    tenant_id stringrequired

    ID of the tenant.

    site_id stringrequired

    The site ID.


Successful Operation

    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


    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.


    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).