event_viewer¶
Overview¶
API to get events information from all discovered appliances in the network
Version information¶
Version : v2
URI scheme¶
Host :
BasePath : /sdwan/nitro/v2/fault/
Schemes : HTTP
Tags¶
- event_viewer : Operations related to event_viewer
Paths¶
Get operation for event_viewer¶
GET /event_viewer
Description¶
Use this operation to get events information from all discovered appliances in the network. The response payload also contains the meta_data block. Without using filters, events provided will be an empty list, Please use filter 'last_by' or 'start_at' and 'end_at' to get the events under specified time interval
Responses¶
| HTTP Code | Description | Schema |
|---|---|---|
| 200 | API Successfully executed | event_viewer_response_schema |
| 400 | Failed: bad input parameter | ErrorSchema |
| 401 | Unauthorized: Failed Authentication | ErrorSchema |
| 403 | Unauthorized: Forbidden | ErrorSchema |
| 405 | Failed: Data format unacceptable | ErrorSchema |
| 415 | Failed: Data format unacceptable | ErrorSchema |
| 500 | Failed: Internal Server Error | ErrorSchema |
Produces¶
application/json
Tags¶
- event_viewer
Definitions¶
ErrorSchema¶
| Name | Schema |
|---|---|
| errorcode optional |
integer |
| errormessage optional |
string |
appliance_id¶
Specifies whether the appliance from which the event originated is a primary (0) or secondary (1) appliance
Type : string
current_state¶
The state of object at the time of the event
Type : string
description¶
Text description of the event
Type : string
event_viewer_delete_success_schema¶
| Name | Schema |
|---|---|
| event_viewer optional |
event_viewer |
| Name | Description | Schema |
|---|---|---|
| message optional |
Example : "resource deleted succesfully" |
string |
event_viewer_post_success_schema¶
| Name | Schema |
|---|---|
| event_viewer optional |
event_viewer |
| Name | Description | Schema |
|---|---|---|
| message optional |
Example : "resource added succesfully" |
string |
event_viewer_put_success_schema¶
| Name | Schema |
|---|---|
| event_viewer optional |
event_viewer |
| Name | Description | Schema |
|---|---|---|
| message optional |
Example : "resource modified succesfully" |
string |
event_viewer_response_schema¶
Type : < event_viewer_response_schema > array
| Name | Schema |
|---|---|
| appliance_id optional |
appliance_id |
| current_state optional |
current_state |
| description optional |
description |
| object_name optional |
object_name |
| object_type optional |
object_type |
| previous_state optional |
previous_state |
| severity optional |
severity |
| site optional |
site |
| time optional |
time |
object_name¶
The name of object generating the event
Type : string
object_type¶
The type of object generating the event
Type : string
previous_state¶
The state of object before the event. The state will be listed as unknown if not applicable
Type : string
severity¶
The severity level of the event
Type : string
site¶
The site name on which the event originated
Type : string
time¶
The time when event was generated
Type : string