Endpoint
/api/v2/tenants/{tenantId}/deviceGroups/{deviceGroupId}
Deletes a device group.
Notes
- Deleting a device group indicates removing the device group name and details.
- Resources under a deleted device group are retained and available in infrastructure APIs.
- Deleting a parent device group deletes child device groups.
Path Parameters
tenantIdstring
deviceGroupIdstring
Responses
OK
Endpoint
/api/v2/tenants/{tenantId}/deviceGroups/{deviceGroupId}
Gets the details of a device group.
Path Parameters
tenantIdstring
deviceGroupIdstring
Responses
OK
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
{
"createdDate": "2017-08-08T12:16:26+0000",
"description": "",
"entityType": "DEVICE_GROUP",
"filterCriteria": {
"id": 1319,
"matchType": "ALL",
"rules": [
{
"id": 214,
"key": "Name",
"operator": "Contains",
"resourceType": "DEVICE",
"value": "172.31.23"
},
{
"key": "Site Name",
"operator": "Contains",
"resourceType": "DEVICE",
"value": "US-WA"
}
]
},
"id": "DGP-1c31a30a-95e9-4b5d-809b-ff3a193c8001",
"name": "LAP Storage Devices",
"parent": {
"id": "DGP-a215ea93-d824-46a6-b434-9c59ceaca7bc",
"name": "Storage",
"resourceType": "DEVICE_GROUP",
"type": "DEVICE_GROUP"
},
"type": "DEVICE_GROUP",
"updatedDate": "2017-11-14T06:20:09+0000"
}
{
"createdDate": "2017-08-08T12:16:26+0000",
"id": "DGP-1c31a30a-95e9-4b5d-809b-ff3a193c8001",
"name": "Network Devices",
"type": "DEVICE_GROUP",
"updatedDate": "2017-08-08T12:16:26+0000"
}