GET /events/activeAlerts/status
Use this method to return the alert status, as defined by highest severity of active alerts, for all managed devices. If no query parameters are specified, all active alerts are returned.
Authentication
Authentication with username and password is required.
Request URL
GET https://{management_server_IP}/events/activeAlerts/status
Query parameters
| Parameters | Required / Optional | Description |
|---|---|---|
| filterWith={filter} | Optional | Returns only the active alerts that apply to the specified filters (see Filtering events) |
| type=excluded | Optional | Returns only exclude active alerts |
The following example returns the alert status for all excluded active alerts:
GET https://192.0.2.0/events/activeAlerts/status?type=excluded
Response codes
| Code | Description | Comments |
|---|---|---|
| 200 | OK | The request completed successfully. |
| 400 | Bad Request | A query parameter or request attribute is missing or not valid, or the operation is not supported. A descriptive error message is returned in the response body. |
| 401 | Unauthorized | The user cannot be authenticated. Authentication has not been provided or has failed. A descriptive error message is returned in the response body. |
| 404 | Not found | A specified resource cannot be found. A descriptive error message is returned in the response body. |
| 500 | Internal Server Error | An internal error occurred. A descriptive error message is returned in the response body. |
Response body
| Attributes | Type | Description |
|---|---|---|
| componentID | String | Component ID |
| eventClass | String | Surce of the event. This can be one of the following values.
|
| sourceID | String | System UUID for the system or device that is/was the event source (raiser/owner) |
| status | Integer | Status of the event. This can be one of the following values.
|
The following example is returned if the request is successful.
[{
"componentID": "DUMMYFFB657408BEB41610101030203020000",
"eventClass": 50,
"sourceID": "FFB657408BEB4161950704AB0ED3A84A",
"status": 600
},
...,
{
"componentID": "E81E37592C6911E18AC4C4B91C9FD1E6",
"eventClass": 50,
"sourceID": "FFB657408BEB4161950704AB0ED3A84A",
"status": 300
}]
Give documentation feedback