|
Request Example
http://192.168.1.1:9080/api/server/summary.ds
Response Documents Structure
•XML response. •JSON response. XML Response Structure
<drweb-avdesk-api api_version="4.1.3" timestamp="1407727071" server="192.168.1.1" srv_version="10.01.0.201707130" status="true">
<server-summary>
<host>192.168.1.1</host>
<uuid>4f89e6b3-fa0c-43c8-934e-f118c50f1ba7</uuid>
<os>Linux</os>
<version>10.01.0.201707130</version>
<api_version>4.1.3</api_version>
<uptime>508537</uptime>
<platform>Linux 2.6.32-358.2.1.el6.x86_64 x86_64; CentOS release 6.4 (Final); glibc 2.12; NPTL 2.12</platform>
<memory>
<total>1024</total>
<free>125</free>
<used-by-server>0.0</used-by-server>
</memory>
<file-system>
<home-directory path="/opt/drwcs">
<total-space>81920</total-space>
<free-space> 71680</free-space>
</home-directory>
<variable-directory path="/var/opt/drwcs">
<total-space>81920</total-space>
<free-space> 71680</free-space>
</variable-directory>
</file-system>
<groups total="112">
<custom>1</custom>
<rate>12</rate>
<system>99</system>
</groups>
<stations total="10">
<deleted>0</deleted>
<with_update_errors>0</with_update_errors>
<newbies>0</newbies>
<expired>0</expired>
<unactivated>0</unactivated>
<online></online>
<blocked></blocked>
<activated>"0"</activated>
<offline>10</offline>
<deinstalled>0</deinstalled>
<new>10</new>
</stations>
<repository>
<product code="20-drwagent" name="Dr.Web Agent for Windows" modified_time="1405959793" revision="20140721162313" size="67368164" files="308"/>
<product code="10-drwspamdb" name="AntiSpam Bases" modified_time="1405959793" revision="20140721162313" size="1147126" files="17"/>
<product code="10-drwbases" name="Dr.Web Virus Bases" modified_time="1405959793" revision="20140721162313" size="142732031" files="225"/>
<product code="20-drwunix" name="Dr.Web Agent for UNIX" modified_time="946684800" revision="20000101000000" size="0" files="16"/>
<product code="10-drwgatedb" name="SpIDer Gate Bases" modified_time="1405959793" revision="20140721162313" size="90737075" files="93"/>
<product code="10-drwupgrade" name="Dr.Web Updater" modified_time="946684800" revision="20000101000000" size="13884558" files="16"/>
<product code="80-drwnews" name="Doctor Web News" modified_time="946684800" revision="20000101000000" size="1056" files="4"/>
<product code="20-drwcs" name="Dr.Web Server" modified_time="946684800" revision="20000101000000" size="0" files="12"/>
<product code="20-drwandroid" name="Dr.Web Agent for Android" modified_time="946684800" revision="20000101000000" size="171831" files="5"/>
</repository>
</server-summary>
</drweb-avdesk-api>
|
Description of XML Response Parameters
•The <server-summary /> element contains information about the Server. The <server-summary /> element elements:
Element
|
Description
|
<host>
|
Server domain name or IP address
|
<uuid>
|
Server identifier
|
<os>
|
Operating system
|
<uptime>
|
Time of uninterrupted operation
|
<platform>
|
Platform
|
<version>
|
The current Dr.Web AV-Desk build version
|
<api_version>
|
The current Web API build version
|
▫The <memory /> element contains information about the Server memory size. The <memory /> element elements:
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 attributes:
Attribute
|
Description
|
path
|
subdirectory path
|
The <home-directory /> and <variable-directory /> elements elements
Element
|
Description
|
<total-space>
|
Total disk space (in Megabytes)
|
<free-space>
|
Free disk space (in Megabytes)
|
▫The <groups /> element contains information about the groups The <groups /> element attributes:
Attribute
|
Description
|
total
|
Total number of groups
|
The <groups /> element elements:
Element
|
Description
|
<custom>
|
User groups
|
<rate>
|
Tariff groups
|
<system>
|
System groups
|
▫The <stations /> element contains information about the stations. The <stations /> element attributes:
Attribute
|
Description
|
total
|
Total number of stations in the group
|
The <stations /> element elements:
Element
|
Description
|
<deleted />
|
Number of deleted stations
|
<with_update_errors />
|
Number of stations with errors of antivirus software updates
|
<newbies />
|
Number of newbies (which request the access to the Server)
|
<expired />
|
Number of stations with expired access to the Server
|
<unactivated />
|
Number of unactivated stations
|
<online />
|
Number of online stations
|
<blocked />
|
Number of stations where access to the Server is blocked
|
<activated />
|
Number of activated stations
|
<offline />
|
Number of offline stations
|
<deinstalled />
|
Number of stations with uninstalled antivirus software
|
<new />
|
Number of new stations with not installed antivirus software
|
▫The <repository /> element contains information about the products in the repository. 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 revision update in the Unix timestamp format
|
revision
|
Revision number
|
size
|
Revision size in bytes
|
files
|
Files number in revision
|
JSON Response Structure
{ "head": {
"status": true,
"timestamp": 1407727635,
"api": {
"version": 40103
},
"server": {
"name": "192.168.1.1",
"version": 1000201707130,
"uuid": "4f89e6b3-fa0c-43c8-934e-f118c50f1ba7"
}
},
"data": {
"host": "192.168.1.1",
"id": "4f89e6b3-fa0c-43c8-934e-f118c50f1ba7",
"os": "Linux",
"uptime": 509138,
"platform": "Linux 2.6.32-358.2.1.el6.x86_64 x86_64; CentOS release 6.4 (Final); glibc 2.12; NPTL 2.12",
"version": "10.00.0.201407220",
"api_version": "4.1.3",
"memory": {
"total": 1024,
"free": 125
"used_by_server": 0.0
},
"file_system": {
"var_dir": {
"path": "/var/opt/drwcs",
"total_space": 81920,
"free_space": 71680
},
"home_dir": {
"path": "/opt/drwcs",
"total_space": 81920,
"total_space": 71680
}
}
"groups": {
"total": 112,
"customs": 1,
"rates": 12,
"systems": 99
},
"stations": {
"deleted": 0,
"with_update_errors": 0,
"newbies": 0,
"expired": 0,
"unactivated": 10,
"online": 0,
"total": 10,
"blocked": 0,
"activated": 0,
"offline": 10,
"deinstalled": 0,
"new": 10
},
"repository": {
"products": {
"20-drwagent": {
"revision": "20140721162313",
"name": "Dr.Web Agent for Windows",
"modified_time": 1405959793,
"files": 308,
"size": 67368164
},
"10-drwspamdb": {
"revision": "20140721162313",
"name": "AntiSpam Bases",
"modified_time": 1405959793,
"files": 17,
"size": 1147126
},
"10-drwbases": {
"revision": "20140721162313",
"name": "Dr.Web Virus Bases",
"modified_time": 1405959793,
"files": 225,
"size": 142732031
},
},
"total": 9
}
}
}
|
Description of JSON Response Parameter
The data block contains general information about the Server.
The data block elements:
Field name
|
Description
|
host
|
Server domain name or IP address
|
id
|
Server identifier
|
os
|
Operating system
|
uptime
|
Time of uninterrupted operation
|
platform
|
Platform
|
version
|
The current Dr.Web AV-Desk build version
|
api_version
|
The current Web API build version
|
•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 file-system block contains information about the Server working directory. ▫The home_dir and var_dir contain information about the available disk space in the working subdirectories. The home_dir and var_dir block elements:
Field name
|
Description
|
path
|
Subdirectory path
|
total_space
|
Total disk space (in Megabytes)
|
free_space
|
Free 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
|
rate
|
Tariff groups
|
systems
|
System groups
|
•The stations block contains information on stations registered at the Server. The stations block elements:
Field name
|
Description
|
total
|
Total number of stations
|
deleted
|
Number of deleted stations
|
with_update_errors
|
Number of stations with errors of antivirus software updates
|
newbies
|
Number of newbies (which request the access to the Server)
|
expired
|
Number of stations with expired access to the Server
|
unactivated
|
Number of unactivated stations
|
online
|
Number of online stations
|
blocked
|
Number of stations where access to the Server is blocked
|
activated
|
Number of activated stations
|
offline
|
Number of offline stations
|
deinstalled
|
Number of stations with uninstalled antivirus software
|
new
|
Number of new stations with not installed antivirus software
|
•The repositories block contains information on all products in the repository. ▫The list array contains information about specific products, nested blocks names corresponding the product codes in the repository. Elements in the list array:
Field name
|
Description
|
name
|
Repository name
|
modified_time
|
The date of last revision update in the Unix timestamp format
|
revision
|
Revision number
|
size
|
Revision size in bytes
|
files
|
Files number in revision
|
|
