DeviceGroups¶

DeviceGroups - Create¶

Adds a new device group.

POST

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

Parameter

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

{
    "status": "Success",
    "message": "/monitorapi/{pool_UUID}/{logpoint_identifier}/orders/{request_id}"
}

DeviceGroups - Edit¶

Edits a device group with given id .

PUT

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

Parameter

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

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

Success Response

{
    "status": "Success",
    "message": "/monitorapi/{pool_UUID}/{logpoint_identifier}/orders/{request_id}"
}

DeviceGroups - Get¶

Fetches a device group with given id .

GET

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

Parameter

Field	Label in UI	Type	Description
id	-	String	Existing device group id .

Success Response

{
    "description": "CreatedfromZookeper",
    "devices": [
        "5759080fd8aaa41bfef54884"
    ],
    "id": "574fb123d8aaa4625bfe2d23",
    "name": "testgroup1"
}

DeviceGroups - List¶

Lists all device groups in the Fabric-enabled LogPoint.

GET

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

Success Response

[
    {
        "description": "CreatedfromZookeper",
        "devices": [
            "5759080fd8aaa41bfef54884"
        ],
        "id": "574fb123d8aaa4625bfe2d23",
        "name": "testgroup1"
    }
]

DeviceGroups - Trash¶

Deletes device group with given id .

DELETE

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

Parameter

Field	Label in UI	Type	Description
id	-	String	Existing device group id . Mandatory Field

Success Response

{
    "status": "Success",
    "message": "/monitorapi/{pool_UUID}/{logpoint_identifier}/orders/{request_id}"
}

Helpful?