|
Request Parameter
Parameter
|
Description
|
Mandatory
|
id
|
Station ID.
This parameter can be defined in the request several times to get installed components lists for several stations at a time.
|
yes
|
Request Example
https://192.168.1.1:9081/api/stations/installed-components.ds?id=1002
|
XML and JSON response structure examples are described below.
XML Response Structure
<drweb-es-api api_version="4.3.2" timestamp="1589406161" server="192.168.1.1" srv_version="13.00.1.202310121" status="true">
<stations total="1">
<station id="1002">
<components total="11">
<component code="144" name="Preventive protection" installed="1589374270" path="C:\Program Files\DrWeb" server=""/>
<!-- etc. Skipped in documentation -->
<component code="154" name="Application Control" installed="1589388768" path="C:\Program Files\DrWeb" server=""/>
</components>
</station>
</stations>
</drweb-es-api>
|
Description of XML Response Parameters
The <stations /> element contains a list of components installed on stations specified in the request.
The <stations /> element attribute:
Attribute
|
Description
|
total
|
Total number of stations in a response
|
•The <station /> element contains information about a specific station.
The <station /> element attribute:
Attribute
|
Description
|
id
|
Station ID
|
▫The <components /> element contains information about all components installed on a station.
The <components /> element attribute:
Attribute
|
Description
|
total
|
Total number of components installed on a station
|
▪The <component /> element contains parameters of a specific installed component.
The <component /> element attributes:
Attribute
|
Description
|
code
|
Digital code of a component (see Appendix B2. Component Codes)
|
name
|
Name of a component (see Appendix B2. Component Codes)
|
installed
|
Component installation time
|
path
|
Component installation path
|
server
|
Address of the Dr.Web Server the component was installed from. For components installed from current Dr.Web Server, the server attribute would be empty.
|
JSON Response Structure
{ "head": {
"status": true,
"timestamp": 1589406077,
"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": {
"total": 1,
"list": [{
"components": [
{"code": 144,
"installed_time": 1589374270,
"name": "Preventive protection",
"path": "C:\\Program Files\\DrWeb",
"server": ""},
...,
{"code": 154,
"installed_time": 1589388768,
"name": "Application Control",
"path": "C:\\Program Files\\DrWeb",
"server": ""}],
"station_id": "1002"}]}}
|
Description of JSON Response Parameters
The data block contains a list of components installed on stations specified in the request.
The data block elements:
Field name
|
Description
|
total
|
Total number of stations in a response
|
list
|
Array with information about all components installed on each station
|
•Elements in the list array:
Field name
|
Description
|
components
|
Array with parameters for each component installed on a specific station
|
station_id
|
Station ID
|
▫Elements in the components array:
Field name
|
Description
|
code
|
Digital code of a component (see Appendix B2. Component Codes)
|
installed_time
|
Component installation time
|
name
|
Name of a component (see Appendix B2. Component Codes)
|
path
|
Component installation path
|
server
|
Address of the Dr.Web Server the component was installed from. For components installed from current Dr.Web Server, the server attribute would be empty.
|
|