|
Request Parameters
Parameter
|
Description
|
Valid values
|
Note
|
Mandatory
|
id
|
Station identifier
|
-
|
-
|
yes
|
components
|
If this parameter value is yes, then response will contain information on station components
|
yes | no
|
The default value is no
|
no
|
installed-components
|
If this parameter value is yes, then response will contain information on antivirus components installed at the station
|
yes | no
|
The default value is no
|
no
|
running-components
|
If this parameter value is yes, then response will contain information on antivirus components currently running at the station
|
yes | no
|
The default value is no
|
no
|
rights
|
If this parameter value is yes, then response will contain information on station rights
|
yes | no
|
The default value is no
|
no
|
group-membership
|
If this parameter value is yes, then response will contain information on groups in which the station is included
|
yes | no
|
The default value is no
|
no
|
modules
|
If this parameter value is yes, then response will contain information on antivirus modules installed at the station
|
yes | no
|
The default value is no
|
no
|
bases
|
If this parameter value is yes, then response will contain information on antivirus databases which are used at the station
|
yes | no
|
The default value is no
|
no
|
keys
|
If this parameter value is yes, then response will contain information on station license keys
|
yes | no
|
The default value is no
|
no
|
machines
|
If this parameter value is yes, then response will contain information on machines where Agent is installed.
|
yes | no
|
The default value is no
|
no
|
Request Example
http://192.168.1.1:9080/api/stations/info.ds?id=30cc7eb2-d11d-b211-b695-b80815e63511&components=yes&installed-components=yes&running-components=yes&rights=yes&group-membership=yes&modules=yes&keys=yes&bases=yes
Response Documents Structure
•XML response. •JSON response. XML Response Structure
<drweb-avdesk-api api_version="4.1.3" timestamp="1401791872" server="192.168.1.1" srv_version="10.01.0.201707130" status="true">
<stations total="1">
<station id="1002" name="station1234" created="1412665881" modified="1412665881"
grace_period="30"
parent_id="1" parent_name="mygr1" password="123456" state="0">
<rate id="01fe9e60-6570-11de-b827-0002a5d5c51b">Dr.Web Premium Server</rate>
<expires>0</expires>
<blocking>
<begin>0</begin>
<end>0</end>
</blocking>
<user-id>user1</user-id><lastseenat>0</lastseenat>
<lastseenfrom></lastseenfrom>
<os code="0">unknown</os>
<department>department123</department>
<description>description</description>
<country>RU</country>
<street>street123</street>
<room>room123</room>
<city>city123</city>
<floor>floor123</floor>
<longitude>38898555</longitude>
<latitude>1077037852</latitude>
<organization>organization123</organization>
<province>province123</province>
<email>mail@mail.ru</email>
<connection port="2193" server="192.168.1.1">
<public_key url="http://192.168.1.1:9080/install/drwcsd.pub" uuid="432a295a-ad54-46c0-829c-474341f369dc"><![CDATA[; Dr.Web (R) Public key file ; Do not edit! 432a295a-ad54-46c0-829c-474341f369dcCE74CA68569824B7FF74A452F3D173C2C42CAFF0D046E2328439EE2CF0B4344F85B1B9B2B79D56DB28C7EB0FC94130F6AB43ABCD5E019EA815E5FC53EA3C6A9C; ***EOF***]]></public_key>
</connection>
<config><![CDATA[http:///192.168.1.1:9080/download/download.ds?code=gGNtByEyYydTpin]]></config>
<packages>
<package arch="all" os="windows" url="http://192.168.1.1:9080/download/download.ds?os=windows&id=1002"/>
<package arch="all" os="macosx" url="http://192.168.1.1:9080/download/download.ds?os=macosx&id=1002"/>
<package arch="x86" os="linux" url="http://192.168.1.1:9080/download/download.ds?os=linux&arch=x86&id=1002"/>
<package arch="x86_64" os="linux" url="http://192.168.1.1:9080/download/download.ds?os=linux&arch=x86_64&id=1002"/>
<package arch="all" os="android" url="http://192.168.1.1:9080/download/download.ds?os=android&id=1002"/>
</packages>
<acl priority="allow">
<allowed>
<address net_proto="tcp" net_mask="32">192.168.1.1</address>
</allowed>
<disallowed>
<address net_proto="tcp" net_mask="32">192.168.1.2</address>
</disallowed>
</acl>
<machines total="2">
<machine machine_id="xxxx" machine_name="TEST_PC" logged_time="1426759888" logged_address="tcp://192.168.10.10" />
<machine machine_id="yyyy" machine_name="TEST_PC2" logged_time="1426759888" logged_address="tcp://192.168.10.11" />
</machines>
</station>
</stations>
</drweb-avdesk-api>
|
|
When returning the information on deleted stations, the xml response 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,
<modules />—modules,
<group-membership />—membership in groups,
<config />—download link for config file with connection settings for mobile clients.
|
Description of XML Response Parameters
•The <stations /> element contains information about all stations. The <stations /> element attributes:
Attribute
|
Description
|
total
|
Total number of stations
|
▫The <station /> element contains information about a specific station. The <stations /> element attributes:
Attribute
|
Description
|
id
|
Station identifier
|
name
|
Station name
|
created
|
Station creation date
|
modified
|
Last modification time
|
grace_period
|
Grace period (days)
|
parent_id
|
Station parent group identifier
|
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 attributes:
Attribute
|
Description
|
code
|
Operating system code
|
•Additional elements with station information:
Element
|
Description
|
<expires>
|
Date and time of expiration
|
<department>
|
Department
|
<description>
|
Description
|
<country>
|
Country
|
<street>
|
Street
|
<room>
|
Room
|
<city>
|
City
|
<floor>
|
Floor
|
<longitude>
|
Longitude
|
<latitude>
|
Latitude
|
<organization>
|
Organization
|
<province>
|
Province
|
<user-id>
|
User identifier
|
<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
|
ID of the public key
|
•The <config /> element contains link for downloading configuration file with connection parameters for mobile clients. •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. |
os
|
Operating system on which the package can be installed
|
url
|
URL for the package (Agent) downloading
|
•The <modules /> element contains information about all program modules. The <modules /> element attributes:
Attribute
|
Description
|
total
|
Total number of modules
|
▫The <module /> element contains information about a specific program module. The <module /> element attributes:
Attribute
|
Description
|
created
|
Module creation date
|
file_name
|
File name
|
file_size
|
File size in bytes
|
file_owner
|
Name of a file owner
|
hash
|
Module checksum
|
modified
|
Module last modified date
|
name
|
Module name
|
version
|
Module version
|
•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 about a specific key. The <key /> element attributes:
Attribute
|
Description
|
id
|
Key identifier
|
•The <bases /> element contains information about all virus databases. The <bases /> element attributes:
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 <installed-components /> element contains information about all installed components. The <installed-components /> element attributes:
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
|
Component name. 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 attributes:
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
|
Component name. See the Component codes section
|
started
|
Component start time in the UNIX timestamp format
|
type
|
Component type. See the Component codes section
|
user
|
Station user on behalf of which the component was launched
|
params
|
Component launch parameters
|
•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 contains information about a specific component. The <component /> element attributes:
Attribute
|
Description
|
code
|
Digital code of the component. See the Component codes section.
|
name
|
Component name. See the Component codes section.
|
status
|
Component status. May take one of the following values:
•2—component must be installed, •1—component can be installed, •0—component cannot be installed. |
•The <group-membership /> element contains information about all groups to which the station is the member. The <group-membership /> element attributes:
Attribute
|
Description
|
total
|
Total number of groups
|
▫The <group /> element contains information about a specific group. The <group /> element attributes:
Attribute
|
Description
|
id
|
Group ID
|
name
|
Group name
|
type
|
Group type. Can take one of 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 deinstalled Agent, •7—group containing stations with expired access to the Server, •10—pseudogroup, •11—tariff group. |
•The <acl> element contains access control lists that specify limitations on network addresses from which the Agent may access the Server. The <acl> element attributes:
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. •The <machines> element contains information about all machines where Agent is installed. The <machines> element attributes:
Attribute
|
Description
|
total
|
Total number of machines
|
▫The <machine /> element contains information about a specific machine where Agent is installed. The <machine /> element attributes:
Attribute
|
Description
|
machine_id
|
Security identifier (SID) of the machine
|
machine_name
|
NetBios or domain name of the machine
|
logged_time
|
Date of the last connection to the Server from this machine
|
logged_address
|
Address from which the Agent stalled on this machine connected to the Server last time
|
JSON Response Structure
{
"head": {
"status": true,
"timestamp": 1412666672,
"api": {
"version": 40103
},
"server": {
"name": "192.168.1.1",
"version": 1000201707130,
"uuid": "4a9779ec-285b-4782-9573-123007bdc055"
}
},
"data": {
"total": 1,
"list": [
{
"id": "1002",
"name": "station1234",
"parent_id": "1",
"parent_name": "mygr1",
"password": "123456",
"state": 0,
"tariff_id": "01fe9e60-6570-11de-b827-0002a5d5c51b",
"tariff_name": "Dr.Web Premium Server",
"grace_period": {
"inherited_group_id": "01fe9e60-6570-11de-b827-0002a5d5c51b",
"inherited_group_name": "Dr.Web Premium Server",
"inherited": true,
"grace_period": 30
},
"block_begin_time": 0,
"block_end_time": 0,
"expires_time": 0,
"user_id": "user1",
"last_seen_time": 0,
"last_seen_addr": null,
"connection": {
"port": 2193,
"public_key": {
"id": "432a295a-ad54-46c0-829c-474341f369dc",
"url": "http://192.168.1.1:9080/install/drwcsd.pub",
"file": "; [^] Dr.Web (R) Public key file\n; Do not edit!\n432a295a-ad54-46c0-829c-474341f369dc\nCE74CA68569824B7FF74A452F3D173C2C42CAFF0D046E2328439EE2CF0B4344F\n85B1B9B2B79D56DB28C7EB0FC94130F6AB43ABCD5E019EA815E5FC53EA3C6A9C\n; ***EOF***\n"
},
"server": "192.168.1.1"
},
"packages": [
{
"url": "http://192.168.1.1:9080/download/download.ds?os=windows&id=1002",
"os": "windows",
"arch": "all"},{
"url": "http://192.168.1.1:9080/download/download.ds?os=macosx&id=1002",
"os": "macosx",
"arch": "all"},{
"url": "http://192.168.1.1:9080/download/download.ds?os=linux&arch=x86&id=1002",
"os": "linux",
"arch": "x86"},{
"url": "http://192.168.1.1:9080/download/download.ds?os=linux&arch=x86_64&id=1002",
"os": "linux",
"arch": "x86_64"},{
"url": "http://192.168.1.1:9080/download/download.ds?os=android&id=1002",
"os": "android",
"arch": "all"
}],
"config_url": "http://192.168.1.1:9080/download/download.ds?code=dNsVhpy1KYtK2RQMvE",
"department": "department123",
"description": "description",
"country": "RU",
"street": "street123",
"room": "room123",
"city": "city123",
"floor": "floor123",
"longitude": 38898555,
"latitude": 1077037852,
"organization": "organization123",
"province": "province123",
"email": "mail@mail.ru",
"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,
"machines": [ {
"machine_id": "xxxx",
"machine_name": "TEST_PC",
"logged_time": "1426759878",
"logged_address": "tcp://192.168.10.13" },{
"machine_id": "yyy",
"machine_name": "TEST_PC2",
"logged_time": "1426759888",
"logged_address": "tcp://192.168.10.11"}]}]}}
|
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
|
id
|
Station identifier
|
name
|
Station name
|
password
|
Password for access to the Server
|
created_time
|
Station creation date
|
modified_time
|
Last modification time
|
parent_id
|
Station parent group identifier
|
parent_name
|
Station parent group name
|
grace_period
|
Grace period (days)
|
last_seen_time
|
Time of a last connection of a station to the Server
|
last_seen_addr
|
Address from which the station connected to the Server at the last time
|
state
|
The current state of the station. See Returned station state codes.
|
config_url
|
Download link for config file with connection settings for mobile clients
|
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
|
os_code
|
Operating system code
|
os_name
|
Operating system name
|
user_id
|
User identifier
|
•The connection block contains Server connection parameters. The connection block elements:
Field name
|
Description
|
port
|
Port number for connecting to the Server
|
server
|
DNS name or IP address of the Server
|
▫The public_key block contains information on the Server public encryption key and the key itself. The public_key block elements:
Field name
|
Description
|
url
|
Address of a public key location on the Server
|
uuid
|
ID of the public key
|
•The packages array block contains links on 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
|
URL for the package (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 the components are inherited from a parent group, and if set to false—then the components 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, then this value will be none.
|
inherited_group_name
|
Name of a parent group from which the key parameters have been inherited. If the inherited value is set to false, then 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
|
Component name. See the Component codes section.
|
status
|
Component status. May take one of the following values:
•2—component must be installed, •1—component can be installed, •0—component cannot 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
|
Component name. 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
|
Component name. See the Component codes section.
|
started_time
|
Component start time in the UNIX timestamp format
|
type
|
Component type. 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 in 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
|
id
|
Group ID
|
name
|
Group name
|
type
|
Group type. Can take one of 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 deinstalled Agent, •7—group containing stations with expired access to the Server, •10—pseudogroup, •11—tariff group. |
•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, 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 field value is set to false, then 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, then 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
|
Key identifier
|
•The acl block contains access control lists that specify limitations on network addresses from which the Agent may access the Server. The acl block elements:
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.
•The machines array contains information about all machines where Agent is installed. Elements in the machines array:
Field name
|
Description
|
machine_id
|
Security identifier (SID) of the machine
|
machine_name
|
NetBios or domain name of the machine
|
logged_time
|
Date of the last connection to the Server from this machine
|
logged_address
|
Address from which the Agent stalled on this machine connected to the Server last time
|
|
