Logo

Device Group

APIs for device group management

Find out more about device group management

List device groups

Get a list of groups in the Devices & Groups.

SecurityapiKey
Request
path Parameters
enterprise_id
required
string

A UUID string identifying enterprise.

query Parameters
name
string

Filter by group name

limit
integer
Default: 20

Number of results to return per page.

offset
integer
Default: 0

The initial index from which to return the results.

Responses
200

successful operation

401

Authorization information is missing or invalid.

404

Not Found.

500

Internal server error

get/enterprise/{enterprise_id}/devicegroup/
Request samples 
Response samples 
application/json
{
  • "count": 0,
  • "next": "string",
  • "previous": "string",
  • "results": [
    ]
}
Create a device group
Create a group in Devices & Groups.


SecurityapiKey 
Request 
path Parameters
enterprise_id
required
string
A UUID string identifying enterprise.


 
Request Body schema: */*
required
name
required
string (Name) 
Group name


 
parent
string <uuid>  (Parent) 
Parent group id


 
device_ids
Array of strings <uuid>  (Device ids)   unique 
Devices ids


 
Responses 
201
successful operation


400
Bad request


401
Authorization information is missing or invalid.


403
Forbidden, no permission to perform this action.


500
Internal server error


post/enterprise/{enterprise_id}/devicegroup/
Request samples 
Response samples 
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "name": "string",
  • "created_on": "2019-08-24T14:15:22Z",
  • "enterprise": "string",
  • "parent": "string",
  • "device_count": 0,
  • "path": "string",
  • "children_count": 0,
  • "thumbnail": "dec11f24-4767-4257-ac7d-bde137bc173e",
  • "blueprint": "f63e6a96-31ed-4c31-b384-a8046257f34c"
}
Get device group information
Find a group by its ID. Use List groups to find a group’s ID in Devices & Groups.


SecurityapiKey 
Request 
path Parameters
group_id
required
string <uuid> 
A UUID string identifying this enterprise device group.


 
enterprise_id
required
string
A UUID string identifying enterprise.


 
Responses 
200
successful operation


401
Authorization information is missing or invalid.


404
Not Found.


500
Internal server error


get/enterprise/{enterprise_id}/devicegroup/{group_id}/
Request samples 
Response samples 
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "name": "string",
  • "created_on": "2019-08-24T14:15:22Z",
  • "enterprise": "string",
  • "parent": "string",
  • "device_count": 0,
  • "path": "string",
  • "children_count": 0,
  • "thumbnail": "dec11f24-4767-4257-ac7d-bde137bc173e",
  • "blueprint": "f63e6a96-31ed-4c31-b384-a8046257f34c"
}
Update device group
Update a group in Devices & Groups.


SecurityapiKey 
Request 
path Parameters
group_id
required
string <uuid> 
A UUID string identifying this enterprise device group.


 
enterprise_id
required
string
A UUID string identifying enterprise.


 
query Parameters
action
string
add / remove / rename / move


 
Request Body schema: */*
required
name
required
string (Name) 
Group name


 
parent
string <uuid>  (Parent) 
Parent group id


 
device_ids
Array of strings <uuid>  (Device ids)   unique 
Devices ids


 
Responses 
200
successful operation


400
User update error


401
Authorization information is missing or invalid


404
Not Found


500
Internal server error


put/enterprise/{enterprise_id}/devicegroup/{group_id}/
Request samples 
Response samples 
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "name": "string",
  • "created_on": "2019-08-24T14:15:22Z",
  • "enterprise": "string",
  • "parent": "string",
  • "device_count": 0,
  • "path": "string",
  • "children_count": 0,
  • "thumbnail": "dec11f24-4767-4257-ac7d-bde137bc173e",
  • "blueprint": "f63e6a96-31ed-4c31-b384-a8046257f34c"
}
Delete a device group
Delete a group from Devices & Groups.


SecurityapiKey 
Request 
path Parameters
group_id
required
string <uuid> 
A UUID string identifying this enterprise device group.


 
enterprise_id
required
string
A UUID string identifying enterprise.


 
Responses 
204
The resource was deleted successfully.


400
Invalid request.


401
Authorization information is missing or invalid.


403
Forbidden, no permission to perform this action.


404
Not Found.


500
Internal server error


delete/enterprise/{enterprise_id}/devicegroup/{group_id}/
Request samples 
Response samples 
application/json
{
  • "errors": [
    ],
  • "message": "string",
  • "status": 0
}
Partially update a device group
Partially update a group in Devices & Groups.


SecurityapiKey 
Request 
path Parameters
group_id
required
string <uuid> 
A UUID string identifying this enterprise device group.


 
enterprise_id
required
string
A UUID string identifying enterprise.


 
query Parameters
action
string
add / remove / rename / move


 
Request Body schema: */*
required
name
string (Name) 
Group name


 
parent
string <uuid>  (Parent) 
Parent group id


 
device_ids
Array of strings <uuid>  (Device ids)   unique 
Device ids


 
Responses 
200
successful operation


400
Bad request


401
Authorization information is missing or invalid.


403
Forbidden, no permission to perform this action.


404
Not Found.


500
Internal server error


patch/enterprise/{enterprise_id}/devicegroup/{group_id}/
Request samples 
Response samples 
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "name": "string",
  • "created_on": "2019-08-24T14:15:22Z",
  • "enterprise": "string",
  • "parent": "string",
  • "device_count": 0,
  • "path": "string",
  • "children_count": 0,
  • "thumbnail": "dec11f24-4767-4257-ac7d-bde137bc173e",
  • "blueprint": "f63e6a96-31ed-4c31-b384-a8046257f34c"
}
Upload a thumbnail pic
Upload an image to represent the group in Devices & Groups.


SecurityapiKey 
Request 
path Parameters
enterprise_id
required
string <uuid> 
Enterprise ID


 
Request Body schema: multipart/form-data
required
image_file
string <binary> 
 
Responses 
200
Thumbnail


post/enterprise/{enterprise_id}/devicegroup/thumbnail/
Request samples 
Response samples 
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "image_file": "string",
  • "thumbnail_url": "string",
  • "created_on": "2019-08-24T14:15:22Z"
}
List thumbnail pics
Get a list of group thumbnail image files in Devices & Groups.


SecurityapiKey 
Request 
path Parameters
enterprise_id
required
string <uuid> 
Enterprise ID


 
Responses 
200
Thumbnail


get/enterprise/{enterprise_id}/devicegroup/thumbnail/
Request samples 
Response samples 
application/json
{
  • "count": 0,
  • "previous": "string",
  • "next": "string",
  • "results": [
    ]
}
Get thumbnail detail
Get a thumbnail by its ID. Use List thumbnail pics to find thumbnail IDs. 


SecurityapiKey 
Request 
path Parameters
enterprise_id
required
string <uuid> 
Enterprise ID


 
thumbnail_id
required
string <uuid> 
Group thumbnail ID


 
Responses 
200
Thumbnail


get/enterprise/{enterprise_id}/devicegroup/thumbnail/{thumbnail_id}/
Request samples 
Response samples 
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "image_file": "string",
  • "thumbnail_url": "string",
  • "created_on": "2019-08-24T14:15:22Z"
}
Delete group thumbnail
Delete a thumbnail in Devices & Groups.


SecurityapiKey 
Request 
path Parameters
enterprise_id
required
string <uuid> 
Enterprise ID


 
thumbnail_id
required
string <uuid> 
Group thumbnail ID


 
Responses 
204
Deleted group thumbnail


401
Group thumbnail delete error


delete/enterprise/{enterprise_id}/devicegroup/thumbnail/{thumbnail_id}/
Request samples 
Response samples 
application/json
{
  • "errors": [
    ],
  • "message": "string",
  • "status": 0
}
List the subgroups of list of groups
Returns EnterpriseDeviceGroup list


SecurityapiKey 
Request 
query Parameters
parent_group_ids
string
Filter by parent group ids. This is a comma separated list of group ids.


 
immediate
boolean
 Default:  false
This is a boolean value. If true, only immediate subgroups are returned.


 
Responses 
200
successful operation


400
Bad Request.


401
Authorization information is missing or invalid.


500
Internal server error.


get/api/v2/subgroups/
Request samples 
Response samples 
application/json
{
  • "content": [
    ]
}
➔ Next to Token