Request Parameters
Request does not contain parameters.
Request Example
http://192.168.1.1:9080/api/server/info.ds
|
XML and JSON response structure examples are described below.
XML Response
<drweb-es-api api_version="4.3.0" timestamp="1558521945" server="192.168.1.1" srv_version="12.00.0.201909260" status="true">
<server-info>
<host>192.168.1.1</host>
<uuid>27671337-e0b0-4f60-aeb0-ab1f2ca47f77</uuid>
<os>Linux</os>
<version>12.00.0.201909260</version>
<api-version>4.3.0</api-version>
<uptime>60</uptime>
<platform>
<![CDATA[Linux 4.15.0-23-generic x86_64; Debian GNU/Linux buster/sid; glibc 2.27]]>
</platform>
<memory>
<total>3944</total>
<free>330</free>
<used-by-server>29</used-by-server>
</memory>
<file-system>
<home-directory path="/opt/drwcs">
<total-space>32392400896</total-space>
<free-space>20352274432</free-space>
</home-directory>
<variable-directory path="/var/opt/drwcs">
<total-space>32392400896</total-space>
<free-space>20352274432</free-space>
</variable-directory>
</file-system>
<groups total="231">
<custom>57</custom>
<system>174</system>
</groups>
<stations total="50">
<activated>1</activated>
<online>0</online>
<available>4294967245</available>
<licensed>4294967295</licensed>
<with_update_errors>0</with_update_errors>
<new>45</new>
<unactivated>45</unactivated>
<deinstalled>0</deinstalled>
<deleted>4</deleted>
<newbies>0</newbies>
<offline>46</offline>
</stations>
</server-info>
</drweb-es-api>
|
Description of XML Response Parameters
The <server-info /> element contains information about the Server.
•Nested elements of the <server-info /> element:
Element
|
Description
|
<host />
|
Server domain name or IP address
|
<uuid />
|
Server identifier
|
<os />
|
Operating system
|
<version />
|
Information on the branch of Server version
|
<api-version />
|
Information on the Dr.Web Web API version
|
<uptime />
|
Time of uninterrupted operation
|
<platform />
|
Platform
|
•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
|
JSON Response
{ "head": {
"status": true,
"timestamp": 1558522033,
"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",
"file_system": {
"home_directory": {
"free_space": 20359036928,
"path": "/opt/drwcs",
"total_space": 32392400896},
"variable_directory": {
"free_space": 20359036928,
"path": "/var/opt/drwcs",
"total_space": 32392400896}},
"groups": {
"total": 231,
"customs": 57,
"systems": 174},
"host": "192.168.1.1",
"id": "27671337-e0b0-4f60-aeb0-ab1f2ca47f77",
"memory": {
"free": 314,
"total": 3944,
"used_by_server": 29},
"os": "Linux",
"platform": "Linux 4.15.0-23-generic x86_64; Debian GNU/Linux buster/sid; glibc 2.27",
"stations": {
"activated": 1,
"available": 4294967245,
"deinstalled": 0,
"deleted": 4,
"licensed": 4294967295,
"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
|
total
|
Total number of groups
|
customs
|
User groups
|
systems
|
System groups
|
•The memory block contains information about the Server memory size. The memory block elements:
Field name
|
Description
|
total
|
Total system memory size
|
free
|
Free memory size
|
used_by_server
|
Memory size used by the Server
|
•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
|
|