Documentation is now available for the Fall 2020 Update release!

Get device group

This endpoint is used to fetch the details of a device group.

Leave Feedback

URL

GET https://{api-url}/api/v2/tenants/{tenantId}/deviceGroups/{deviceGroupId}

Sample URLs

https://{api-url}/api/v2/tenants/client_10/deviceGroups/DGP-1c31a30a-95e9-4b5d-809b-ff3a193c8001

Status code

200 OK

Sample response

A sample response showing minimal information of a device group without policy:

{
	"id": "DGP-1c31a30a-95e9-4b5d-809b-ff3a193c8001",
	"name": "Network Devices",
	"createdDate": "2017-08-08T12:16:26+0000",
	"updatedDate": "2017-08-08T12:16:26+0000",
	"type": "DEVICE_GROUP"
}

A sample response showing detailed information of a device group with policy having filter criteria and parent devices:

{
	"id": "DGP-1c31a30a-95e9-4b5d-809b-ff3a193c8001",
	"name": "LAP Storage Devices",
	"description": "",
	"createdDate": "2017-08-08T12:16:26+0000",
	"updatedDate": "2017-11-14T06:20:09+0000",
	"type": "DEVICE_GROUP",
	"parent": {
		"id": "DGP-a215ea93-d824-46a6-b434-9c59ceaca7bc",
		"name": "Storage",
		"type": "DEVICE_GROUP",
                "resourceType": "DEVICE_GROUP"
	},
	"filterCriteria": {
                "id": 1319,
		"matchType": "ALL",
		"rules": [{
				"id": 214,
                "key": "Name",
				"operator": "Contains",
				"value": "172.31.23",
				"resourceType": "DEVICE"
			},
			{
				"key": "Site Name",
				"operator": "Contains",
				"value": "US-WA",
				"resourceType": "DEVICE"
			}
		]
	},
            "entityType": "DEVICE_GROUP"
}