|
Request Parameters
Parameter
|
Description
|
Valid values
|
Mandatory
|
components
|
If this parameter value is yes, then response will contain information about group components.
The default value is no
|
yes | no
|
no
|
id
|
Group identifier.
This parameter can be defined in the request several times to request information on multiple groups at a time.
|
–
|
yes
|
keys
|
If this parameter value is yes, then response will contain information about the license key for this group.
The default value is no
|
yes | no
|
no
|
rights
|
If this parameter value is yes, then response will contain information about group rights.
The default value is no
|
yes | no
|
no
|
Request example
http://192.168.1.1:9080/api/groups/info.ds?id=GroupForIGS&rights=yes&components=yes&keys=yes
|
XML and JSON response structure examples are described below.
XML Response
<drweb-es-api api_version="4.3.0" timestamp="1559905015" server="192.168.1.1" srv_version="12.00.0.201909260" status="true">
<groups total="1">
<group id="GroupForIGS" name="GroupForIGS" description="GroupForIGS" created="1489410582" modified="1489410582" parent_id="" parent_name="" type="0">
<keys inherited="true" inherited_group_id="20e27d73-d21d-b211-a788-85419c46f0e6" inherited_group_name="Everyone">
<key id="daa669be6fdbca01"/>
</keys>
<packages>
<package arch="all" os="windows" url="http://win10-1809-pro-x64-ru:9080/download/download.ds?os=windows&group-id=GroupForIGS"/>
</packages>
<rights inherited="true" inherited_group_id="20e27d73-d21d-b211-a788-85419c46f0e6" inherited_group_name="Everyone">
<right code="1" name="Run Dr.Web Scanner for Windows" value="1"/>
<!-- etc. Skipped in documentation -->
</rights>
<components inherited="true" inherited_group_id="20e27d73-d21d-b211-a788-85419c46f0e6" inherited_group_name="Everyone">
<component code="4" name="Dr.Web Scanner for Windows" status="1"/>
<component code="14" name="SpIDer Mail for Windows workstations" status="1"/>
<component code="38" name="SpIDer Gate for Windows workstations" status="1"/>
<component code="54" name="Dr.Web Office Control" status="1"/>
<component code="55" name="Dr.Web Antispam" status="1"/>
<component code="57" name="SpIDer Guard for Windows workstations" status="1"/>
<component code="58" name="SpIDer Guard for Windows servers" status="1"/>
<component code="103" name="Dr.Web plug-in for MS Outlook" status="1"/>
<component code="105" name="Dr.Web Firewall" status="1"/>
<component code="30" name="Dr.Web Agent for Windows" status="2"/>
<component code="37" name="Dr.Web Agent Scanner for Windows" status="2"/>
</components>
<child-groups>0</child-groups>
<stations>1</stations>
</group>
</groups>
</drweb-es-api>
|
Description of XML Response Parameters
The <groups /> element contains information about all 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
|
description
|
Group description
|
created
|
Group creation time and date in Unix timestamp format
|
modified
|
Group modification time and date in Unix timestamp format
|
parent_id
|
Parent group identifier. If the value is none, then the parent group has not been set.
|
parent_name
|
Parent group name. If the value is none, then the parent group has not been set.
|
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.
|
▫The <keys /> element contains information about all group keys. The <keys /> element attributes:
Attribute
|
Description
|
inherited
|
If its value is set to true, then the keys are inherited from a parent group, and if set to false—then the keys are configured individually.
|
inherited_group_id
|
ID of a parent group from which the keys have been inherited. If the inherited attribute is set to false, then this attribute value will be none.
|
inherited_group_name
|
Name of a parent group from which keys parameters have been inherited. If the inherited attribute is set to false, then this attribute value will be none.
|
▪The <key /> element contains information about a specific key. The <key /> element attribute:
Attribute
|
Description
|
id
|
Identifier of a key
|
▫The <packages /> element contains links on group installation packages created at this Server for different architectures and operating systems. ▪The <package /> element contains the link on the specific installation package. The <package /> element attributes:
Attribute
|
Description
|
arch
|
Architecture on which the package can be installed:
•all—operating systems with 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 resource for the package (Agent) downloading
|
▫The <rights /> element contains information about all rights of a tariff group. The <rights /> element attributes:
Attribute
|
Description
|
inherited
|
If true, then permissions are inherited from a parent group, false—permissions are personally specified.
|
inherited_group_id
|
ID of a parent group from which the rights have been inherited. If the inherited attribute is set to false, then this attribute value will be none.
|
inherited_group_name
|
Name of a parent group from which the rights have been inherited. If the inherited attribute is set to false, then this attribute value will be none.
|
▪The <right /> element contains information about a specific element of rights. The <right /> element attributes:
Attribute
|
Description
|
code
|
Digital code of an element of rights (see the Rights section)
|
name
|
Name of element of right (see the Rights section)
|
value
|
Value of element of right:
0—this right cannot be used,
1—the right is granted.
|
▫The <components /> element contains information about all group components. The <components /> element attributes:
Attribute
|
Description
|
inherited
|
If its value is set to true, then components are inherited from a parent group, and if set to false—then component parameters are configured individually.
|
inherited_group_id
|
ID of a parent group from which component parameters have been inherited. If the inherited attribute is set to false, then this attribute value will be none.
|
inherited_group_name
|
Name of a parent group from which component parameters have been inherited. If the inherited attribute is set to false, then this attribute value will be none.
|
▪The <component /> element contains information about a specific component. The <component /> element attributes:
Attribute
|
Description
|
code
|
Digital code of the component (see the Component codes section)
|
name
|
Name of the component (see the Component codes section)
|
status
|
Component status. May take one of the following values:
2—the component must be installed
1—the component can be installed
0—the component must not be installed.
|
▫The <child-groups /> element contains the number of child groups. ▫The <stations /> element contains information about all stations, included in the group. Value of this element is the number of stations included to this group.
JSON Response
{ "head": {
"status": true,
"timestamp": 1559905257,
"api": {
"version": 40300,
"versionString": 4.3.0},
"server": {
"name": "192.168.1.1",
"version": "12.00.0.201909260",
"uuid": "6c271cb0-8912-11e9-5a3b-b85a98f7c5ad"}},
"data": {
"groups": {
"total": 1,
"list": [
{"child_groups": 0,
"components": {
"inherited": true,
"inherited_group_id": "20e27d73-d21d-b211-a788-85419c46f0e6"},
"inherited_group_name": "Everyone",
"list": [
{"code": 4 ,
"name": "Dr.Web Scanner for Windows",
"status": 1},
{"code": 14,
"name": "SpIDer Mail for Windows workstations",
"status": 1},
{"code": 38,
"name": "SpIDer Gate for Windows workstations",
"status": 1},
{"code": 54,
"name": "Dr.Web Office Control",
"status": 1},
{"code": 55,
"name": "Dr.Web Antispam",
"status": 1},
{"code": 57,
"name": "SpIDer Guard for Windows workstations",
"status": 1},
{"code": 58,
"name": "SpIDer Guard for Windows servers",
"status": 1},
{"code": 103,
"name": "Dr.Web plug-in for MS Outlook",
"status": 1},
{"code": 105,
"name": "Dr.Web Firewall",
"status": 1},
{"code": 30,
"name": "Dr.Web Agent for Windows",
"status": 2},
{"code": 37,
"name": "Dr.Web Agent Scanner for Windows",
"status": 2}]},
"created_time": 1489410582,
"description": "GroupForIGS",
"has_personal_settings": true,
"id": "GroupForIGS",
"keys": {
"inherited": true,
"inherited_group_id": "20e27d73-d21d-b211-a788-85419c46f0e6",
"inherited_group_name": "Everyone",
"list": [
"daa669be6fdbca01"]},
"modified_time": 1489410582,
"name": "GroupForIGS",
"packages": [
{"arch": "all",
"os": "windows",
"url": "http://win10-1809-pro-x64-ru:9080/download/download.ds?os=windows&group-id=GroupForIGS"}],
"permissions": {
"inherited": true,
"inherited_group_id": "20e27d73-d21d-b211-a788-85419c46f0e6",
"inherited_group_name": "Everyone",
"list": [
{"name": "Run Dr.Web Scanner for Windows",
"right": 1,
"value": 1},
...]},
"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
|
created_time
|
Group creation time and date in Unix timestamp format
|
description
|
Group description. The string is displayed only if the field is not empty.
|
has_personal_settings
|
If the value is true, then personal settings have been set for the group or for some stations in the group, and if set to false, then no personal settings have been set.
|
id
|
Group identifier
|
modified_time
|
Group modification time and date in Unix timestamp format
|
name
|
Group name
|
parent_group_id
|
Parent group identifier. If the value is none, then the parent group has not been set. The string is displayed only if the field is not empty.
|
parent_group_name
|
Parent group name. If the value is none, then the parent group has not been set. The string is displayed only if the field is not empty.
|
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.
|
▫The components block contains information about all group components. ▪The list array in the component block contains information about a specific component. Elements in the list array:
Field name
|
Description
|
code
|
Digital code of the component (see the Component codes section)
|
name
|
Name of the component (see the Component codes section)
|
status
|
Component status. May take one of the following values:
2—the component must be installed
1—the component can be installed
0—the component must not be installed.
|
▫The keys block contains information about all license keys of a group. The keys block elements:
Field name
|
Description
|
inherited
|
If its value is set to true, then keys are inherited from a parent group, and if set to false—then keys are configured individually.
|
inherited_group_id
|
ID of a parent group from which the keys have been inherited. If the inherited field value is set to false, then this attribute value will be none.
|
inherited_group_name
|
Name of a parent group from which keys parameters have been inherited. If the inherited field value is set to false, then this attribute value will be none.
|
▪The list array in the keys contains information about a specific key. Elements in the list array:
Field name
|
Description
|
id
|
Identifier of a key
|
▫The packages array block contains links on group installation packages created at this Server for different architectures and operating systems. Elements in the packages array:
Field name
|
Description
|
arch
|
Architecture on which the package can be installed:
•all—operating systems with 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 resource for the package (Agent) downloading
|
▫The permissions block contains information about all rights of a group. The permissions block elements:
Field name
|
Description
|
inherited
|
If true, then permissions are inherited from a parent group, false—permissions are personally specified.
|
inherited_group_id
|
ID of a parent group from which the rights have been inherited. If the inherited field value is set to false, then this attribute value will be none.
|
inherited_group_name
|
Name of a parent group from which the rights have been inherited. If the inherited field value is set to false, then this attribute value will be none.
|
▪The list array in the permissions contains information about a specific element of rights. Elements in the list array:
Field name
|
Description
|
name
|
Name of element of right (see the Rights section)
|
right
|
Digital code of an element of rights (see the Rights section)
|
value
|
Value of element of right:
0—this right cannot be used,
1—the right is granted.
|
|