Get discovery profile

This endpoint is used to retrieve discovery profile details for AWS, Azure, and Google.

Leave Feedback

URL

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

Sample URLs

For AWS:

https://{api-url}/api/v2/tenants/client_105261/policies/discovery/102183
https://{api-url}/api/v2/tenants/msp_52/policies/discovery/218

For Azure:

https://{api-url}/api/v2/tenants/client_105261/policies/discovery/102183
https://{api-url}/api/v2/tenants/msp_52/policies/discovery/218

For Google:

https://{api-url}/api/v2/tenants/client_105261/policies/discovery/963
https://{api-url}/api/v2/tenants/msp_526/policies/discovery/2098

Parameters

This field is mandatory (AWS and Google):

FieldData TypeDescription
discoveryProfileIdIntegerTZhe discovery profile Id.

Status code

200 OK

Sample response

For AWS:

{
	"id": 110,
	"name": "AWS discovery profile",
	"credentialSet": "AWS Integration",
	"credential": {
		"credentialName": "AWS Integration",
		"accountId": "290642135901"
	},
	"policy": {
		"id": 136,
		"name": "AWS discovery profile",
		"entityType": "ALL",
		"matchType": "ANY",
		"rules": [{
			"filterType": "ANY_CLOUD_RESOURCE"
		}],
		"actions": [{
				"action": "MANAGE DEVICE",
				"items": []
			},
			{
				"action": "STREAM AWS ALERTS",
				"items": [{
					"item": "https://cloudwatch-url",
					"parameters": {},
					"instances": {}
				}]
			}
		],
		"executionOrder": 0
	},
	"schedule": {
		"patternType": "HOURLY",
		"pattern": "2",
		"startTime": "02:00:00"
	}
}

For Azure:

[{
	"id": 102183,
	"name": "Azure",
	"credentialSet": "Azure Credentials",
	"credential": {
		"credentialName": "Azure Credentials",
		"accountId": "9ee6993f-a036-4118-9eab-c66d9fda1ef3"
	},
	"policy": {
		"id": 39733,
		"name": "Azure",
		"resourceType": "ALL",
		"matchType": "ANY",
		"rules": [{
				"filterType": "ANY_DEVICE"
			},
			{
				"filterType": "EBS"
			},
			{
				"filterType": "WEBSITE"
			},
			{
				"filterType": "SQL_SERVER"
			},
			{
				"filterType": "SQL_DATABASE"
			},
			{
				"filterType": "RESOURCE_GROUP"
			},
			{
				"filterType": "REDIS_CACHE"
			},
			{
				"filterType": "DOCUMENT_DB"
			}
		],
		"actions": [{
				"action": "MANAGE DEVICE",
				"items": []
			},
			{
				"action": "ASSIGN GATEWAY MANAGEMENT PROFILE",
				"items": [{
					"item": "24422",
					"parameters": {},
					"instances": {}
				}]
			},
			{
				"action": "INSTALL OPSRAMP AGENT",
				"items": [{
					"item": "169743",
					"parameters": {},
					"instances": {}
				}]
			},
			{
				"action": "SELECT GATEWAY",
				"items": [{
					"item": "24422",
					"parameters": {},
					"instances": {}
				}]
			}
		],
		"executionOrder": 0
	},
	"schedule": {
		"patternType": "MINUTES",
		"pattern": "30",
		"startTime": "00:30:00"
	}
}]

For Google:

{
	"id": 963,
	"name": "Google",
	"installedIntegrationId": "INTG-8abf482f-1423-18b7-4578-be47080aaa72",
	"credentialSet": "Google GOOGLEIntegration",
	"credential": {
		"credentialName": "Google GOOGLEIntegration",
		"accountId": "gce-integration"
	},
	"policy": {
		"id": 822,
		"name": "GOOGLE",
		"resourceType": "ALL",
		"matchType": "ANY",
		"rules": [{
			"id": 18821,
			"filterType": "ANY_CLOUD_RESOURCE"
		}],
		"actions": [{
			"action": "MANAGE DEVICE",
			"items": []
		}]
	},
	"schedule": {
		"patternType": "HOURLY",
		"pattern": "2",
		"startTime": "02:00:00"
	}
}