Get an Event (v2.3)
GET/sdwan/v2.3/api/events/:event_id
Get a specific event.
Request
Path Parameters
event_id stringrequired
The event ID.
Responses
- 200
Successful Operation
- application/json
- Schema
- Example (from schema)
Schema
_created_on_utc date-time
The event created time and date.
_etag integer
The etag.
_status_code integer
The event status code.
_updated_on_utc date-time
The event updated time and date.
code string
The event code.
correlation_id string
The event correlation ID.
element_id string
The element ID.
entity_ref string
The event reference.
id string
info object
process_name string
notes string
The event notes.
policy_info object
The event policy information; time the policy was applied, policy rule ID, and policy set ID.
policy_applied_time date-time
policyrule_id string
policyset_id string
priority string
The event priority.
severity string
The event severity level.
site_id string
The site ID.
suppressed boolean
If the event is suppressed. Value = True/False.
suppressed_info object
Information on the suppressed event - event ID, suppressed time, summary event IDs etc.
event_ids string[]
other_reasons string[]
summary_event_ids string[]
suppressed_time date-time
time date-time
The time and date when the event occurred.
type string
The event type.
{
"_created_on_utc": "2024-07-29T15:51:28.071Z",
"_etag": 0,
"_status_code": 0,
"_updated_on_utc": "2024-07-29T15:51:28.071Z",
"code": "string",
"correlation_id": "string",
"element_id": "string",
"entity_ref": "string",
"id": "string",
"info": {
"process_name": "string"
},
"notes": "string",
"policy_info": {
"policy_applied_time": "2024-07-29T15:51:28.071Z",
"policyrule_id": "string",
"policyset_id": "string"
},
"priority": "string",
"severity": "string",
"site_id": "string",
"suppressed": true,
"suppressed_info": {
"event_ids": [
"string"
],
"other_reasons": [
"string"
],
"summary_event_ids": [
"string"
],
"suppressed_time": "2024-07-29T15:51:28.071Z"
},
"time": "2024-07-29T15:51:28.071Z",
"type": "string"
}
Loading...