|
Request Parameters
Parameter
|
Description
|
Mandatory
|
action-adware
|
Action on adware detection:
•delete—delete, •ignore—ignore, •quarantine—move to Quarantine |
no
|
action-dialers
|
Action on dialers detection:
•delete—delete, •ignore—ignore, •quarantine—move to Quarantine |
no
|
action-hacktools
|
Action on hacktools detection:
•delete—delete, •ignore—ignore, •quarantine—move to Quarantine |
no
|
action-incurable-files
|
Action when infected object cannot be cured:
•delete—delete, •quarantine—move to Quarantine |
no
|
action-infected-archive
|
Action on infected archives detection:
•delete—delete, •quarantine—move to Quarantine |
no
|
action-infected-boot
|
Action on infected boot sectors detection:
•cure—cure, •report—send notification to the Dr.Web Server |
no
|
action-infected-container
|
Action on infected files containers detection:
•delete—delete, •quarantine—move to Quarantine |
no
|
action-infected-files
|
Action on infected files detection:
•cure—cure, •delete—delete, •quarantine—move to Quarantine |
no
|
action-infected-mail
|
Action on infected email files detection:
•ignore—ignore, •quarantine—move to Quarantine, •report—report |
no
|
action-jokes
|
Action on joke programs detection
•delete—delete, •ignore—ignore, •quarantine—move to Quarantine |
no
|
action-riskware
|
Action on riskware detection:
•delete—delete, •ignore—ignore, •quarantine—move to Quarantine |
no
|
action-suspicious-files
|
Action on suspicious files detection:
•delete—delete, •ignore—ignore, •quarantine—move to Quarantine |
no
|
id
|
Station identifier.
Parameter can be defined in a request several times to launch scanning on multiple stations at a time.
|
yes
|
reboot
|
Set automatic reboot of user’s computer after scanning has been completed if infected objects were detected during check and cure process requires reboot of operating system.
Valid values: yes | no.
|
no
|
type
|
Scan type.
Available values:
•full—full scan, •quick—quick scan. Default is quick.
|
no
|
Request Example
https://192.168.1.1:9081/api/stations/start-scanner.ds?id=1001&id=1002
|
XML and JSON response structure examples are described below.
XML Response Structure
<drweb-es-api api_version="4.3.0" timestamp="1587457437" server="192.168.1.1" srv_version="13.00.0.202005090" status="true">
<stations total="2">
<station id="1001" status="initiated"/>
<station id="1002" status="failed"/>
</stations>
</drweb-es-api>
|
Description of XML Response Parameters
The <stations/> element contains information on scanning start 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 on scanning start of a specific station. The <station /> element attributes:
Attribute
|
Description
|
id
|
Station identifier
|
status
|
Status of remote scanning start:
•delayed—scanning start is delayed, •failed—scan launch is failed, •initiated—scan is initiated. |
JSON Response Structure
{ "head": {
"status": true,
"timestamp": 1587458243,
"api": {
"version": 40300,
"versionString": 4.3.0},
"server": {
"name": "192.168.1.1",
"version": "13.00.0.202005090",
"uuid": "b35d999d-9212-481d-af8c-8551c4113383"}},
"data": {
"total": 2,
"list": {
"1002": "failed",
"1001": "initiated"}}}
|
Description of JSON Response Parameters
The data block contains information on scanning start on stations specified in a request.
The data block elements:
Field name
|
Description
|
total
|
Total number of stations in a response
|
list
|
Block with results of scanning start for each station
|
•The list block elements:
Field name
|
Description
|
Station ID
|
Status of remote scanning start:
•delayed—scanning is delayed, •failed—scan is failed, •initiated—scan is initiated. |
|