Get alert correlation policy

This endpoint is used to retrieve the details of an alert correlation policy.

Leave Feedback

URL

GET https://{api-url}/api/v2/tenants/{tenantId}/policies/alertCorrelation/{policyId}

Sample URLs

https://api.opsramp.com/api/v2/tenants/client_7/policies/alertCorrelation/POLICY-AC-3218d82f-25c6-4d4d-bd88-b83c5e30721c
https://api.opsramp.com/api/v2/tenants/msp_6/policies/alertCorrelation/POLICY-AC-ce200249-bcb0-47ef-8b24-9b5744053243

Sample responses

This is a response from an alert correlation policy with a dependency correlation:

{
	"id": "POLICY-AC-165c4ee5-8b31-4cba-b88e-f20e57ae8358",
	"name": "Correlate alerts on Hypervisor",
	"enabled": false,
	"precedence": 25,
	"filterCriteria": {
		"filterBased": true,
		"matchingType": "ALL",
		"rules": [{
			"filterType": "nativeAttributes",
			"entityName": "host_name",
			"operator": "Contains",
			"entityValue": "vm"
		}, {
			"filterType": "customAttributes",
			"entityName": "Root_Device",
			"operator": "Starts with",
			"entityValue": "ESX"
		}]
	},
        "type": "DEPENDENCY"
	"dependencyCorrelation": {
		"alertsTimeWindow": 15,
		"upstreamMetrics": ["system.process.cpu", "system.ping.pl"],
		"downstreamMetrics": ["system.memory.utilization", "system.ping.rta"]
	},
	"createdBy": {
		"loginName": "John_Smith",
		"lastName": "Smith",
		"firstName": "John",
		"email": "john.smith@myorganization.com"
	},
	"updatedBy": {
		"loginName": "John_Smith",
		"lastName": "Smith",
		"firstName": "John",
		"email": "john.smith@myorganization.com"
	},
	"createdTime": "2018-03-27T13:14:07+0000",
	"updatedTime": "2018-04-10T14:22:10+0000"
}

This is a response from an alert correlation policy with algorithm-based correlation:

{
	"id": "POLICY-AC-7556bcf6-4cc2-44ba-ba1f-3ca5a211bcb3",
	"name": "Correlate alerts on network outage",
	"enabled": false,
	"precedence": 29,
	"filterCriteria": {
		"filterBased": true,
		"matchingType": "ALL",
		"rules": [{
			"filterType": "nativeAttributes",
			"entityName": "ip_address",
			"operator": "Contains",
			"entityValue": "162.11"
		}, {
			"filterType": "customAttributes",
			"entityName": "device_location",
			"operator": "Contains",
			"entityValue": "West"
		}]
	},
        "type": "ALGORITHM"
	"algorithmCorrelation": {
		"alertsTimeWindow": 20,
		"matchingConditions": [{
			"property": "subject",
			"matchType": "Identical"
		}, {
			"property": "ip_address",
			"matchType": "Nearly Identical"
		}],
		"primaryAlertSubject": "Network outage on Switch 162 "
	},
	"createdBy": {
		"loginName": "John_Smith",
		"lastName": "Smith",
		"firstName": "John",
		"email": "john.smith@myorganization.com"
	},
	"updatedBy": {
		"loginName": "John_Smith",
		"lastName": "Smith",
		"firstName": "John",
		"email": "john.smith@myorganization.com"
	},
	"createdTime": "2018-03-27T13:14:07+0000",
	"updatedTime": "2018-04-10T14:22:11+0000"
}

This is a response from an alert correlation policy with cooccurrence-based correlation:

{
	"id": "POLICY-AC-1556bcf6-7cc2-44ba-ba1f-8ca5a211bcb3",
	"name": "Server SJ-Alerts",
	"enabled": false,
	"precedence": 30,
	"filterCriteria": {
		"filterBased": true,
		"matchingType": "ALL",
		"rules": [{
			"filterType": "nativeAttributes",
			"entityName": "host_name",
			"operator": "Contains",
			"entityValue": "Logix"
		}, {
			"filterType": "customAttributes",
			"entityName": "agent_status",
			"operator": "Equals",
			"entityValue": "up"
		}]
	},
	"type": "CO_OCCURRENCE",
        "machineLearning": {
                "trainingFileId": "ml_alert_correlation_training_client_9",
                "continuousLearning": false
              },
	"createdBy": {
		"loginName": "opsramp_api_user",
		"lastName": " ",
		"firstName": "OpsRamp API User",
		"email": "john.smith@myorganization.com"
	},
	"updatedBy": {
		"loginName": "opsramp_api_user",
		"lastName": " ",
		"firstName": "OpsRamp API User",
		"email": "john.smith@myorganization.com"
	},
	"createdTime": "2018-08-27T13:14:07+0000",
	"updatedTime": "2018-09-12T10:22:11+0000"
}

This response is from the client scope partner correlated with Algorithm and ALL based upon organizationMatchingType:

{
     "id" : "POLICY-AC-7556bcf6-4cc2-44ba-ba1f-3ca5a211bcb3",
     "name" : "test_algorithm_correlation_ap",
     "clientsIncluded" : "ALL",
     "enabled" : true,
     "precedence" : 29,
     "filterCriteria" : {
         "filterBased" : true,
         "matchingType" : "ALL",
         "rules" : [ {
            "filterType" : "nativeAttributes",
            "entityName" : "host_name",
            "operator" : "Contains",
            "entityValue" : "vm"
          }, {
            "filterType" : "customAttributes",
            "entityName" : "test_cutom_attribute",
            "operator" : "Not Contains",
            "entityValue" : "a"
          } ]
     },
  "type":"ALGORITHM",
  "algorithmCorrelation" : {
    "alertsTimeWindow" : 20,
    "matchingConditions" : [ {
      "property" : "subject",
      "matchType" : "Identical"
    }, {
      "property" : "alert_metric",
      "matchType" : "Identical"
    } ],
    "primaryAlertSubject" : "subject-alertMetric policy"
  },
  "createdBy" : {
    "loginName" : "opsramp_api_user",
    "lastName" : " ",
    "firstName" : "OpsRamp API User",
    "email" : "admin@opsramp.com"
  },
  "createdTime" : "2017-11-27T13:14:07+0000",
  "updatedTime" : ""
}
}

This response is from the client scope partner correlated with Algorithm and INCLUDE based upon organizationMatchingType:

{
  "id" : "POLICY-AC-7556bcf6-4cc2-44ba-ba1f-3ca5a211bcb3",
  "name" : "test_algorithm_correlation_ap",
  "includedClients":[
      "client_8",
      "client_9"],
  "enabled" : true,
  "precedence" : 29,
  "filterCriteria" : {
    "filterBased" : true,
    "matchingType" : "ALL",
    "rules" : [ {
      "filterType" : "nativeAttributes",
      "entityName" : "host_name",
      "operator" : "Contains",
      "entityValue" : "vm"
    }, {
      "filterType" : "customAttributes",
      "entityName" : "test_cutom_attribute",
      "operator" : "Not Contains",
      "entityValue" : "a"
    } ]
  },
  "type":"ALGORITHM",
  "algorithmCorrelation" : {
    "alertsTimeWindow" : 20,
    "matchingConditions" : [ {
      "property" : "subject",
      "matchType" : "Identical"
    }, {
      "property" : "alert_metric",
      "matchType" : "Identical"
    } ],
    "primaryAlertSubject" : "subject-alertMetric policy"
  },
  "createdBy" : {
    "loginName" : "opsramp_api_user",
    "lastName" : " ",
    "firstName" : "OpsRamp API User",
    "email" : "admin@opsramp.com"
  },
  "createdTime" : "2017-11-27T13:14:07+0000",
  "updatedTime" : ""
}