|
Request Example
http://192.168.1.1:9080/api/server/info.ds
Response Documents Structure
•XML response. •JSON response. XML Response Structure
<drweb-avdesk-api api_version="4.1.3" timestamp="1403870387" server="192.168.1.1" srv_version="10.01.0.201707130" status="true">
<server-info>
<host>192.168.1.1</host>
<uuid>f014c311-66f1-4157-be32-4b0545f77c92</uuid>
<os>Linux</os>
<uptime>109940</uptime>
<platform>
<![CDATA[
Linux 2.6.32-23-pve x86_64; Debian GNU/Linux 7; glibc 2.13; NPTL 2.13
]]>
</platform>
<version>10.00.0.201406240</version>
<branch/>
<groups total="104">
<custom>12</custom>
<system>92</system>
</groups>
<stations total="3">
<licensed>5</licensed>
<available>2</available>
</stations></server-info></drweb-avdesk-api>
|
Description of XML Response Parameters
•The <server-info /> element contains information about the Server. The <server-info /> 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
|
<branch>
|
Information on the branch of Server version
|
▫The <groups /> element contains information on groups of stations registered at the Server. 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 on stations registered at the Server. The <stations /> element attributes:
Attribute
|
Description
|
total
|
Total number of stations
|
The <stations /> element elements:
Element
|
Description
|
<licensed>
|
Number of stations with activated license
|
<available>
|
Number of stations available to register
|
JSON Response Structure
{ "head": {
"status": true,
"timestamp":1410873611,
"api":{
"version":40103},
"server":{
"name":"192.168.1.1",
"version":1000201707130,
"uuid": "80c78bb1-c13c-e411-28f1-b8998b921767"}},
"data":{
"host":"192.168.1.1",
"id":"80c78bb1-c13c-e411-28f1-b8998b921767",
"os":"Windows_8",
"uptime":12888,
"platform":"Windows 8 x64 (Build 9600)",
"version":"10.01.0.201707130",
"api_version":"4.1.3",
"memory":{"free":1743,"total":3986},
"file_system":{"home_directory":{"free_space":1967701102592,"path":"C:/Program Files/DrWeb Server/var","total_space":2000029741056},"variable_directory":{"free_space":1967701102592,"path":"C:/Program Files/DrWeb Server","total_space":2000029741056}},
"groups":{
"total":115,
"customs":5,
"rates":14,
"systems":96
},
"stations": {"total":11,"licensed":4294967295,"available":4294967284}
}
}
|
Description of JSON Response Parameters
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
|
Information on the branch of Server version
|
api_version
|
Information on the Web API 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
|
•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
|
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
|
licensed
|
Number of stations with activated license
|
available
|
Number of stations available to register
|
|
