Get Dr.Web Server Statistics on Station Scanning

Request Parameters

This request does not contain any parameters.

 

Request Example

https://192.168.1.1:9081/api/server/summary.ds

XML and JSON response structure examples are described below.

 

XML Response Structure

<drweb-es-api api_version="4.3.0" timestamp="1587165763" server="192.168.1.1" srv_version="12.00.0.201909260" status="true">
  <server-summary>
    <host>192.168.1.1</host>

    <uuid>b35d999d-9212-481d-af8c-8551c4113383</uuid>

    <os>Linux</os>

    <version>12.00.0.201909260</version>

    <api_version>4.3.0</api_version>

    <uptime>306961</uptime>

    <platform>
        <![CDATA[Linux 4.18.0-147.5.1.el8_1.x86_64 x86_64; glibc 2.28]]>
     </platform>

    <memory>
        <total>3753</total>

        <free>2000</free>
        <used-by-server>17</used-by-server>
    </memory>

    <file-system>
        <home-directory path="/opt/drwcs">
          <total-space>28393443328</total-space>
          <free-space>17384546304</free-space>
        </home-directory>

        <variable-directory path="/var/opt/drwcs">
          <total-space>28393443328</total-space>
          <free-space>17384546304</free-space>
        </variable-directory>
    </file-system>

    <groups total="143">
        <custom>1</custom>
        <system>142</system>
    </groups>

    <stations total="3">
        <activated>1</activated>

        <available>4294967292</available>

        <deinstalled>1</deinstalled>

        <expired>0</expired>

        <licensed>4294967295</licensed>

        <new>2</new>

        <newbies>0</newbies>

        <offline>3</offline>

        <online>0</online>

        <unactivated>2</unactivated>
        <with_update_errors>0</with_update_errors>

    </stations>

    <keys>
        <key id="daa669be6fdbca01" user="Dr.Web" expires="1612078293">
    </keys>

    <repository>
        <product code="05-drwmeta" name="Dr.Web Meta information" modified_time="1586995200" revision="13020200416000000" size="279704" files="14" state="normal" last_update_endtime="1587129960" last_update_src="Launched by Task Scheduler" last_update_rc="Requested product not found on GUS servers" last_update_rc_code="106"/>

        <!-- etc. Skipped in documentation -->
        <product code="80-drwnews" name="Doctor Web News" modified_time="1587092725"" revision="13020200417030525" size="21958741" files="1622" state="normal" last_update_endtime="1587131081" last_update_src="Launched from the Control Center" last_update_rc="Update completed successfully" last_update_rc_code="2"/>
    </repository>
  </server-summary>
</drweb-es-api>

 

Description of XML Response Parameters

The <server-summary /> element contains information about the Dr.Web Server.

Nested elements of the <server-summary /> element:

Element

Description

<host />

Dr.Web Server domain name or IP address

<uuid />

Dr.Web Server ID

<os />

Operating system

<version />

Current Dr.Web Server build

<api_version />

Current Web API version

<uptime />

Time of uninterrupted operation

<platform />

Platform

The <memory /> element contains information about the Dr.Web Server memory size.

Nested elements of the <memory /> element:

Element

Description

<total />

Total system memory size

<free />

Free memory size

<used-by-server />

Memory size used by the Dr.Web Server

The <file-system /> element contains information about the Dr.Web Server working directory.

Nested elements <home-directory /> and <variable-directory /> of the <file-system /> element contain information about the disk space available in working subdirectories.

The <home-directory /> and <variable-directory /> elements attribute:

Attribute

Description

path

Subdirectory path

Nested elements of the <home-directory /> and <variable-directory /> elements:

Element

Description

<total-space />

Total disk space (in megabytes)

<free-space />

Free disk space (in megabytes)

The <groups /> element contains information about station groups registered at the Dr.Web Server.

The <groups /> element attribute:

Attribute

Description

total

Total number of groups

Nested elements of the <groups /> element:

Element

Description

<custom />

User groups

<system />

System groups

The <stations /> element contains information about stations registered at the Dr.Web Server.

The <stations /> element attribute:

Attribute

Description

total

Total number of stations

Nested elements of the <stations /> element:

Element

Description

<activated />

Number of activated stations

<available />

Number of stations available to register

<deinstalled />

Number of stations with uninstalled anti-virus software

<deleted />

Number of deleted stations

<licensed />

Max number of stations with active license

<new />

Number of new stations with not yet installed anti-virus software

<newbies />

Number of newbie stations (requesting access to the Dr.Web Server)

<offline />

Number of offline stations

<online />

Number of online stations

<unactivated />

Number of not yet activated stations

<with_update_errors />

Number of stations with anti-virus software update errors

The <keys /> element contains information about license keys on the Dr.Web Server.

Nested element <key /> of the <keys /> element contains information about a specific license key.

The <key /> element attributes:

Attribute

Description

id

Key ID

user

User ID

expires

License expiration date

The <repository /> element contains information about the repository products.

Nested elements of the <product /> element contain information about a specific product in the repository.

The <product /> element attributes:

Attribute

Description

code

Product code

name

Product name

modified_time

Date of the last update

revision

Revision number

size

Revision size in bytes

files

Number of files in revision

state

Product update status:

normal—the product is updated successfully,

frozen—the product is frozen,

disabled—the product update is disabled.

last_update_endtime

Last update completion time

last_update_src

Update initiator

last_update_rc

Update results (see Appendix E. Returned Update Codes)

last_update_rc_code

Update result code (see Appendix E. Returned Update Codes)

 

JSON Response Structure

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

    "timestamp": 1587165759,

    "api": {
      "version": 40300,
      "versionString": 4.3.0},

    "server": {
      "name": "192.168.1.1",

      "version": "12.00.0.201909260",
      "uuid": "b35d999d-9212-481d-af8c-8551c4113383"}},

"data": {
    "host": "192.168.1.1",

    "id": "b35d999d-9212-481d-af8c-8551c4113383",

    "os": "Linux",

    "uptime": 306961,

    "platform": "Linux 4.18.0-147.5.1.el8_1.x86_64 x86_64; glibc 2.28",

    "version": "12.00.0.201909260",

    "api_version": "4.3.0",

    "memory": {
      "free": 2001,
      "total": 3753,

       "used_by_server": 17},

    "file_system": {
      "home_directory": {
          "free_space": 17384656896,

          "path": "/opt/drwcs",
          "total_space": 28393443328},

      "var_dir": {
          "free_space": 17384656896,

          "path": "/var/opt/drwcs",
          "total_space": 28393443328}},

    "groups": {
      "total": 143,

      "customs": 1,
      "systems": 142},

    "stations": {
      "activated": 1,

      "available": 4294967292,

      "deinstalled": 1,

      "deleted": 0,

      "licensed": 4294967295,

      "new": 2,

      "newbies": 0,

      "offline": 3,

      "online": 0,

      "total": 3,

      "unactivated": 2,
      "with_update_errors": 0},

    "keys": [{
      "expires": 1612078293,

      "id": "daa669be6fdbca01",
      "user_name": "Dr.Web"}],

    "repository": {
      "products": {
          "05-drwmeta": {
            "files": 14,

            "last_update_endtime": 1587129960,

            "last_update_rc": "Requested product not found on GUS servers",

            "last_update_rc_code": "106",

            "last_update_src": "Launched by Task Scheduler",

            "modified_time": 1586995200,

            "name": "Dr.Web Meta information",

            "revision": "13020200416000000",

            "size": 279704,
            "state": "normal"},

            ...,

          "80-drwnews": {
            "files": 1622,

            "last_update_endtime": 1587131081,

            "last_update_rc": "Update completed successfully",

            "last_update_rc_code": "2",

            "last_update_src": "Launched by Task Scheduler",

            "modified_time": 1587092725,

            "name": "Doctor Web News",

            "revision": "13020200417030525",

            "size": 21958741,
            "state": "normal"}}}}}

 

Description of JSON Response Parameters

The data block contains information about the Dr.Web Server.

The data block elements:

Field name

Description

host

Dr.Web Server domain name or IP address

id

Dr.Web Server ID

os

Operating system

uptime

Time of uninterrupted operation

platform

Platform

version

Current Dr.Web Server build

api_version

Current Web API version

memory

Block containing information about the Dr.Web Server memory size

file_system

Block containing information about the Dr.Web Server working directory

groups

Block containing information about station groups registered at the Dr.Web Server

stations

Block containing information about stations registered at the Dr.Web Server

keys

Block containing information about all license keys used by the Dr.Web Server

repository

Block containing information about products in the repository

The memory block elements:

Field name

Description

free

Free memory size

total

Total system memory size

used_by_server

Memory size used by the Dr.Web Server

The file_system block consists of nested blocks.

Nested blocks home_directory and variable_directory contain information about the disk space available in working subdirectories.

The home_directory and variable_directory block elements:

Field name

Description

free_space

Free disk space (in megabytes)

path

Subdirectory path

total_space

Total disk space (in megabytes)

The groups block elements:

Field name

Description

total

Total number of groups

customs

User groups

systems

System groups

The stations block elements:

Field name

Description

activated

Number of activated stations

available

Number of stations available to register

deinstalled

Number of stations with uninstalled anti-virus software

deleted

Number of deleted stations

licensed

Max number of stations with active license

new

Number of new stations with not yet installed anti-virus software

newbies

Number of newbie stations (requesting access to the Dr.Web Server)

offline

Number of offline stations

online

Number of online stations

total

Total number of stations

unactivated

Number of not yet activated stations

with_update_errors

Number of stations with anti-virus software update errors

Every object in the keys array contains information about a specific license key.

The keys array elements:

Field name

Description

expires

License expiration date

id

Key ID

user_name

User ID

The products element of the repository block consists of nested blocks.

Every nested block contains parameters of a specific product. Nested block name corresponds with a product code in the repository.

Nested block elements of the products element:

Field name

Description

files

Number of files in revision

last_update_endtime

Last update completion time

last_update_src

Update initiator

last_update_rc

Update results (see Appendix E. Returned Update Codes)

last_update_rc_code

Update result code (see Appendix E. Returned Update Codes)

modified_time

Date of the last update

name

Product name

revision

Revision number

size

Revision size in bytes

state

Product update status:

normal—the product is updated successfully,

frozen—the product is frozen,

disabled—the product update is disabled.