events¶
Overview¶
API to get reports for Events (bandwidth is in Kbps and data is in KB)
Version information¶
Version : v2
URI scheme¶
Host :
BasePath : /sdwan/nitro/v2/reports/
Schemes : HTTP
Tags¶
- events : Operations related to events
Paths¶
Get operation for events¶
GET /events
Description¶
Use this operation to get a report for Events. The response payload also contains the meta_data block.
Responses¶
| HTTP Code | Description | Schema |
|---|---|---|
| 200 | API Successfully executed | events_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¶
- events
Definitions¶
ErrorSchema¶
| Name | Schema |
|---|---|
| errorcode optional |
integer |
| errormessage optional |
string |
alert_events¶
The number of alert events that have occured
Type : integer
critical_events¶
The number of critical events that have occured
Type : integer
debug_events¶
The number of debugging events that have occured
Type : string
emergency_events¶
The number of emergency events that have occured
Type : integer
error_events¶
The number of error events that have occured
Type : integer
events_delete_success_schema¶
| Name | Schema |
|---|---|
| events optional |
events |
| Name | Description | Schema |
|---|---|---|
| message optional |
Example : "resource deleted succesfully" |
string |
events_post_success_schema¶
| Name | Schema |
|---|---|
| events optional |
events |
| Name | Description | Schema |
|---|---|---|
| message optional |
Example : "resource added succesfully" |
string |
events_put_success_schema¶
| Name | Schema |
|---|---|
| events optional |
events |
| Name | Description | Schema |
|---|---|---|
| message optional |
Example : "resource modified succesfully" |
string |
events_response_schema¶
Type : < events_response_schema > array
| Name | Schema |
|---|---|
| alert_events optional |
alert_events |
| critical_events optional |
critical_events |
| debug_events optional |
debug_events |
| emergency_events optional |
emergency_events |
| error_events optional |
error_events |
| info_events optional |
info_events |
| notice_events optional |
notice_events |
| region_name optional |
region_name |
| warning_events optional |
warning_events |
info_events¶
The number of informational events that have occured
Type : string
notice_events¶
The number of notice events that have occured
Type : string
region_name¶
The region name
Type : string
warning_events¶
The number of warning events that have occured
Type : integer