Get Station Information

Request Parameters

Parameter	Description	Valid values	Note
bases	If this parameter value is yes, then response will contain information on antivirus databases which are used at the station.	yes \| no	Required parameter: no. The default value is no
components	If this parameter value is yes, then response will contain information on station components.	yes \| no	Required parameter: no. The default value is no
group-membership	If this parameter value is yes, then response will contain information on groups in which the station is included.	yes \| no	Required parameter: no. The default value is no
id	Station identifier	–	Required parameter: yes
installed-components	If this parameter value is yes, then response will contain information on antivirus components installed at the station.	yes \| no	Required parameter: no. The default value is no
keys	If this parameter value is yes, then response will contain information on station license keys.	yes \| no	Required parameter: no. The default value is no
modules	If this parameter value is yes, then response will contain information on antivirus modules installed at the station.	yes \| no	Required parameter: no. The default value is no
rights	If this parameter value is yes, then response will contain information on station rights.	yes \| no	Required parameter: no. The default value is no
running-components	If this parameter value is yes, then response will contain information on antivirus components currently running at the station.	yes \| no	Required parameter: no. The default value is no

Request Example

http://192.168.1.1:9080/api/stations/info.ds?id=1002&components=yes&installed-components=yes&running-components=yes&rights=yes&group-membership=yes&modules=yes&keys=yes

XML and JSON response structure examples are described below.

XML Response

<drweb-es-api api_version="4.3.0" timestamp="1558521950" server="192.168.1.1" srv_version="12.00.0.201909260" status="true">
<stations total="1">
<station id="1002" name="station1234" created="1489056584" modified="1545821125" parent_id="1000" parent_name="Everyone" password="123456" state="0">
<lastseenat>0</lastseenat>

<os code="0">unknown</os>

<department>Test_office></department>

<street>Test_avenue</street>

<floor>Floor_1002</floor>

<province>Test_region</province>

</modules>

<installed-components total="11">
<component code="144" name="Dr.Web Preventive Protection" installed="1559729080" path="C:\Program Files\DrWeb" server="MT"/>

</installed-components>

<running-components total="8">
<component code="14" name="SpIDer Mail for Windows workstations" params="" started="1561525662" type="8" user="NT AUTHORITY\SYSTEM"/>

</running-components>
<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"/>

</rights>

</components>

<group-membership total="0"> </group-membership>

When returning the information on deleted stations, the response document does not contain the following blocks:

<os />—operating system on station,

<running-components />—currently running components,

<installed-components />—installed components,

<components />—installing components,

<bases/>—virus databases,

<packages/>—installation packages,

<connection /> and </public_key>—connection information and public encryption key,

<rights />—permissions (see the Permissions section),

<modules />—modules,

<group-membership />—membership in groups.

Description of XML Response Parameters

The <stations /> element contains information about all stations.

The <stations /> element attribute:

Attribute	Description
total	Total number of stations

•The <station /> element contains information on a specific station.

The <station /> element attributes:

Attribute	Description
id	Station ID
name	Station name
created	Station creation date
modified	Last modification time
parent_id	Station parent group ID
parent_name	Station parent group name
password	Password for access to the Server
state	The current state of the station (see Returned station state codes)

▫The <lastseenat /> element contains a date of the last connection to the Server by a specified station.

▫The <lastseenfrom /> element contains address and port from which the station connected to the Server last time.

▫The <os /> element contains information about the operating system currently installed on the station.

The <os /> element attribute:

Attribute	Description
code	Operating system code

The <os /> element value is an operating system name.

▫Nested elements of the <station /> element:

Element	Description
<department />	Department
<description />	Description
<country />	Country
<street />	Street
<room />	Room
<city />	City
<floor />	Floor
<longitude />	Longitude
<latitude />	Latitude
<organization />	Organization
<province />	Province
<email />	Email address

▫The <connection /> element contains Server connection parameters.

The <connection /> element attributes:

Attribute	Description
port	Port number for connecting to the Server
server	DNS name or IP address of the Server

▪The <public_key /> element contains information on the Server public encryption key and the key itself.

The <public_key /> element attributes:

Attribute	Description
url	Address of a public key location on the Server
uuid	Identifier of the public key

▫The <packages /> element contains links on installation packages created at this Server for different architectures and operating systems.

▪The <package /> element contains the link on the specific antivirus 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

Operating system on which the package can be installed

url

Web resource for the package (Dr.Web Agent) downloading

▫The <modules /> element contains information about all program modules.

The <modules /> element attribute:

Attribute	Description
total	Total number of modules

▪The <module /> element contains information about a specific program module.

The <module /> element attributes:

Attribute	Description
name	File name
version	Module version
created	Module creation date in the UNIX timestamp format
modified	Module last modified date in the UNIX timestamp format
hash	Module checksum
file_size	File size (bytes)
file_owner	Name of a file owner

▫The <bases /> element contains information about all virus databases installed on a station.

The <bases /> element attribute:

Attribute	Description
total	Total number of virus databases

▪The <base /> element contains information about a specific virus database.

The <base /> element attributes:

Attribute	Description
file_name	Virus database file name
version	Database version
created	Database creation date in the UNIX timestamp format
viruses	The number of virus records in the database

▫The <keys /> element contains information about license keys of the station.

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 key 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 the key parameters have been inherited. If the inherited attribute is set to false, then this attribute value will be none.

▪The <key /> element contains information on a specific license key.

The <key /> element attribute:

Attribute	Description
id	Identifier of a key

▫The <installed-components /> element contains information about all installed components.

The <installed-components /> element attribute:

Attribute	Description
total	Total number of installed components

▪The <component /> element of the <installed-components /> element contains information about a specific installed 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)
installed	Date of the component installation in the UNIX timestamp format
path	Component installation path
server	Address of the Server from which the component was installed

▫The <running-components /> element contains information about all components running at the time of the request.

The <running-components /> element attribute:

Attribute	Description
total	Total number of running components

▪The <component /> element of the <running-components /> element contains information about a specific running 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)
params	Component start parameters
started	Component start time in the UNIX timestamp format
type	Type of the component (see the Component codes section)
user	Station user on behalf of which the component was launched

▫The <rights /> element contains information about all rights of a station.

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 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 of the <components /> 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 <group-membership /> element contains information about all groups to which the station is the member.

The <group-membership /> element attribute:

Attribute	Description
total	Total number of groups to which the station is the member

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

The <group /> element attributes:

Attribute

Description

Group identifier

name

Group name

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,

▫The <acl> element contains access control lists that specify limitations on network addresses from which Dr.Web Agent may access the Server.

The <acl> element attribute:

Attribute

Description

priority

Determines lists usage priority:

•allowed—allowed addresses list has a priority: addresses included in both of lists or not included in none of them are allowed,

•disallowed—denied addresses list has a priority: addresses included in both of lists or not included in none of them are denied.

The <allowed /> and <disallowed /> element determines addresses lists from which the asses to the Server is allowed or denied correspondingly.

JSON Response

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

"timestamp": 1558522038,

"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": {
"total": 1,

"list": [
{"id": "1002",

"name": "station1234",

"parent_id": "1",

"parent_name": "mygr1",

"password": "123456",

"state": 1,

"last_seen_time": 1561642444,

"last_seen_addr": "ssl://10.21.0.154:50173",

"connection": {
"port": 2193,

"public_key": {
"file": "; [^] Dr.Web (R) Public key file\n
; Do not edit!\n
...
; ***EOF***\n",

"id": "432a295a-ad54-46c0-829c-474341f369dc",
"url": "http://ubuntu1804-amd64:9080/install/drwcsd.pub"},
"server": "ubuntu1804-amd64"},

"packages": [
{"arch": "all,
"os": "windows","
"url": "http://ubuntu1804-amd64:9080/download/download.ds?os=windows&id=1002"}],

"department": "Test_office",

"description": "Test_1002",

"country": "RU",

"street": "Test_avenue",

"room": "Room_1002",

"city": "Test_town",

"floor": "Floor_1002",

"longitude": 2222220,

"latitude": 3333330,

"organization": "Test_Inc",

"province": "Test_region",

"email": "Test_mail",

"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},
...]},

"installed_components": [
{"code": 144,
"installed_time": 1559729080,

"name": "Dr.Web Preventive Protection",

"path": "C:\\Program Files\\DrWeb",

"server": "MT"},
...],

"running_components": [
{"code": 14,

"name": "SpIDer Mail for Windows workstations",

"params": "",

"pid": "14",

"started_time": 1561525662,

"type": 8,

"user": "NT AUTHORITY\\SYSTEM"},
...],

"modules": [
{"created_time": 1555412121,

"description": "Dr.Web Virus-Finding Engine",

"file_name": "drweb32.dll",

"file_owner": "BUILTIN\\Administrators:DRWEB\\Domain Users @ MT",

"file_size": 4572424,
"hash": "6fbd6151c4a67f7439130282efb7e981",

"modified_time": 1555412121,

"version": "7.00.34.11020"},
...],

"bases": [],

"group_membership": [],

"keys": {
"inherited": true,

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

"inherited_group_name": "Everyone",

"list": [
"daa669be6fdbca01"]},

"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},
...]},

"acl": {
"priority": "allow",

"allowed": [{
"net_mask": "32",
"net_address": "192.168.1.1"}],

"disallowed": [{
"net_mask": "32",
"net_address": "192.168.1.2"}]},

"os_code": 0,

"os_name": "unknown",

"created_time": 1412665881,
"modified_time": 1412665881}]}}

Description of JSON Response Parameters

The data block contains information about all stations.

The data block elements:

Field name	Description
total	Total number of stations

•The list array contains information about specific stations.

Elements in the list array:

Field name	Description
city	City
connection	Server connection parameters block
country	Country
created_time	Station creation date
department	Department
description	Description
email	Email address
floor	Floor
id	Station identifier
last_seen_addr	Address from which the station connected to the Server at the last time
last_seen_time	Date of a last connection of a station to the Server
latitude	Latitude
longitude	Longitude
modified_time	Last modification time
name	Station name
organization	Organization
os_code	Operating system code
os_name	Operating system name
packages	The array of links to installation packages created at this Server for different architectures and operating systems
parent_id	Station parent group ID
parent_name	Station parent group name
password	Password for access to the Server
province	Province
room	Room
state	The current state of the station (see Returned station state codes)
street	Street

▫The connection block elements:

Field name	Description
port	Port number for connecting to the Server
public_key	The block contains information on the Server public encryption key and the key itself.
server	DNS name or IP address of the Server

▪The public_key block elements:

Field name	Description
url	Address of a public key location on the Server
uuid	Identifier of the public key

▫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

Operating system on which the package can be installed

url

Web resource for the package (Dr.Web Agent) downloading

•The components block contains information about all components.

The components block elements:

Field name	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 field value is set to false this value will be none.
inherited_group_name	Name of a parent group from which component parameters have been inherited. If the inherited field value is set to false this value will be none.

▫The list array in the components 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 installed-components array contains information about all installed components.

Elements in the installed-components 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)
installed_time	Date of the component installation in the UNIX timestamp format
path	Component installation path
server	Address of the Server from which the component was installed

•The running-components array contains information about all components running at the time of the request.

Elements in the running-components 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)
started_time	Component start time in the UNIX timestamp format
type	Type of the component (see the Component codes section)
user	Station user on behalf of which the component was launched
pid	Process identifier at the station
params	Component start parameters

•The modules array block contains information about all program modules.

Elements in the modules array:

Field name	Description
created_time	Module creation date in the UNIX timestamp format
file_name	File name
file_size	File size (bytes)
file_owner	Name of a file owner
hash	Module checksum
modified_time	Module last modified date in the UNIX timestamp format
name	Module name
version	Module version

•The bases array contains information about all virus databases.

Elements in the bases array:

Field name	Description
created	Database creation date in the UNIX timestamp format
file_name	Virus database file name
version	Database version
viruses	The number of virus records in the database

•The group-membership contains information about all groups to which the station is the member.

Elements in the group-membership array:

Field name

Description

Group identifier

name

Group name

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 Agent,

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

10—pseudogroup,.

•The keys block contains information about license keys of the station.

The keys block elements:

Field name	Description
inherited	If its value is set to true the keys are inherited from a parent group, and if set to false—the keys are configured individually.
inherited_group_id	ID of a parent group from which the key parameters have been inherited. If the inherited field value is set to false this value will be none.
inherited_group_name	Name of a parent group from which the key parameters have been inherited. If the inherited field value is set to false this value will be none.

▫The list array in the keys block contains information about a specific key.

Elements in the list array:

Field name	Description
id	Identifier of a key

•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.

•The acl block contains access control lists that specify limitations on network addresses from which the Agent may access the Server.

The acl block element:

Field name

Description

priority

Determines lists usage priority:

•allowed—allowed addresses list has a priority: addresses included in both of lists or not included in none of them are allowed,

•disallowed—denied addresses list has a priority: addresses included in both of lists or not included in none of them are denied.

The allowed and disallowed values determines addresses lists from which the asses to the Server is allowed or denied correspondingly.