Get Group Information

Request Parameters

Parameter

Description

Mandatory

components

If this parameter value is yes, then response will contain information about group components.

Valid values: yes | no. By default: no.

no

id

Group ID.

This parameter can be repeated any number of times per request to request information about multiple groups at a time.

yes

keys

If this parameter value is yes, then response will contain information about license keys of the group.

Valid values: yes | no. By default: no.

no

rights

If this parameter value is yes, then response will contain information about group privileges.

Valid values: yes | no. By default: no.

no

 

Request Example

https://192.168.1.1:9081/api/groups/info.ds?id=20e27d73-d21d-b211-a788-85419c46f0e6&rights=yes&components=yes&keys=yes

XML and JSON response structure examples are described below.

 

XML Response Structure

<drweb-es-api api_version="4.3.0" timestamp="1589408311" server="192.168.1.1" srv_version="12.00.0.201909260" status="true">
  <groups total="1">
     <group id="20e27d73-d21d-b211-a788-85419c46f0e6" name="Everyone" description="All stations" created="1585824539" modified="1589388246" parent_id="" parent_name="" type="1">
        <keys inherited="false" inherited_group_id="" inherited_group_name="">
           <key id="daa669be6fdbca01"/>
        </keys>

        <packages>
           <package arch="all" os="windows" url="https://192.168.1.1:9081/download/download.ds?os=windows&group-id=20e27d73-d21d-b211-a788-85419c46f0e6"/>
        </packages>

        <rights inherited="false" inherited_group_id="" inherited_group_name="">
           <right code="1" name="Run Dr.Web Scanner for Windows" value="1"/>

          <!-- etc. Skipped in documentation -->
        </rights>

        <components inherited="false" inherited_group_id="" inherited_group_name="">

           <component code="4" name="Dr.Web Scanner for Windows" status="1"/>

          <!-- etc. Skipped in documentation -->
        </components>

        <child-groups>0</child-groups>
        <stations>9</stations>
     </group>
  </groups>
</drweb-es-api>

 

Description of XML Response Parameters

The <groups /> element contains information about all groups related to 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

description

Group description

created

Group creation time and date

modified

Group modification time and date

parent_id

Parent group ID.
If empty, it means that the parent group has not been set.

parent_name

Parent group name.
If empty, it means that the parent group has not been set.

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.

The <keys /> element contains information about all license keys of a group.

The <keys /> element attributes:

Attribute

Description

inherited

If true, that means that the keys were inherited from a parent group, and if false, it means that the keys were configured individually.

inherited_group_id

ID of a parent group from which the key parameters have been inherited.
If the inherited attribute is false, this attribute’s value will be empty.

inherited_group_name

Name of a parent group from which the key parameters have been inherited.
If the inherited attribute is false, this attribute’s value will be empty.

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

The <key /> element attribute:

Attribute

Description

id

Key ID

The <packages /> element contains links to group installation packages created at this Dr.Web Server for various processor designs and operating systems.

The <package /> element contains a link to a specific installation package.

The <package /> element attributes:

Attribute

Description

arch

Processor designs on which the package can be installed:

all—operating systems of any bitness,

x86—32-bit operating systems,

x86_64—64-bit operating systems

os

Operating system on which the package can be installed

url

Web address to download the package (Dr.Web Agent)

The <rights /> element contains information about all privileges of stations in a group.

The <rights /> element attributes:

Attribute

Description

inherited

If true, that means that privileges were inherited from a parent group, false—privileges were configured individually.

inherited_group_id

ID of a parent group from which the privileges have been inherited.
If the inherited attribute is false, this attribute’s value will be empty.

inherited_group_name

Name of a parent group from which the privileges have been inherited.
If the inherited attribute is false, this attribute’s value will be empty.

The <right /> element contains information about a specific privilege of stations in a group.

The <right /> element attributes:

Attribute

Description

code

Digital code of a privilege (see Appendix A1. Station Privilege Codes)

name

Privilege name (see Appendix A1. Station Privilege Codes)

value

Privilege status:

0—this privilege is denied,

1—the privilege is granted.

The <components /> element contains information about all group components.

The <components /> element attributes:

Attribute

Description

inherited

If the value is set to true, it means that the components were inherited from a parent group, and if set to false—the component parameters were configured individually.

inherited_group_id

ID of a parent group from which the component parameters have been inherited.
If the inherited attribute is false, this attribute’s value will be empty.

inherited_group_name

Name of a parent group from which the component parameters have been inherited.
If the inherited attribute is false, this attribute’s value will be empty.

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

The <component /> element attributes:

Attribute

Description

code

Digital code of a component (see Appendix B2. Component Codes)

name

Name of a component (see Appendix B2. Component Codes)

status

Component status:

2—the component must be installed,

1—the component can be installed,

0—the component does not need to be installed.

The <child-groups /> element contains a number of child groups.

The <stations /> element contains a number of stations included in this group.

 

JSON Response Structure

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

    "timestamp": 1589408381,

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

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

      "version": "12.00.0.201909260",
      "uuid": "b35d999d-9212-481d-af8c-8551c4113383"}},

"data": {
    "groups": {
      "total": 1,

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

          "components": {
              "inherited": false,

              "list": [
                {"code": 4,
                  "name": "Dr.Web Scanner for Windows",
                  "status": 1},

                ...]},

          "created_time": 1585824539,

          "description": "All stations",

          "has_personal_settings": true,

           "id": "20e27d73-d21d-b211-a788-85419c46f0e6",

          "keys": {
              "inherited": false,

              "list": [
                 "daa669be6fdbca01"]},

          "modified_time": 1589388246,

          "name": "Everyone",

          "packages": [
              {"arch": "all",
              "os": "windows",
              "url": "https://192.168.1.1:9081/download/download.ds?os=windows&group-id=20e27d73-d21d-b211-a788-85419c46f0e6"}],

          "permissions": {
              "inherited": false,

              "list": [
                {"name": "Run Dr.Web Scanner for Windows",
                  "right": 1,
                  "value": 1},
                 ...]},

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

 

Description of JSON Response Parameters

The groups block contains information about all groups related to 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

components

Block containing information about all group components

created_time

Group creation time and date

description

Group description. The string is displayed as long as the field value is not empty.

has_personal_settings

If the value is true, it means that personal settings have been set for the group or some stations in the group, and if set to false, then no personal settings have been set.

id

Group ID

keys

Block containing information about all license keys of a group

modified_time

Group modification time and date

name

Group name

packages

Array of links to group installation packages created at this Dr.Web Server for various processor designs and operating systems

parent_group_id

Parent group ID.
If the value is none, it means that the parent group has not been set. The string is displayed as long as the field value is not empty.

parent_group_name

Parent group name.
If the value is none, it means that the parent group has not been set. The string is displayed as long as the field value is not empty.

permissions

Block containing information about all privileges of stations in a group.

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.

The components block elements:

Field name

Description

inherited

If the value is set to true, it means that the components were inherited from a parent group, and if set to false—the component parameters were configured individually.

inherited_group_id

ID of a parent group from which the component parameters have been inherited.
This element will not be present as long as the inherited element is false.

inherited_group_name

Name of a parent group from which the component parameters have been inherited.
This element will not be present as long as the inherited element is false.

list

Array with parameters for each component in a group

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

Elements in the list array:

Field name

Description

code

Digital code of a component (see Appendix B2. Component Codes)

name

Name of a component (see Appendix B2. Component Codes)

status

Component status:

2—the component must be installed,

1—the component can be installed,

0—the component does not need to be installed.

The keys block contains information about all license keys of a group.

The keys block elements:

Field name

Description

inherited

If the value is true, it means that the keys were inherited from a parent group, and if false—the keys were configured individually.

inherited_group_id

ID of a parent group from which the key parameters have been inherited.
This element will not be present as long as the inherited element is false.

inherited_group_name

Name of a parent group from which the key parameters have been inherited.
This element will not be present as long as the inherited element is false.

list

Array of information about all keys of a group

Every object in the list array contains information about a specific key.

Elements in the list array:

Field name

Description

id

Key ID

Every object in the packages array contains a link to a specific group installation package.

Elements in the packages array:

Field name

Description

arch

Processor designs on which the package can be installed:

all—operating systems of any bitness,

x86—32-bit operating systems,

x86_64—64-bit operating systems

os

Operating system on which the package can be installed

url

Web address to download the package (Dr.Web Agent)

The permissions block contains information about all privileges of stations in a group.

The permissions block elements:

Field name

Description

inherited

If true, that means that privileges were inherited from a parent group, false—privileges were configured individually.

inherited_group_id

ID of a parent group from which the privileges have been inherited.
This element will not be present as long as the inherited element is false.

inherited_group_name

Name of a parent group from which the privileges have been inherited.
This element will not be present as long as the inherited element is false.

list

Array with information about every privilege of stations in a group

Every object in the list array contains information about a specific privilege of stations in a group.

Elements in the list array:

Field name

Description

name

Privilege name (see Appendix A1. Station Privilege Codes)

right

Digital code of a privilege (see Appendix A1. Station Privilege Codes)

value

Privilege status:

0—this privilege is denied,

1—the privilege is granted.