Request Parameters
Parameter
|
Description
|
Mandatory
|
group-id
|
ID of a group stations of which will be given in a response
|
no
|
server-id
|
ID of Dr.Web Server to which requested stations are connected.
By default, it is a current Dr.Web Server.
You can use child Dr.Web Servers connected to this Dr.Web Server.
|
no
|
Request Example
https://192.168.1.1:9081/api/stations/states.ds?group-id=6
|
XML and JSON response structure examples are described below.
XML Response Structure
<drweb-es-api api_version="4.3.2" timestamp="1587435676" server="192.168.1.1" srv_version="13.00.1.202310121" status="true">
<stations total="4">
<activated total="1"/>
<all total="4"/>
<deinstalled total="1"/>
<deleted total="0"/>
<new total="3"/>
<newbies total="0"/>
<offline total="4"/>
<online total="0"/>
<unactivated total="3"/>
<with_update_errors total="0"/>
</stations>
</drweb-es-api>
|
Description of XML Response Parameters
The <stations /> element contains information about all stations that match a request.
The <stations /> element attribute:
Attribute
|
Description
|
total
|
Total number of stations in a response
|
•The <stations /> element nested items:
Element
|
Attribute
|
Description
|
<activated />
|
total
|
Number of activated stations
|
<all />
|
total
|
Total number of stations in a group except deleted stations
|
<deinstalled />
|
total
|
Number of stations with removed anti-virus software
|
<deleted />
|
total
|
Number of deleted stations
|
<new />
|
total
|
Number of new stations where anti-virus software is not installed yet
|
<newbies />
|
total
|
Number of newbies (which request access to the Dr.Web Server)
|
<offline />
|
total
|
Number of offline stations
|
<online />
|
total
|
Number of online stations
|
<unactivated />
|
total
|
Number of unactivated stations
|
<with_update_errors />
|
total
|
Number of stations with anti-virus software update errors
|
JSON Response Structure
{ "head": {
"status": true,
"timestamp": 1587435498,
"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": {
"states": {
"total": 4,
"activated": 1,
"all": 4,
"deinstalled": 1,
"deleted": 0,
"new": 3,
"newbies": 0,
"offline": 4,
"online": 0,
"unactivated": 3,
"with_update_errors": 0}}}
|
Description of JSON Response Parameters
The states block nested in the data block contains information on all stations that match a request.
The states block elements:
Field name
|
Description
|
total
|
Total number of stations in a response
|
activated
|
Number of activated stations
|
all
|
Total number of stations in a group except deleted stations
|
deinstalled
|
Number of stations with removed anti-virus software
|
deleted
|
Number of deleted stations
|
new
|
Number of new stations where anti-virus software is not installed yet
|
newbies
|
Number of newbies (which request access to the Dr.Web Server)
|
offline
|
Number of offline stations
|
online
|
Number of online stations
|
unactivated
|
Number of unactivated stations
|
with_update_errors
|
Number of stations with anti-virus software update errors
|
|