Endpoint
/api/v2/tenants/{tenantId}/deviceGroups
Path Parameters
tenantIdstring
createdDatestring
entityTypestring
Type of resources in a group. Example: DEVICE_GROUP, SNS
filterCriteriaobject
Child Parameters
- filterCriteria.actions
- filterCriteria.executionOrder
- filterCriteria.id
- filterCriteria.matchType
- (Optional) The type of match: -To match all the filter conditions, provide matchType: ALL. - To match any one of the filter conditions, provide matchType: ANY.
- filterCriteria.name
- Name of the policy.
- filterCriteria.resourceType
- Type of resource. Example: DEVICE, VOLUME, VPN, XENSERVER
- filterCriteria.rules
- (Optional) Filter devices with specific attributes: - Attribute name of device. Example: Name, Operating System. Attribute names change with device types. - Matching parameter. Supported operators are: Equals, Contains, Not Contains, Starts with, Ends with, Regex. Learn more about Regex. - Type of resource
idstring
kbArticlesIdsarray
(Optional) Assign knowledge base articles to a device group. To fetch a knowledge base article ID: 1. Log into OpsRamp. 2. Click Knowledge Base. 3. Select the required article and then copy the article ID without #. 4. Provide the article ID in kbArticleIds field.Example: "kbArticleIds": [22089]
Child Parameters
namestring
Unique name for the device group. The device group is identified with this name.
parentobject
Add a device group as child under an existing device group (parent). This field is mandatory while adding a child device group to parent device group.
Child Parameters
- parent.id
updatedDatestring
[
{
"description": "Communications server in SJ",
"entityType": "DEVICE_GROUP",
"kbArticlesIds": [
20123
],
"name": "Communications Server",
"parent": {
"id": "DGP-a20e13ad-e98f-416e-a9dd-40158ffdb2af"
}
},
{
"description": "Print Servers in SJ",
"entityType": "DEVICE_GROUP",
"filterCriteria": {
"matchType": "ALL",
"rules": [
{
"key": "Name",
"operator": "Contains",
"resourceType": "DEVICE",
"value": "Luminax"
},
{
"key": "Region Name",
"operator": "Contains",
"resourceType": "DEVICE",
"value": "SJ"
}
]
},
"kbArticlesIds": [
20122
],
"name": "Print Servers",
"parent": {
"id": "DGP-a20e13ad-e98f-416e-a9dd-40158ffdb2af"
}
}
]
[
{
"entityType": "DEVICE_GROUP",
"kbArticlesIds": [
10897
],
"name": "Storage Device Group"
},
{
"entityType": "DEVICE_GROUP",
"filterCriteria": {
"matchType": "ANY",
"rules": [
{
"key": "Name",
"operator": "Contains",
"resourceType": "DEVICE",
"value": "Switch"
},
{
"key": "Topic Name",
"operator": "Contains",
"resourceType": "SNS",
"value": "sns"
}
]
},
"name": "Warehouse Device Group"
}
]
[
{
"description": "Network Devices in SJ Office",
"entityType": "DEVICE_GROUP",
"id": "DGP-a20e13ad-e98f-416e-a9dd-40158ffdb2af",
"kbArticlesIds": [
10897
],
"name": "Network Device Groups"
}
]
Responses
OK
[
{
"createdDate": "2017-08-10T07:40:55+0000",
"description": "Communications Server in SJ",
"entityType": "DEVICE_GROUP",
"id": "DGP-1d021aca-f360-4c14-967c-892296b7d4f5",
"kbArticlesIds": [
20123
],
"name": "Commincations Server",
"updatedDate": "2017-08-10T07:40:55+0000"
},
{
"createdDate": "2017-08-10T07:40:55+0000",
"description": "Print Servers in SJ",
"entityType": "DEVICE_GROUP",
"filterCriteria": {
"matchType": "ALL",
"rules": [
{
"key": "Name",
"operator": "Contains",
"resourceType": "DEVICE",
"value": "Luminax"
},
{
"key": "Region Name",
"operator": "Contains",
"resourceType": "DEVICE",
"value": "SJ"
}
]
},
"id": "DGP-c87c9dd5-b7fe-498d-a242-338683e745b4",
"kbArticlesIds": [
20122
],
"name": "Print Servers",
"updatedDate": "2017-08-10T07:40:55+0000"
}
]
[
{
"createdDate": "2017-08-10T07:28:47+0000",
"entityType": "DEVICE_GROUP",
"id": "DGP-a20e13ad-e98f-416e-a9dd-40158ffdb2af",
"kbArticlesIds": [
10897
],
"name": "Storage Device Group",
"updatedDate": "2017-08-10T07:28:47+0000"
},
{
"createdDate": "2017-11-14T06:20:09+0000",
"entityType": "DEVICE_GROUP",
"filterCriteria": {
"matchType": "ANY",
"rules": [
{
"key": "Name",
"operator": "Contains",
"resourceType": "DEVICE",
"value": "Switch"
},
{
"key": "Topic Name",
"operator": "Contains",
"resourceType": "SNS",
"value": "sns"
}
]
},
"id": "DGP-0cd9cf8e-bb6b-42ac-b438-1c005679f543",
"name": "Warehouse Device Group",
"updatedDate": "2017-11-14T06:20:09+0000"
}
]
[
{
"description": "Network Device Groups in SJ Site",
"entityType": "DEVICE_GROUP",
"id": "DGP-a20e13ad-e98f-416e-a9dd-40158ffdb2af",
"kbArticlesIds": [
10897
],
"name": "Network Device Groups"
}
]