F2. Create a New Station

 Top  Previous  Next

Request Parameters

Parameter

Description

Note

id

Station ID

 

password

Password

 

rate

Tariff group

 

expires

Expiration date

0—unlimited,

otherwise—YYYYMMDDhhmmss

name

Station name

 

description

Description

 

room

Room

 

street

Street

 

city

City

 

floor

Floor

 

province

Province

 

department

Department

 

organization

Organization

 

latitude

Latitude

 

longitude

Longitude

 

block-begin

Blocking start date

Accepted format:

YYYYMMDD

or

YYYYMMDDHHmmss

block-end

Blocking end date

parent-group

Parent group

 

group

Groups

 

XML Reply Structure

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

<stations total="1">

<station created="1298006311" grace_period="0" id="0a642fa1-3e29-43c0-928d-9b7254a2bf07" modified="1298006311" name="0a642fa1-3e29-43c0-928d-9b7254a2bf07" parent_id="20e27d73-d21d-b211-a788-85419c46f0e6" parent_name="Everyone">

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

<url>

<![CDATA[

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

  ]]>

  </url>

  <lastseenat>0</lastseenat>

  <lastseenfrom />

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

  <expires>0</expires>

<blocking>

  <begin>0</begin>

  <end>0</end>

  </blocking>

<department>  </department>

<description>  </description>

<country>  </country>

<street>  </street>

<room>  </room>

<city>  </city>

<floor>  </floor>

<longitude>0  </longitude>

<latitude>0  </latitude>

<organization>  </organization>

<province>  </province>

<components inherited="true" inherited_group_id="91644cc3-1dc1-42dc-a41e-5ea001f5538d" inherited_group_name="AV+AS+PC">

  <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="1" />

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

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

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

  </components>

<rights inherited="true" inherited_group_id="91644cc3-1dc1-42dc-a41e-5ea001f5538d" inherited_group_name="AV+AS+PC">

  <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="0" />

  </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

▫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 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

Expiration date

department

Department

description

Description

country

Country

street

Street

room

Room

city

City

floor

Floor

longitude

Longitude

latitude

Latitude

organization

Organization

province

Province

▫The <components /> element contains information about all installing 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 /> contains information about a specific installing 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. See the Component codes section

▫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 /> contains information about a specific group.

The <group /> element attributes:

Attribute

Description

id

Group ID

name

Group name