Get Groups List

Request Parameters

Parameter

Description

Mandatory

parent-group

Parent group identifier.

The response contains information on all child groups of the specified parent group (without nesting). Information on child groups of the Operating system, Status, or Ungrouped system groups can be provided in the same way.

If parameter is not set, response contains information on all user groups of the Everyone group level.

no

 

Request Example

http://192.168.1.1:9080/api/groups/list.ds?parent-group=ParentGroupForLGS

XML and JSON response structure examples are described below.

 

XML Response

<drweb-es-api api_version="4.3.0" timestamp="1558521889" server="192.168.1.1" srv_version="12.00.0.201909260" status="true">
  <groups total="2">
     <group id="98c8f98a-16e9-4fb5-af4d-d62923dca7b3" name="New group2" child_groups="0" stations="0" type="0"/>

     <group id="3" name="New group3" child_groups="2" stations="1" type="0"/>
  </groups>
</drweb-es-api>

 

Description of XML Response Parameters

The <groups /> element contains a list of groups.

The <groups /> element attribute:

Attribute

Description

total

Total number of groups

The <group /> element contains information about a specific group.

The <group /> element attributes:

Attribute

Description

id

Group identifier

name

Group name

child-groups

Number of child groups (without nesting)

stations

Number of stations in a group

type

Group type. Can take the following values:

0—user group,

1—base and default group,

2—group containing online stations,

3—group containing offline stations,

4—group containing stations grouped by operating system,

5—group containing stations grouped by network protocol,

6—group containing stations with uninstalled Dr.Web Agent,

7—group containing stations with expired access to the Server,

10—pseudogroup,

13—group containing Dr.Web Proxy servers for connecting Agents and neighbor Servers.

 

JSON Response

{ "head": {
    "status": true,

    "timestamp": 1558521971,

    "api": {
      "version": 40300,
      "versionString": 4.3.0},

 "server": {
    "name": "192.168.1.1",

 "version": "12.00.0.201909260",
 "uuid": "27671337-e0b0-4f60-aeb0-ab1f2ca47f77"}},

 "data": {
    "groups": {
       "total": 2,

"list": [
   {"child_groups": 0,

    "id": "98c8f98a-16e9-4fb5-af4d-d62923dca7b3",

    "name": "New group2",

 "stations": 0,
 "type": 0},

{"child_groups": 2,

 "id": "3",

 "name": "New group3",

 "stations": 1,
 "type": 0}]}}}

 

Description of JSON Response Parameters

The groups block contains information about all requested groups.

The groups block elements:

Field name

Description

total

Total number of groups

The list array contains information about a specific group.

Elements in the list array:

Field name

Description

child-groups

Number of child groups (without nesting)

id

Group identifier

name

Group name

stations

Number of stations in a group

type

Group type. Can take the following values:

0—user group,

1—base and default group,

2—group containing online stations,

3—group containing offline stations,

4—group containing stations grouped by operating system,

5—group containing stations grouped by network protocol,

6—group containing stations with uninstalled Dr.Web Agent,

7—group containing stations with expired access to the Server,

10—pseudogroup,

13—group containing Dr.Web Proxy servers for connecting Agents and neighbor Servers.