API Guide

Attribute name Description
AlertVarBindDetails List of variable bindings of the alert, if applicable.
AlertMessageType Type of message—Internal, SNMP, Redfish, and so on.
/api/AlertService/Alerts?
$filter=contains(UserName,'admin')
This URL represents alerts by username and role.
GET method for Alerts?$filter=contains(UserName,'admin')
This method returns alerts by username and role.
Description Returns alerts by username and role.
Privilege VIEW
HTTP response
code
200
Example response
body
{
"@odata.context": "/api/$metadata#Collection(AlertService.Alert)",
"@odata.count": 0,
"value":[
]
}
/api/AlertService/Alerts?$filter=StatusType eq 2000
This URL represents the alerts by status type.
GET method for Alerts?$filter=StatusType eq 2000
This method returns alerts by status type.
Description
Returns alerts by status type.
Privilege VIEW
HTTP response
code
200
Example response
body
{
"@odata.context": "/api/$metadata#Collection(AlertService.Alert)",
"@odata.count": 227,
"value":[
{
"@odata.type": "#AlertService.Alert",
"@odata.id": "/api/AlertService/Alerts(4592)",
"Id": 4592,
"SeverityType": 2,
"SeverityName": "Info",
"AlertDeviceId": 10056,
"AlertDeviceName": "Sled-5",
"AlertDeviceType": 1000,
"AlertDeviceIpAddress": "100.97.211.81",
"AlertDeviceMacAddress": "",
"AlertDeviceIdentifier": "96MF0T2",
"AlertDeviceAssetTag": "",
"DefinitionId": -25698976,
"CatalogName": "iDRAC",
"CategoryId": 2,
76 Alerts