F1. Get Station Information

 Top  Previous  Next

Request Parameters

Parameter

Description

Valid values

Note

Mandatory

id

Station ID

-

-

yes

components

If this parameter value is yes, then an XML reply will contain information on station components

yes, no

The default value is no

no

installed-components

If this parameter value is yes, then an XML reply 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 an XML reply 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 an XML reply will contain information on station rights

yes, no

The default value is no

no

group-membership

If this parameter value is yes, then an XML reply will contain information on groups in which the station is included

yes, no

The default value is no

no

extra-info

If this parameter value is yes, then an XML reply will contain additional information about station

yes, no

The default value is no

no

modules

If this parameter value is yes, then an XML reply 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 an XML reply will contain information on antivirus databases which are used at the station

yes, no

The default value is no

no

key

If this parameter value is yes, then an XML reply will contain information on license key for this station

yes, no

The default value is no

no

XML Reply Structure

<drweb-avdesk-api api_build="201305131" api_version="3.2.0" local_timestamp="1297940758" operation="stations-info" server="192.168.1.210" srv_branch="REL-1000-AV" srv_version="10.01.0.201707130" status="true" timestamp="1298011206">

<stations total="1">

<station created="1296128831"grace_period="0" id="8e2f16b3-76b9-453c-bb01-d97059e3d432" modified="1296211015" name="WINTEST" parent_id="20e27d73-d21d-b211-a788-85419c46f0e6" parent_name="Everyone" password="m9zNOTJ8ASBxq6ro" state="0">

<connection port="2193" server="WIN-5X96GHFNR0R">

<public_key url="http://WIN-5X96GHFNR0R:9080/install/drwcsd.pub" uuid="a02b900a-d21d-b211-a504-8004ed13fcde">

; Dr.Web (R) Public key file; Do not edit!

a02b900a-d21d-b211-504-8004ed13fcde2009fc0e8fd99d603737644f755246fe586e3cddf73507c5f5ec621008e8d2179517e82e8ce9b2fd3fab5af95c5a7320a07e4263a0e6d4ac07e38d6832844b01; ***EOF***

</public_key>

</connection>

<config>http://WIN-5X96GHFNR0R/download/download.ds?code=g42lsPiB5siG</config>

<packages>

<package arch="all" os="windows" url="http://ubuntu804x86:9080/download/download.ds?id=88cff595-ba73-4c88-99ec-f2a489de1c47"/>

<package arch="all" os="android" url="http://ubuntu804x86:9080/download/download.ds?id=88cff595-ba73-4c88-99ec-f2a489de1c47&os=android"/>

<package arch="all" os="macosx" url="http://ubuntu804x86:9080/download/download.ds?id=88cff595-ba73-4c88-99ec-f2a489de1c47&os=macosx"/>

<package arch="x86_64" os="linux" url="http://ubuntu804x86:9080/download/download.ds?id=88cff595-ba73-4c88-99ec-f2a489de1c47&os=linux&arch=x86_64"/>

<package arch="x86" os="linux" url="http://ubuntu804x86:9080/download/download.ds?id=88cff595-ba73-4c88-99ec-f2a489de1c47&os=linux&arch=x86"/>

</packages>

<rate id="91644cc3-1dc1-42dc-a41e-5ea001f5538d"><![CDATA AV+AS+PC]]></rate>

<url>http://ubuntu804x86:9080/download/download.ds?id=88cff595-ba73-4c88-99ec-f2a489de1c47</url>

 <lastseenat>20110217041605301</lastseenat>

 <lastseenfrom>tcp/192.168.1.243:57197</lastseenfrom>

 <os code="33753094">Windows 7 Ultimate x86</os>

 <expires>0</expires>

<blocking>

  <begin>0</begin>

  <end>0</end>

</blocking>

<acl>

<allowed>

  <address net_mask="32" net_proto="tcp">192.168.1.22</address>

  <address net_mask="24" net_proto="tcp">192.168.1.33</address>

</allowed>

<disallowed>

  <address net_mask="32" net_proto="tcp">192.168.1.1</address>

</disallowed>

</acl>

<department></department>

<description></description>

<country></country>

<street></street>

<room></room>

<city></city>

<floor></floor>

<longitude>0</longitude>

<latitude>0</latitude>

<organization></organization>

<province></province>

<modules total="34">

  <module created="1296129337" file_name="DRWAGNTD.EXE" file_size="5760296" hash="7af28bfd8c62fac5f45c6d362388df56" modified="1297374897" name="Dr.Web Agent" version="10.01.0.201707130" />

  <module created="1296129399" file_name="DRWEB32W.EXE" file_size="2072328" hash="d3acab7389857f721ae3482847804891" modified="1296129289" name="Dr.Web© Scanner for Windows" version="6.00.5.08312" />

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

  <module created="1296129338" file_name="dwsysinfo.exe" file_size="1173488" hash="7b9e87c646acf1ebb7ea08b4ffbff9f7" modified="1297374890" name="Dr.Web SysInfo" version="6.00.3.12201" />

  <module created="1296129338" file_name="htmlayout.dll" file_size="870696" hash="57fc4b5835838a6dff96ee9d0775f782" modified="1297374909" name="HTMLayout - embeddable HTML rendering and layout component" version="3.3.2.1" />

  </modules>

<bases total="90">

  <base created="1297374573" file_name="drw50001.vdb" version="500" viruses="24512" />

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

  <base created="1297374573" file_name="drwtoday.vdb" version="500" viruses="640" />

  </bases>

<components inherited="true" inherited_group_id="2888b7ff-3625-465e-bcb8-957de17f6458" inherited_group_name="AV">

  <component code="105" name="Dr.Web Firewall" status="1" />

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

  <component code="34" name="SpIDer Guard for Windows Server" status="1" />

  <component code="6" name="SpIDer Guard for Windows XP" status="1" />

  <component code="14" name="SpIDer Mail for Windows Workstations" status="1" />

  <component code="38" name="SpIDer Gate for Windows Workstations" status="0" />

  <component code="55" name="VadeRetro Antispam" status="0" />

  <component code="54" name="Dr.Web Parental Control" status="0" />

  <component code="103" name="Dr.Web Microsoft Outlook plugin" status="1" />

  </components>

<installed-components>

  <component code="103" installed="1296129398" name="Dr.Web Microsoft Outlook plugin" path="C:\Program Files\DrWeb AV-Desk" server="tcp/192.168.1.25:2193" />

  <component code="30" installed="1296129383" name="Dr.Web Agent for Windows" path="C:\Program Files\DrWeb AV-Desk" server="tcp/192.168.1.25:2193" />

  <component code="37" installed="1296129383" name="Dr.Web Agent Scanner for Windows" path="C:\Program Files\DrWeb AV-Desk" server="tcp/192.168.1.25:2193" />

  <component code="4" installed="1296129398" name="Dr.Web Scanner for Windows" path="C:\Program Files\DrWeb AV-Desk" server="tcp/192.168.1.25:2193" />

  <component code="57" installed="1296129398" name="SpIDer Guard G3 for Workstations" path="C:\Program Files\DrWeb AV-Desk" server="tcp/192.168.1.25:2193" />

  </installed-components>

  <running-components />

<rights inherited="true" inherited_group_id="2888b7ff-3625-465e-bcb8-957de17f6458" parent_name="AV">

  <right code="53" name="Uninstall Dr.Web Agent" value="1" />

  <right code="27" name="Disable self-protection" value="1" />

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

  <right code="8" name="Change SpIDer Mail for Windows Workstations configuration" value="1" />

  <right code="10" name="Stop SpIDer Mail for Windows Workstations" value="1" />

  </rights>

<group-membership total="2">

  <group id="a6473692-dbf2-c9de-480e-33c9afb0c9d1" name="Users" />

  <group id="20e27d73-d21d-b211-a788-85419c46f0e6" name="Everyone" />

  </group-membership>

  </station> </stations> </drweb-avdesk-api>

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 <station /> element attributes:

Attribute

Description

created

Station creation date

grace_period

Grace period (days)

id

Station ID

modified

Last modification time

name

Station name

parent_id

Station parent group ID

parent_name

Station parent group name

state

The current state of the station. Can take one of the following values:

•0—station is not logged in at the Server (offline).

•1—station is logged in at the Server (online).

•2—connection with the station is broken.

•3—Server is rebooting or shutting down.

•4—Agent had not respond on the ping request timely.

•5—waiting time of instruction execution is expired.

•6—antivirus package is uninstalled.

•7—antivirus software has been successfully installed on the station via the network installation but the station is not yet connected to the Server.

•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 link for configuration file downloading is valid for the 10 minutes after its creation.

To refresh the link, run the info.ds script repeatedly.

•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 certain antivirus package.

The <package /> element attributes:

Attribute

Description

arch

Architecture on which the package can be installed

os

Operating system on which the package can be installed

url

URL for the package (Agent) downloading

•The <url /> element contains a package (Agent) download link.

The <url /> element is outdated, and will be deleted in further versions. Link for downloading the package is in the <packages /> element.

In the current version of the XML API, the <url /> element value corresponds to the url attribute value from the <package os="windows" arch="all" /> element.

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

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

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

The <os /> element attributes:

Attribute

Description

code

Operating system code

•The <blocking> element contains information about station blocking. The <begin> element contains blocking start date while the <end/> element—its end date.

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

•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 (bytes)

hash

Module checksum

modified

Module last modified date

name

Module name

version

Module version

•The <bases /> element contains information about all antivirus databases.

The <bases /> element attributes:

Attribute

Description

total

Total number of antivirus databases

▫The <base /> element contains information about a specific antivirus database.

The <base /> element attributes:

Attribute

Description

created

Database creation date

file_name

Antivirus database file name

version

Database version

viruses

The number of viruses in the database

•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. See the Component codes section

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

The <installed-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 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 on the PC

path

Component installation path

server

Address of the server from which the component was installed

•The <rights /> element contains information about all rights of a tariff group.

The <rights /> element attributes:

Attribute

Description

inherited

If its value is set to true, then rights are inherited from a parent group, and if set to false, then rights are configured individually

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 /> 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. See the Rights section

•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

•The <key /> element contains information about a key encoded in MIME-base64.

The <key/> element attributes:

Attribute

Description

inherited

If its value is set to true, then the key is inherited from a parent group, and if set to false, then the key is configured individually

inherited_group_id

ID of a parent group from which the key has 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 has been inherited. If the inherited attribute is set to false, then this attribute value will be none