|
Request Parameters
This request does not contain any parameters.
Request Example
https://192.168.1.1:9081/api/server/info.ds
|
XML and JSON response structure examples are described below.
XML Response Structure
<drweb-es-api api_version="4.3.2" timestamp="1587050194" server="192.168.1.1" srv_version="13.00.1.202310121" status="true">
<server-info>
<host>192.168.1.1</host>
<uuid>b35d999d-9212-481d-af8c-8551c4113383</uuid>
<name>SRV Test</host>
<os>Linux</os>
<version>13.00.1.202310121</version>
<api-version>4.3.2</api-version>
<uptime>191400</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>824</free>
<used-by-server>14</used-by-server>
</memory>
<file-system>
<home-directory path="/opt/drwcs">
<total-space>28393443328</total-space>
<free-space>22584266752</free-space>
</home-directory>
<variable-directory path="/var/opt/drwcs">
<total-space>28393443328</total-space>
<free-space>22584266752</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>
<blocked>0</blocked>
<deinstalled>1</deinstalled>
<deleted>0</deleted>
<licensed>4294967295</licensed>
<new>2</new>
<newbies>0</newbies>
<offline>2</offline>
<online>1</online>
<total>3</total>
<unactivated>2</unactivated>
<with_update_errors>0</with_update_errors>
</stations>
</server-info>
</drweb-es-api>
|
Description of XML Response Parameters
The <server-info /> element contains information about the Dr.Web Server.
•Nested elements of the <server-info /> element:
Element
|
Description
|
<host />
|
Dr.Web Server domain name or IP address
|
<uuid />
|
Dr.Web Server ID
|
<name>
|
User Dr.Web Server name
|
<os />
|
Operating system name
|
<version />
|
Information on the branch of Dr.Web Server version
|
<api-version />
|
Information on the Dr.Web Enterprise Security Suite 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 (in megabytes)
|
<free />
|
Free memory size (in megabytes)
|
<used-by-server />
|
Size of memory used by Dr.Web Server (in megabytes)
|
•The <file-system /> element contains information about the Dr.Web Server working directory.
▫The <home-directory /> and <variable-directory /> elements 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 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 on stations registered at the Dr.Web Server.
The <stations /> element attribute:
Attribute
|
Description
|
total
|
Total number of stations
|
▫The <stations /> element elements:
Element
|
Description
|
<activated />
|
Number of activated stations
|
<available />
|
Number of stations available to register
|
<blocked />
|
Number of stations where access to the Dr.Web Server is blocked
|
<deinstalled />
|
Number of stations with uninstalled anti-virus software
|
<deleted />
|
Number of deleted stations
|
<licensed />
|
Limit for stations with activated license
|
<new />
|
Number of new stations with not installed anti-virus software
|
<newbies />
|
Number of newbies (which request the access to the Dr.Web 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 anti-virus software updates
|
JSON Response Structure
{ "head": {
"status": true,
"timestamp": 1587050230,
"api": {
"version": 40302,
"versionString": "4.3.2"},
"server": {
"name": "192.168.1.1",
"version": "13.00.1.202310121",
"uuid": "b35d999d-9212-481d-af8c-8551c4113383"},
"data": {
"host": "192.168.1.1",
"id": "b35d999d-9212-481d-af8c-8551c4113383",
"name": "SRV Test",
"os": "Linux",
"uptime": 191460,
"platform": "Linux 4.18.0-147.5.1.el8_1.x86_64 x86_64; glibc 2.28",
"version": "13.00.1.202310121",
"api_version": "4.3.2",
"memory": {
"free": 824,
"total": 3753,
"used_by_server": 14},
"file_system": {
"home_directory": {
"free_space": 22584172544,
"path": "/opt/drwcs",
"total_space": 28393443328},
"variable_directory": {
"free_space": 22584172544,
"path": "/var/opt/drwcs",
"total_space": 28393443328}},
"groups": {
"total": 143,
"customs": 1,
"systems": 142},
"stations": {
"activated": 1,
"available": 4294967292,
"blocked": 0,
"deinstalled": 1,
"deleted": 0,
"licensed": 4294967295,
"new": 2,
"newbies": 0,
"offline": 2,
"online": 1,
"total": 3,
"unactivated": 2,
"with_update_errors": 0}}}
|
Description of JSON Response Parameters
The data block contains general 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
|
name
|
User Dr.Web Server name
|
os
|
Operating system name
|
uptime
|
Time of uninterrupted operation
|
platform
|
Platform
|
version
|
Information on the current Dr.Web Server version
|
api_version
|
Current Web API version
|
memory
|
Block with information about the Dr.Web Server memory size
|
file-system
|
Block with information about the Dr.Web Server working directory
|
groups
|
Block with information on groups of stations registered at the Dr.Web Server
|
stations
|
Block with information on stations registered at the Dr.Web Server
|
•The memory block elements:
Field name
|
Description
|
total
|
Total system memory size (in megabytes)
|
free
|
Free memory size (in megabytes)
|
used_by_server
|
Size of memory used by Dr.Web Server (in megabytes)
|
•The file-system block contains nested home_directory and variable_directory blocks with 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 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
|
blocked
|
Number of stations where access to the Dr.Web Server is blocked
|
deinstalled
|
Number of stations with uninstalled anti-virus software
|
deleted
|
Number of deleted stations
|
licensed
|
Limit for stations with activated license
|
new
|
Number of new stations with not installed anti-virus software
|
newbies
|
Number of newbies (which request the access to the Dr.Web 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 anti-virus software updates
|
|