Get a List of Groups

Request Parameter

Parameter

Description

Mandatory

parent-group

Parent group ID.

The response contains information about all child groups of the specified parent group (ignoring the nested groups). A list of subgroups can be obtained for such system groups as Operating system, Status, Ungrouped.

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

no

 

Request Example

https://192.168.1.1:9081/api/groups/list.ds

XML and JSON response structure examples are described below.

 

XML Response Structure

<drweb-es-api api_version="4.3.0" timestamp="1587998442" server="192.168.1.1" srv_version="12.00.0.201909260" status="true">
  <groups total="2">
     <group id="2c213cd2-eba1-4a0e-9f76-95e5e756d48c" name="Dr.Web Free" child_groups="0" stations="129" type="0"/>

     <group id="91644cc3-1dc1-42dc-a41e-5ea001f5538d" name="Dr.Web" child_groups="1" stations="110" type="0"/>
  </groups>
</drweb-es-api>

 

Description of XML Response Parameters

The <groups /> element contains a list of groups corresponding with the request.

The <groups /> element attribute:

Attribute

Description

total

Total number of groups in a response

The <group /> element contains parameters of a specific group.

The <group /> element attributes:

Attribute

Description

id

Group ID

name

Group name

child-groups

Number of child groups (ignoring the nested groups)

stations

Number of stations in a group

type

Group type:

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 Dr.Web Server,

10—pseudogroup,

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

 

JSON Response Structure

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

    "timestamp": 1587999987,

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

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

      "version": "12.00.0.201909260",
      "uuid": "25cf53c0-885a-11ea-5c35-289def4dadcb"}},

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

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

          "id": "2c213cd2-eba1-4a0e-9f76-95e5e756d48c",

          "name": "Dr.Web Free",

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

         {"child_groups": 1,

          "id": "91644cc3-1dc1-42dc-a41e-5ea001f5538d",

          "name": "Dr.Web",

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

 

Description of JSON Response Parameters

The groups block contains a list of groups corresponding with the request.

The groups block elements:

Field name

Description

total

Total number of groups in a response

list

Array of parameters for each group

Each object of the list array contains parameters of a specific group.

Elements in the list array:

Field name

Description

child-groups

Number of child groups (ignoring the nested groups)

id

Group ID

name

Group name

stations

Number of stations in a group

type

Group type:

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 Dr.Web Server,

10—pseudogroup,

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