|
Request Parameters
Parameter
|
Description
|
Mandatory
|
group-id
|
ID of a group, which includes the stations to be provided in a response.
The response contains information about all stations in the specified group (ignoring the nested ones).
|
no
|
page
|
Page number to be returned in a response, in paged view (can be used to display information about a large number of stations).
The default value is 1.
|
no
|
per-page
|
Number of stations per page in paged view (can be used to display information about a large number of stations).
The default value is 100.
|
no
|
server-id
|
ID of the Dr.Web Server the stations are connected to.
|
no
|
station-type
|
Station type:
•0 — full agent,
•1 — Virtual agent,
•2 — Scanning server.
This parameter can be used multiple times to get information about several types of stations. If the parameter is not specified, information about all types of stations will be returned.
|
no
|
Request Example
https://192.168.1.1:9081/api/stations/list-by-type.ds?station-type=1
|
XML and JSON response structure examples are described below.
XML Response Structure
<drweb-es-api api_version="4.3.2" timestamp="1640088998" server="localhost" srv_version="13.00.0.202005090" status="true">
<stations type="virtual_agent" total="2">
<station id="7abaef16-0e1e-4331-954f-8faa48165022" name="DESKTOP-mesh" last_seen_addr="tcp://10.0.2.2:57144" last_seen_time="1639644820" os="35851780" os_name="Windows 10 Enterprise"/>
<station id="d3e61524-2a9f-4f4a-8ebc-50ac2281dc53" name="DESKTOP-mesh-1" last_seen_addr="tcp://10.0.2.2:57086" last_seen_time="1638263222" os="35851780" os_name="Windows 10 Enterprise"/>
</stations>
<pages total="1" current="1" objects-per-page="100"/>
</drweb-es-api>
|
Description of XML Response Parameters
The <stations /> element contains information about all stations consistent with the request.
•Attribute of the <stations /> element:
Attribute
|
Description
|
total
|
Total number of stations with the requested type per page
|
type
|
•regular - full agent,
•virtual_agent - Virtual agent,
•scanning_server - Scanning server |
▫The <station /> element contains information about a specific station.
The <station /> element attributes:
Attribute
|
Description
|
id
|
Station ID
|
name
|
Station name
|
last_seen_time
|
Time of last connection to the Dr.Web Server
|
last_seen_addr
|
Network address from which a station connected to the Dr.Web Server the last time
|
os
|
Operating system code
|
os_name
|
Operating system name
|
•The <pages /> element contains information about the paged view.
The <pages /> element attributes:
Attribute
|
Description
|
total
|
Total number of pages
|
current
|
Current page number
|
objects-per-page
|
Max number of stations per page
|
JSON Response Structure
{"head":{
"api":{
"version":"40302",
"versionString":"4.3.2"},
"server":{
"name":"localhost",
"uuid":"54200799-9bb5-4079-805e-0431dc858d84",
"version":"13.00.0.202005090"},
"status":true,
"timestamp":1640089456},
"data":[{
"pages":{
"current":1,
"objects_per_page":100,
"total":1},
"stations":"virtual_agent":[{
"id":"7abaef16-0e1e-4331-954f-8faa48165022",
"last_seen_addr":"tcp://10.0.2.2:57144",
"last_seen_time":1639644820,
"name":"DESKTOP-mesh",
"os":35851780,
"os_name":"Windows 10 Enterprise"},{
"id":"d3e61524-2a9f-4f4a-8ebc-50ac2281dc53",
"last_seen_addr":"tcp://10.0.2.2:57086",
"last_seen_time":1638263222,
"name":"DESKTOP-mesh-1",
"os":35851780,
"os_name":"Windows 10 Enterprise"}]}}]}
|
Description of JSON Response Parameters
•The pages block contains information about the paged view.
The pages block elements:
Field name
|
Description
|
current
|
Current page number
|
objects_per_page
|
Max number of stations per page
|
total
|
Total number of pages
|
•The stations block contains arrays with information about all stations consistent with the request.
▫Every nested array contains parameters for a specific station with a certain type. Nested array name corresponds with the station type.
Object elements in a nested array:
Field name
|
Description
|
id
|
Station ID
|
last_seen_addr
|
Network address from which a station connected to the Dr.Web Server the last time
|
last_seen_time
|
Time of last connection to the Dr.Web Server
|
name
|
Station name
|
os
|
Operating system code
|
os_name
|
Operating system name
|
|