GET /events/activeAlerts/status/{uuid}
Use this method to return the alert status, as defined by highest severity of active alerts, for a specific managed device. 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/{uuid}
where {uuid} is the unique ID of the managed device to be retrieved. To obtain the device UUID, use the inventory GET methods (for example, GET /nodes/{uuid_list} or GET /chassis).
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 for the specified device:
GET https://192.0.2.0/events/activeAlerts/status/
EA35F98A144E11E2BA81864E72900ECC?type=excluded
Request body
None
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 | Source 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" : "56781234891012345678",
"eventClass" : 800,
"sourceID" : "12345678912134568764",
"status": 100
}]
Give documentation feedback