Get a List of Stations in a Group

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 such system groups as Operating system, Status, Ungrouped.

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).

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

Dr.Web Server ID the information is requested from

no

 

Request Example

https://192.168.1.1:9081/api/groups/stations-list.ds?id=20e27d73-d21d-b211-a788-85419c46f0e6&per-page=2

XML and JSON response structure examples are described below.

 

XML Response Structure

<drweb-es-api api_version="4.3.0" timestamp="1588849735" server="192.168.1.1" srv_version="12.00.0.201909260" status="true">
  <stations total="2">
     <station id="1001" name="1001" last_seen_time="0" last_seen_addr="" state="0" os="0" os_name="unknown" login_addr="" login_mac="" expires="20200427210000000" createtime="20200402120322573" blockbeg="20200428210000000" blockend="20200429215959999"/>

     <station id="1" name="Android SDK built for x865d56" last_seen_time="1588001727" last_seen_addr="tcp://192.168.233.131:49285" state="2" os="17105152" os_name="Android Phone" login_addr="10.3.0.16" login_mac="02:00:00:44:55:66" expires="0" createtime="20200427081641436" blockbeg="0" blockend="0"/>
  </stations>

  <pages total="4" current="1" objects-per-page="2"/>
</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

expires

Date and time of client access expiration. The 0 value means unlimited access.

createtime

Date and time of station creation

blockbeg

Date and time when station blocking starts

blockend

Date and time when station blocking ends

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": {
    "status": true,

    "timestamp": 1588852235,

    "api": {
      "version": 40300,
      "versionString": 4.3.0},

    "server": {
      "name": "192.168.1.1",

      "version": "12.00.0.201909260",
      "uuid": "b35d999d-9212-481d-af8c-8551c4113383"}},

"data": {
    "pages": {
      "total": 4,
      "current": 1,

      "objects_per_page": 2},

    "stations": {
      "total": 2,

      "list": [
          {"id": "1001",
          "name": "1001",

          "last_seen_time": 0,

          "last_seen_addr": null,

          "state": 0,

          "os_code": 0,

          "os_name": "unknown",

          "login_addr": null,
          "login_mac": null,

          "createtime": 20200402120322573,

          "blockbeg": 20200428210000000,

          "blockend": 20200429215959999,
          "expires": 20200427210000000},

          {"id": "1",
          "name": "Android SDK built for x865d56",

          "last_seen_time": 1588001727,

          "last_seen_addr": "tcp://10.3.0.16:56247",

          "state": 2,

          "os_code": 17105152,

          "os_name": "Android Phone",

          "login_addr": "10.3.0.16",
          "login_mac": "02:00:00:44:55:66",

          "createtime": 20200427081641436,

          "blockbeg": 0,

          "blockend": 0,
          "expires": 0}]}}}

 

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

expires

Date and time of client access expiration. The 0 value means unlimited access.