Documentation is now available for the Fall 2020 Update release!

Search discovery profile

This endpoint is used to use a discovery profile name to search for a discovery profile in AWS, Azure, and Google.

Leave Feedback

URL

GET https://{api-url}/api/v2/tenants/{tenantId}/policies/discovery/search?name={discoveryprofilename}

Sample URLs

For AWS:

https://{api-url}/api/v2/tenants/client_105261/policies/discovery/search?name=discovery
https://{api-url}/api/v2/tenants/msp_61/policies/discovery/search?name=discovery

For Azure:

https://{api-url}/api/v2/tenants/client_106/policies/discovery/search?name=azure
https://{api-url}/api/v2/tenants/msp_10/policies/discovery/search?name=azure

For Google:

https://{api-url}/api/v2/tenants/client_100/policies/discovery/search?name=Google

Parameters

This field is mandatory:

FieldDefault Value
name={field}NA

NA indicates that the value is not applicable.

Status code

200 OK

Sample response

For AWS:

[{
	"id": 17,
	"name": "discovery",
	"credentialSet": "AWS Lab Testings",
	"credential": {
		"credentialName": "AWS Lab Testings",
		"accountId": "290642135904"
	},
	"policy": {
		"id": 354,
		"name": "discovery",
		"entityType": "ALL",
		"matchType": "ANY",
		"rules": [{
			"filterType": "ANY_CLOUD_RESOURCE"
		}],
		"actions": [{
				"action": "MANAGE DEVICE",
				"items": []
			},
		],
		"executionOrder": 0
	}
}]

For Azure:

[{
		"id": 102183,
		"name": "Azure",
		"credentialSet": "Azure Credentails",
		"credential": {
			"credentialName": "Azure Credentails",
			"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"
		}
	},
	{
		"id": 8751,
		"name": "Azure Lab discovery profile ",
		"credentialSet": "Azure Lab",
		"credential": {
			"credentialName": "Azure Lab",
			"accountId": "8ef6993f-a036-4118-4eab-d66d9fefr3e6"
		},
		"schedule": {
			"patternType": "MINUTES",
			"pattern": "30",
			"startTime": "00:30:00"
		}
	}
]

For Google:

[{
	"id": 419,
	"name": "Google Integration",
	"installedIntegrationId": "INTG-7bce592f-1343-54b7-4578-be47080aae54",
	"credentialSet": "Google Credentials",
	"credential": {
		"credentialName": "Google Credentials",
		"accountId": "GCE-integration"
	},
	"policy": {
		"id": 822,
		"name": "GOOGLE",
		"resourceType": "ALL",
		"matchType": "ANY",
		"rules": [{
			"id": 26836,
			"filterType": "ANY_CLOUD_RESOURCE"
		}],
		"actions": [{
			"action": "MANAGE DEVICE",
			"items": []
		}]
	},
	"schedule": {
		"patternType": "MINUTES",
		"pattern": "30",
		"startTime": "00:30:00"
	}
}