Get Server Statistics on Stations Scan

Request Parameters

Request does not contain parameters.

Request Example

http://192.168.1.1:9080/api/server/summary.ds

XML and JSON response structure examples are described below.

XML Response

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

<os>Linux</os>

<api_version>4.3.0</api_version>

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

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

<with_update_errors>0</with_update_errors>

Description of XML Response Parameters

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

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

Element	Description
<host />	Server domain name or IP address
<uuid />	Server identifier
<os />	Operating system
<uptime />	Time of uninterrupted operation
<platform />	Platform
<version />	Information on the branch of Server version
<api_version />	Information on the Dr.Web Web API version

•The <memory /> element contains information about the 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 Server

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

▫The <home-directory /> and <variable-directory /> contain information about the available disk space in the 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 on groups of stations registered at the 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 on stations registered at the Server.

The <stations /> element attribute:

Attribute	Description
total	Total number of stations

The <stations /> element elements:

Element	Description
<activated />	Number of activated stations
<online />	Number of online stations
<available />	Number of stations available to register
<licensed />	Limit for stations with activated license
<with_update_errors />	Number of stations with errors of antivirus software updates
<new />	Number of new stations with not installed antivirus software
<unactivated />	Number of unactivated stations
<deinstalled />	Number of stations with uninstalled antivirus software
<deleted />	Number of deleted stations
<newbies />	Number of newbies (which request the access to the Server)
<offline />	Number of offline stations

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

▫The <key /> element of the keys element contains information on a specific license key.

The <key /> element attributes:

Attribute	Description
id	Identifier of a key
user	User identifier
expires	License expiration date

•The <repository /> element contains information about a repository status. The <product /> element contain information on a specific product.

The <product /> element attributes:

Attribute	Description
code	Product code
name	Product name
modified_time	The date of last update in the Unix timestamp format
revision	Revision number
size	Revision size in bytes
files	Files number in revision
state	Product update status. May take the following values: •normal—the product is updated successfully, •frozen—the product update is frozen, •disabled—the product update is disabled.

JSON Response

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

"timestamp": 1558522035,

"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": {
"api_version": "4.3.0",

"host": "192.168.1.1",

"id": "27671337-e0b0-4f60-aeb0-ab1f2ca47f77",

"file_system": {
"home_directory": {
"free_space": 20358995968,

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

"var_dir": {
"free_space": 20358995968,

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

"groups": {
"customs": 57,
"systems": 174,
"total": 231},

"keys": [{
"expires": 1576492266,

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

"memory": {
"total": 311,

"free": 3944,
"used_by_server": 29},

"os": "Linux",

"platform": "Linux 4.15.0-23-generic x86_64; Debian GNU/Linux buster/sid; glibc 2.27",

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

"modified_time": 1557878400,

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

"revision": "12020190515000000",

"size": 256131,
"state": "normal"},

"10-drwbases": {
"files": 257,

"modified_time": 1557947246,

"name": "Dr.Web Virus Bases",

"revision": "12020190515190726",

"size": 177296553,
"state": "normal"},

"10-drwgatedb": {
"files": 119,

"modified_time": 1557947551,

"name": "SpIDer Gate Bases",

"revision": "12020190515191231",

"size": 247281865,
"state": "normal"},

"10-drwspamdb": {
"files": 17,

"modified_time": 1557909561,

"name": "AntiSpam Bases",

"revision": "12020190515083921",

"size": 2874094,
"state": "normal"},

"10-drwupgrade": {
"files": 17,

"modified_time": 1557878400,

"name": "Dr.Web Updater",

"revision": "12020190515000000",

"size": 24131358,
"state": "normal"},

"15-drwappcntrl": {
"files": 6,

"modified_time": 1020211200,

"name": "Application Control Bases",

"revision": "10020020501000000",

"size": 11596,
"state": "disabled"},

"20-drwagent": {
"files": 376,

"modified_time": 1557860828,

"name": "Dr.Web Agent for Windows",

"revision": "12020190514190708",

"size": 98154454,
"state": "normal"},

"20-drwandroid11": {
"files": 0,

"modified_time": 1020211200,

"name": "Dr.Web Agent for Android",

"revision": "10020020501000000",

"size": 0,
"state": "normal"},

"20-drwcs": {
"files": 1991,

"modified_time": 1557878400,

"name": "Dr.Web Server",

"revision": "12020190515000000",

"size": 401346488,
"state": "normal"},

"20-drwunix": {
"files": 0,

"modified_time": 1020211200,

"name": "Dr.Web Agent for UNIX",

"revision": "10020020501000000",

"size": 0,
"state": "normal"},

"40-drwproxy": {
"files": 0,

"modified_time": 1020211200,

"name": "Dr.Web Proxy Server",

"revision": "10020020501000000",

"size": 0,
"state": "normal"},

"70-drwextra": {
"files": 2,

"modified_time": 1020211200,

"name": "Dr.Web Enterprise products",

"revision": "10020020501000000",

"size": 31175,
"state": "disabled"},

"70-drwutils": {
"files": 1,

"modified_time": 1020211200,

"name": "Dr.Web administrative utilities",

"revision": "10020020501000000",

"size": 13340,
"state": "disabled"},

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

"modified_time": 1557878400,

"name": "Doctor Web News",

"revision": "12020190515000000",

"size": 23583584,
"state": "normal"}}},

"stations": {
"activated": 1,

"available": 4294967245,

"deinstalled": 0,

"deleted": 4 ,

"licensed": 4294967245,

"new": 45,

"newbies": 0,

"offline": 46,

"online": 0,

"total": 50,

"unactivated": 45,
"with_update_errors": 0},

"uptime": 60,
"version": "12.00.0.201909260"}}

Description of JSON Response Parameters

The data block contains general information about the Server.

The data block elements:

Field name	Description
api_version	Information on the Dr.Web Web API version
host	Server domain name or IP address
id	Server identifier
os	Operating system
platform	Platform
uptime	Time of uninterrupted operation
version	Information on the branch of Server version

•The file_system block contains information about the Server working directory.

▫The home_directory and variable_directory contain information about the available disk space in the 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 contains information on groups of stations registered at the Server.

The groups block elements:

Field name	Description
customs	User groups
systems	System groups
total	Total number of groups

•The keys block contains information on all license keys used by this Server.

The keys block elements:

Field name	Description
expires	License expiration date
id	Identifier of a key
user_name	User identifier

•The memory block contains information about the Server memory size.

The memory block elements:

Field name	Description
free	Free memory size
total	Total system memory size
used_by_server	Memory size used by the Server

•The repositories block contains information on the products in the repository.

▫The products blocks contains information about specific products, nested blocks names corresponding the product codes in the repository.

Elements in the products blocks:

Field name	Description
files	Files number in revision
modified_time	The date of last update in the Unix timestamp format
name	Product name
revision	Revision number
size	Revision size in bytes
state	Product update status. May take the following values: •normal—the product is updated successfully, •frozen—the product update is frozen, •disabled—the product update is disabled.

•The stations block contains information on stations registered at the Server.

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 antivirus software
deleted	Number of deleted stations
licensed	Limit for stations with activated license
new	Number of new stations with not installed antivirus software
newbies	Number of newbies (which request the access to the Server)
offline	Number of offline stations
online	Number of online stations
total	Total number of stations
unactivated	Number of unactivated stations
with_update_errors	Number of stations with errors of antivirus software updates