|
Request Parameters
Parameter
|
Description
|
Mandatory
|
id
|
Group ID.
Response contains information about all stations in the specified group (ignoring the nested ones). A list of stations can be obtained for system groups.
|
yes
|
page
|
Page number to be returned in a response, in paged view (can be used to display information about a large number of stations).
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).
Default value is 100.
|
no
|
server-id
|
Dr.Web Server ID the information is requested from.
|
no
|
station-type
|
Information about station type to be returned in the response.
Default value: no.
|
no
|
subgroups
|
If the value is yes, the stations of nested subgroups will be displayed in addition to stations of the group from the id parameter. If system groups are specified in the id parameter, all stations will always be displayed.
Default value: no.
|
no
|
show-blocked-stations
|
If the value is no, the blocked stations will not be displayed.
Default value: yes.
|
no
|
Request Example
https://192.168.1.1:9081/api/groups/stations-list.ds?id=20e27d73-d21d-b211-a788-85419c46f0e6&per-page=1&station-type=yes
|
XML and JSON response structure examples are described below.
XML Response Structure
The id parameter specifies a group that contains common stations (not virtual agents or scanning servers), and the station-type parameter is used in the request.
<drweb-...>
<stations total="1">
<station...>
<station_type_info station_type="0"/>
</station>
</stations>
<pages.../>
</drweb-...>
|
The id parameter specifies a group that contains virtual agents or scanning servers, and the station-type parameter is used in the request.
<drweb-es-api api_version="4.3.2" timestamp="1699624500" server="192.168.1.1" srv_version="13.00.1.202310121" status="true">
<stations total="1">
<station id="s1" name="s1003" last_seen_time="1699623066" last_seen_addr="tcp://10.0.2.2:38066" state="1" os="16842752" os_name="Linux" login_addr="10.0.2.2" login_mac="08:00:27:17:16:f0" createtime="20231110132600486" blockbeg="0" blockend="0">
<station_type_info station_type="2">
<station id="s2" name="DESKTOP-1" station_type="1"/>
</station_type_info>
</station>
</stations>
<pages total="2" current="1" objects-per-page="1"/>
</drweb-es-api>
|
Description of XML Response Parameters
•The <stations /> element contains a list of stations in a group specified in the request.
The <stations /> element attribute:
Attribute
|
Description
|
total
|
Total number of stations in the specified group
|
▫The <station /> element contains parameters of a specific station in a group.
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
|
Address from which the station connected to the Dr.Web Server the last time
|
state
|
Current state of a station (see Appendix D. Returned Station State Codes)
|
os
|
Operating system code
|
os_name
|
Operating system name
|
login_addr
|
Station IP address
|
login_mac
|
MAC address of the station's network interface
|
createtime
|
Date and time of station creation
|
blockbeg
|
Date and time when station blocking starts
|
blockend
|
Date and time when station blocking ends
|
•The <station_type_info /> element contains information about station type. If the station is a Virtual agent, it contains a list of Scanning servers. If the station is a Scanning server, it contains a list of Virtual agents. If this is a station, then the list is empty.
The <station_type_info /> element attributes:
Attribute
|
Description
|
station_type
|
Station type:
•0 — full agent,
•1 — Virtual agent,
•2 — Scanning server. |
•The <station /> element contains parameters of a specific station.
The <station /> element attributes:
Attribute
|
Description
|
id
|
Station ID
|
name
|
Station name
|
station_type
|
Station type:
•0 — full agent,
•1 — Virtual agent,
•2 — Scanning server. |
•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
The id parameter specifies a group that contains common stations (not a virtual agents or a scanning servers), and the station-type parameter is used in the request.
{"data": {
"stations": {
"total":1,
"list":[
{...
"name": ...,
...
"station_type_info":{
"list":[],
"station_type":0}}]},
"pages": ...
|
The id parameter specifies a group that contains virtual agents or scanning servers, and the station-type parameter is used in the request.
{"data":{
"pages":{
"current":1,
"objects_per_page":1,
"total":2},
"stations":{
"list":[
{"blockbeg":0,
"blockend":0,
"createtime":20231110132600486,
"id":"s1",
"last_seen_addr":"tcp://10.0.2.2:38066",
"last_seen_time":1699623066,
"login_addr":"10.0.2.2",
"login_mac":"08:00:27:17:16:f0",
"name":"s1003",
"os_code":16842752,
"os_name":"Linux",
"state":1,
"station_type_info":{
"list":[
{"id":"s2",
"name":"DESKTOP-1",
"station_type":1}],
"station_type":2}}],
"total":1}},
"head":{
"api":{
"version":40302,
"versionString":"4.3.2"},
"server":{
"name":"192.168.1.1",
"uuid":"b35d999d-9212-481d-af8c-8551c4113383",
"version":"13.00.1.202310121"},
"status":true,
"timestamp":1699624578}}
|
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 a list of stations in a group specified in the request.
The stations block elements:
Field name
|
Description
|
total
|
Total number of stations in the specified group
|
list
|
Array of parameters for each station in a group
|
▫Each object of the list array contains parameters of a specific station in the specified group.
Elements in the list array:
Field name
|
Description
|
id
|
Station ID
|
name
|
Station name
|
last_seen_time
|
Time of last connection to the Dr.Web Server
|
last_seen_addr
|
Address from which the station connected to the Dr.Web Server last time
|
state
|
Current state of a station (see Appendix D. Returned Station State Codes)
|
os_code
|
Operating system code
|
os_name
|
Operating system name
|
login_addr
|
Station IP address
|
login_mac
|
MAC address of the station's network interface
|
createtime
|
Date and time of station creation
|
blockbeg
|
Date and time when station blocking starts
|
blockend
|
Date and time when station blocking ends
|
station_type_info
|
Contains information about station type.
|
•The <station_type_info /> block contains information about station type. If the station is a Virtual agent, it contains a list of Scanning servers. If the station is a Scanning server, it contains a list of Virtual agents. If this is a station, then the list is empty.
Elements in the <station_type_info /> array:
Field name
|
Description
|
station_type
|
Station type:
•0 — full agent,
•1 — Virtual agent,
•2 — Scanning server. |
list
|
An array of parameters for each station.
|
▫Each object of the list array contains parameters of a specific station.
Elements in the list array:
Field name
|
Description
|
id
|
Station ID
|
name
|
Station name
|
station_type
|
Station type:
•0 — full agent,
•1 — Virtual agent,
•2 — Scanning server. |
|