Device Group

APIs for device group management

List device groups

Returns EnterpriseDeviceGroup list

Request
Security:
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

get/enterprise/{enterprise_id}/devicegroup/
Response samples
application/json
{
  • "count": 0,
  • "next": "string",
  • "previous": "string",
  • "results": [
    ]
}

Create a device group

Returns EnterpriseDeviceGroup instance

Request
Security:
path Parameters
enterprise_id
required
string

A UUID string identifying enterprise.

Request Body schema: */*
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

post/enterprise/{enterprise_id}/devicegroup/
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
}

Get device group information

Returns EnterpriseDeviceGroup instance

Request
Security:
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

get/enterprise/{enterprise_id}/devicegroup/{group_id}/
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
}

Update device group

Returns EnterpriseDeviceGroup instance

Request
Security:
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: */*
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

put/enterprise/{enterprise_id}/devicegroup/{group_id}/
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
}

Delete a device group

Emtpy response

Request
Security:
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

successful operation

delete/enterprise/{enterprise_id}/devicegroup/{group_id}/

Partial update group

Returns EnterpriseDeviceGroup instance

Request
Security:
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: */*
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

patch/enterprise/{enterprise_id}/devicegroup/{group_id}/
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
}