Get a List of Running Components

Request Parameter

Parameter

Description

Mandatory

id

Station ID.

Parameter can be defined in a request several times to get lists of currently running components for multiple stations at a time.

yes

 

Request Example

https://192.168.1.1:9081/api/stations/running-components.ds?id=1002

XML and JSON response structure examples are described below.

 

XML Response Structure

<drweb-es-api api_version="4.3.0" timestamp="1589407134" server="192.168.1.1" srv_version="12.00.0.201909260" status="true">
  <stations total="1">
     <station id="1002">
        <components total="7">
           <component code="30" name="Dr.Web Agent for Windows" params="" started="1589403171" type="8" user="NT AUTHORITY\SYSTEM"/>

          <!-- etc. Skipped in documentation -->

           <component code="38" name="SpIDer Gate for Windows workstations" params="" started="1589403177" type="8" user="NT AUTHORITY\SYSTEM"/>
        </components>
     </station>
  </stations>
</drweb-es-api>

 

Description of XML Response Parameters

The <stations/> element contains list of running components on stations specified in a 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 running components on a station.

The <components /> element attribute:

Attribute

Description

total

Total number of running components on a station

The <component /> element contains information about a specific running component.

The <component /> element attributes:

Attribute

Description

code

Numeric code of a component (see Appendix B2. Component Codes)

name

Name of a component (see Appendix B2. Component Codes)

params

Component run parameters

started

Component run time

type

Component running method:

1—run manually,

2—run by a scheduled task,

4—run by user,

8—run as system process.

user

Station user on behalf of whom a component was run

 

JSON Response Structure

{ "head": {
    "status": true,

    "timestamp": 1589407122,

    "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": {
    "total": 1,

    "list": [{
      "components": [
          {"code": 30,

          "name": "Dr.Web Agent for Windows",

          "params": "",

          "pid": "30",

          "started_time": 1589403171,

          "type": 8,
          "user": "NT AUTHORITY\\SYSTEM"},

          ...,

          {"code": 38,
          "name": "SpIDer Gate for Windows workstations",

          "params": "",

          "pid": "38",

          "started_time": 1589403177,

          "type": 8,
          "user": "NT AUTHORITY\\SYSTEM"}],
      "station_id": "1002"}]}}

 

Description of JSON Response Parameters

The data block contains list of running components on stations specified in a request.

The data block elements:

Field name

Description

total

Total number of stations in a response

list

Array with information about all running components for each station

Elements of objects in the list array:

Field name

Description

components

Array with parameters for each running component on a specific station

station_id

Station ID

Elements in the components array:

Field name

Description

code

Numeric code of a component (see Appendix B2. Component Codes)

name

Name of a component (see Appendix B2. Component Codes)

params

Component run parameters

pid

Process identifier at the station

started_time

Component run time

type

Component running method:

1—run manually,

2—run by a scheduled task,

4—run by user,

8—run as system process.

user

Station user on behalf of whom a component was run