Run a Group Scanning

Request Parameters

Parameter

Description

Mandatory

action-adware

Action on adware detection.

Valid values:

ignore,

delete,

quarantine—move to Quarantine.

no

action-dialers

Action on dialer detection

no

action-hacktools

Action on hacktool detection

no

action-incurable-files

Action when infected object cannot be cured.

Valid values:

delete,

quarantine—move to Quarantine.

no

action-infected-archive

Action on infected archive detection

no

action-infected-boot

Action on infected boot sector detection.

Valid values:

report—send notification to the Dr.Web Server,

cure,

no

action-infected-container

Action on infected file container detection

no

action-infected-files

Action on infected file detection.

Valid values:

cure,

delete,

quarantine—move to Quarantine.

no

action-infected-mail

Action on infected email file detection.

Valid values:

ignore,

quarantine—move to Quarantine.

no

action-jokes

Action on joke program detection

no

action-riskware

Action on riskware detection

no

action-suspicious-files

Action on suspicious file detection

Valid values:

ignore,

delete,

quarantine—move to Quarantine.

no

id

Group ID.

This parameter can be repeated any number of times per request to run scanning on stations in multiple groups at a time.

yes

reboot

Schedule automatic restart of a computer once the scanning is complete if any infected objects were found and operating system restart is required to complete the curing.

Valid values:yes | no.

no

type

Scan type.

Valid values:

full—full scan,

quick—quick scan.

Default is quick.

no

 

Request Example

https://192.168.1.1:9081/api/groups/start-scanner.ds?id=4

XML and JSON response structure examples are described below.

 

XML Response Structure

<drweb-es-api api_version="4.3.0" timestamp="1558521918" server="192.168.1.1" srv_version="12.00.0.201909260" status="true">
  <stations total="2">
     <station id="e8702ab1-a176-4aef-8660-f01851fcae80" status="initiated"/>
     <station id="1" status="failed"/>
  </stations>
</drweb-es-api>

 

Description of XML Response Parameters

The <stations /> element contains information about the scanning initiated in groups specified in the request.

The <stations /> element attribute:

Attribute

Description

total

Total number of stations in a response

The <station /> element contains information about the scanning initiated on a specific station.

The <station /> element attributes:

Attribute

Description

id

Station ID

status

Remote scanning run status:

delayed—scanning was delayed,

failed—scanning failed,

initiated—scanning was initiated.

 

JSON Response Structure

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

    "timestamp": 1558522001,

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

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

      "version": "12.00.0.201909260",
      "uuid": "27671337-e0b0-4f60-aeb0-ab1f2ca47f77"}},

"data": {
    "total": 2,

    "list": {
      "e8702ab1-a176-4aef-8660-f01851fcae80": "failed",
      "1": "initiated"}}}

 

Description of JSON Response Parameters

The data block contains information about the scanning initiated in groups specified in the request.

The data block elements:

Field name

Description

total

Total number of stations in a response

list

Block containing initiated scanning results for each station

The list block elements:

Field name

Description

Station ID

Remote scanning run status:

delayed—scanning was delayed,

failed—scanning failed,

initiated—scanning was initiated.