Appearance
Device Group Management
Device groups are used to manage and organize devices, supporting create, read, update, and delete operations.
List Device Groups
Retrieve all device groups for the current organization.
Request
http
GET /api/v2/device-groups/Parameters
| Parameter | Type | Required | Description |
|---|---|---|---|
| page | integer | No | Page number (default: 1) |
| page_size | integer | No | Items per page (default: 20) |
Response
json
{
"success": true,
"data": [
{
"pk": 0,
"name": "Device Group Name",
"device_count": 10
}
],
"error": null
}Create Device Group
Create a new device group.
Request
http
POST /api/v2/device-groups/Request Parameters
| Parameter | Type | Required | Description |
|---|---|---|---|
| name | string | Yes | Device group name |
| weight | integer | No | Weight for sorting |
Request Example
json
{
"name": "Device Group Name"
}Response
json
{
"success": true,
"data": {
"pk": 0,
"name": "Device Group Name",
"device_count": 0
},
"error": null
}Update Device Group
Update existing device group information.
Request
http
PUT /api/v2/device-groups/{group_id}/Request Parameters
| Parameter | Type | Required | Description |
|---|---|---|---|
| name | string | Yes | Device group name |
Request Example
json
{
"name": "Device Group Name"
}Response
json
{
"success": true,
"data": {
"pk": 0,
"name": "Device Group Name",
"device_count": 10
},
"error": null
}Partial Update Device Group
Partially update device group information.
Request
http
PATCH /api/v2/device-groups/{group_id}/Request Parameters
Same as update device group, but all fields are optional.
Request Example
json
{
"name": "Device Group Name",
"weight": 0
}Response
json
{
"success": true,
"data": {
"id": "group_id",
"name": "Device Group Name",
"description": "Device Group Description",
"device_count": 10
},
"error": null
}Delete Device Group
Delete the specified device group.
Request
http
DELETE /api/v2/device-groups/{group_id}/Response
Successful deletion returns 204 status code with no response content.
Error Codes
| Error Code | Description |
|---|---|
| 401 | Unauthorized |
| 403 | Forbidden or organization not active |
| 404 | Device group not found |
| 400 | Bad Request |