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
tenantId
string

Describes the client ID of the tenant

deviceGroupId
string

Responses

OK

Endpoint
/api/v2/tenants/{tenantId}/deviceGroups/{deviceGroupId}

Gets the details of a device group.

Path Parameters
tenantId
string

Describes the client ID of the tenant

deviceGroupId
string

Responses

OK

createdDate
string

entityType
string

Type of resources in a group. Example: DEVICE_GROUP, SNS

filterCriteria
object

filterCriteria.actions
- Supported actions - ASSIGN MONITORINGTEMPLATE - ASSIGN KNOWLEDGEARTICLE - Assign Availability Rule - ASSIGN CUSTOMATTRIBUTES - Assign Jobs - ASSIGN CREDENTIALSET - Supported values for items for given action - For Assign Availability Rule , item value is AND - For ASSIGN CUSTOMATTRIBUTES, item value is tagName[value='tagValue'] - For all others this is number in string eg "12345" - Scenarios for Custom attributes item values in response payload - New TagName : New Tag created with given Name and Tag Value, and Assigned. - Id of New Tag Value added to response - Old TagName and New Tag Value : New Tag Value added to Tag and Assigned - Id of New Tag Value added to response. - Old TagName and Old TagValue : Both the details are verfied and Assigned - Id of TagValue added to Response
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
id
string

kbArticlesIds
array

(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]

name
string

Unique name for the device group. The device group is identified with this name.

parent
object

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.

parent.id
updatedDate
string

{
  "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"
}