Skip to main content
Contact Us

OpenManage Enterprise 3.10 RESTful API Guide

PDF

POST method for GetCorrelatedAlerts

This method lists correlated alerts.

Description
Lists the correlated alerts. If this is the first time the API is called, the value of 0 is passed (this signifies time t0) - at this point only the last 500 events are returned. Note that all events will be returned in between intervals (t0 - t1, t1 - t2 where t indicates the interval at which the task is running). The alert correlation internal task is normally turned off. If this task is turned off, the API will return a status code of 503 (Service Unavailable). If the task is on, the API will return a status code of 200 with accompanying alert data.
Privilege
VIEW
HTTP response codes
200
Example request body 
{
    "LastProcessedEventId" : "0"
}
Example response body 
 
            "value":
            {
                "LastProcessedEventId": 3,
                "ClearAlertsCount": 1,
                "NewAlertsCount": 1,
                "ClearAlerts": [
                    {
                        "Id": 3,
                        "ClearAlertId": 4,
                        "SeverityType": 2,
                        "SeverityName": "Info",
                        "AlertEntityId": 12345,
                        "AlertEntityName": "Server1",
                        "AlertEntityType": "Device",
                        "AlertDeviceId": 12345,
                        "AlertDeviceName": "Server1",
                        "AlertDeviceGroup": 0,
                        "AlertDeviceIpAddress": "10.10.10.10",
                        "AlertDeviceMacAddress": "00:00:5e:00:53:af",
                        "AlertDeviceIdentifier": "SVCTAG",
                        "AlertDeviceAssetTag": "SVC",
                        "AlertDeviceType": 1000,
                        "DefinitionId": 1009143,
                        "CatalogName": "SNMPv2-MIB",
                        "CategoryId": 1,
                        "CategoryName": "System Health",
                        "SubCategoryId": 7700,
                        "SubCategoryName": "Other",
                        "StatusType": 2000,
                        "StatusName": "Not-Acknowledged",
                        "TimeStamp": "2022-08-30 16:29:53.488",
                        "Message": "Original critical event alert message (similar to AlertService/Alerts API)",
                        "EemiMessage": "Clear event eemi message or detailed description just as we get in the AlertService/Alerts API response",
                        "RecommendedAction": "Recommended action of original alert",
                        "AlertMessageId": "MSG001",
                        "AlertVarBindDetails": "Original critical alert varbind details",
                        "AlertMessageType": "SNMP",
                        "MessageArgs": null,
                        "UserName": "testuser"
                    }
                ],
                "NewAlerts": [
                    {
                        "Id": 2,
                        "ClearAlertId": -1,
                        "SeverityType": 16,
                        "SeverityName": "Critical",
                        "AlertEntityId": 12345,
                        "AlertEntityName": "Server1",
                        "AlertEntityType": "Device",
                        "AlertDeviceId": 12345,
                        "AlertDeviceName": "Server1",
                        "AlertDeviceGroup": 0,
                        "AlertDeviceIpAddress": "10.10.10.10",
                        "AlertDeviceMacAddress": "00:00:5e:00:53:af",
                        "AlertDeviceIdentifier": "SVCTAG",
                        "AlertDeviceAssetTag": "SVC",
                        "AlertDeviceType": 1000,
                        "DefinitionId": 1009145,
                        "CatalogName": "SNMPv2-MIB",
                        "CategoryId": 1,
                        "CategoryName": "System Health",
                        "SubCategoryId": 7700,
                        "SubCategoryName": "Other",
                        "StatusType": 2000,
                        "StatusName": "Not-Acknowledged",
                        "TimeStamp": "2022-08-30 16:29:15.003",
                        "Message": "Critical alert message (similar to AlertService/Alerts API)",
                        "EemiMessage": "Critical alert EEMI message / detailed description of the messageId (similar to AlertService/Alerts API)",
                        "RecommendedAction": "Critical alert recommended action",
                        "AlertMessageId": "MSG002",
                        "AlertVarBindDetails": "Critical alert varbind details",
                        "AlertMessageType": "SNMP",
                        "MessageArgs": null,
                        "UserName": "testuser"
                    }

Rate this content

Accurate
Useful
Easy to understand
Was this article helpful?
0/3000 characters
  Please provide ratings (1-5 stars).
  Please provide ratings (1-5 stars).
  Please provide ratings (1-5 stars).
  Please select whether the article was helpful or not.
  Comments cannot contain these special characters: <>()\