Documentation is now available for the Fall 2020 Update release!

Get alert correlation policies of a client

This endpoint is used to fetch alert correlation policies of a client.

Leave Feedback

URL

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

Sample URLs

https://{api-url}/api/v2/tenants/client_4/policies/alertCorrelation/
https://{api-url}/api/v2/tenants/client_4/policies/alertCorrelation/?pageNo=1&pageSize=100
https://api.opsramp.com/api/v2/tenants/msp_3/policies/alertCorrelation/

Parameters

FieldDefault Value
pageNo={pageNo}1
pageSize={pageSize}100

Status code

200 OK

Sample response 1 - View alert correlation policies of client-4

This sample gets alert correlation policies for client-4.

Sample request URL

https://api.opsramp.com/api/v2/tenants/client_4/policies/alertCorrelation/

Sample response

{
	"results": [
		{
			"id": "POLICY-AC-7556bcf6-4cc2-44ba-ba1f-3ca5a211bcb3",
			"name": "test_algorithm_correlation_ap",
			"enabled": true,
			"precedence": 29,
			"type":"ALGORITHM"
		},
		{
			"id": "POLICY-AC-1556bcf6-7cc2-44ba-ba1f-8ca5a211bcb3",
			"name": "test_co-occurrence_correlation_ap",
			"enabled": true,
			"precedence": 30,
			"type":"CO_OCCURRENCE",
			"machineLearning": {
                "accuracy": 98
            }
		}
	],
	"totalResults": 2,
	"orderBy": "precedence",
	"pageNo": 1,
	"pageSize": 100,
	"totalPages": 1,
	"nextPage": false,
	"previousPageNo": 0,
	"descendingOrder": false
}

Sample response 2 - View alert correlation policies of client-4

This sample gets alert correlation policies for client-4 with pageNo and pageSize specified.

Sample request URL

https://api.opsramp.com/api/v2/tenants/client_4/policies/alertCorrelation/?pageNo=1&pageSize=10

Sample response

{
	"results": [
		{
			"id": "POLICY-AC-7556bcf6-4cc2-44ba-ba1f-3ca5a211bcb3",
			"name": "test_algorithm_correlation_ap",
			"enabled": true,
			"precedence": 29,
			"type":"ALGORITHM"
		},
		{
			"id": "POLICY-AC-1556bcf6-7cc2-44ba-ba1f-8ca5a211bcb3",
			"name": "test_co-occurrence_correlation_ap",
			"enabled": true,
			"precedence": 30,
			"type":"CO_OCCURRENCE"
		}
	],
	"totalResults": 2,
	"orderBy": "precedence",
	"pageNo": 1,
	"pageSize": 10,
	"totalPages": 1,
	"nextPage": false,
	"previousPageNo": 0,
	"descendingOrder": false
}

Sample 3 - View alert correlation policies of msp-3

This sample gets alert correlation policies for msp-3.

Sample request URL

https://api.opsramp.com/api/v2/tenants/msp_3/policies/alertCorrelation/

Sample response

{
	"results": [
		{
			"id": "POLICY-AC-7556bcf6-4cc2-44ba-ba1f-3ca5a211bcb3",
			"name": "test_algorithm_correlation_ap",
			"enabled": true,
			"precedence": 29,
			"type":"ALGORITHM"
		},
		{
			"id": "POLICY-AC-1556bcf6-7cc2-44ba-ba1f-8ca5a211bcb3",
			"name": "test_co-occurrence_correlation_ap",
			"enabled": true,
			"precedence": 30,
			"type":"CO_OCCURRENCE",
			"machineLearning": {
                "accuracy": 98
            }
		}
	],
	"totalResults": 2,
	"orderBy": "precedence",
	"pageNo": 1,
	"pageSize": 100,
	"totalPages": 1,
	"nextPage": false,
	"previousPageNo": 0,
	"descendingOrder": false
}