DeviceGroups

DeviceGroups - Create

Adds a new device group.

POST

https://api-server-host-name/configapi/{pool_UUID}/{logpoint_identifier}/DeviceGroups

Parameters

Field
Label in UI
Type
Description

description

Description

String

Description for the device group. Mandatory Field

devices

Devices in this group

[String]

List of device id(s) you want to associate with the device group. Optional Field

name

Name

String

A unique valid string to define the Name of the device group. Mandatory Field

Request Example

{
    "data": {
        "description": "CreatedfromZookeper",
        "devices": [
            "5759080fd8aaa41bfef54884"
        ],
        "name": "testgroup1"
    }
}

Success Response


DeviceGroups - Edit

Edits a device group with given id.

PUT

Parameters

Field
Label in UI
Type
Description

description

Description

String

Description for the device group. Mandatory Field

devices

Devices in this group

[String]

List of device id(s) that you want to associate with the device group. Optional Field

id

-

String

Existing device group id . Mandatory Field

name

Name

String

A unique valid string to define the Name of the device group. Mandatory Field

Request Example

Success Response

DeviceGroups - Get

Fetches a device group with given id.

GET

Parameters

Field
Label in UI
Type
Description

id

-

String

Existing device group id.

Success Response

DeviceGroups - List

Lists all device groups in the Fabric-enabled LogPoint.

GET

Success Response

DeviceGroups - Trash

Deletes device group with given id.

DELETE

Parameters

Field
Label in UI
Type
Description

id

-

String

Existing device group id. Mandatory Field

Success Response

Last updated

Was this helpful?