|
Request Parameters
Parameter
|
Description
|
Valid values
|
Mandatory
|
action-adware
|
Action on adware detection
|
•delete, •ignore, •quarantine—move to quarantine |
no
|
action-dialers
|
Action on dialers detection
|
•delete, •ignore, •quarantine—move to quarantine |
no
|
action-hacktools
|
Action on hacktools detection
|
•delete, •ignore, •quarantine—move to quarantine |
no
|
action-incurable-files
|
Action when infected object cannot be cured
|
•delete, •quarantine—move to quarantine |
no
|
action-infected-archive
|
Action on infected archives detection
|
•delete, •quarantine—move to quarantine |
no
|
action-infected-boot
|
Action on infected boot sectors detection
|
•cure, •report—send notification to the Server |
no
|
action-infected-container
|
Action on infected files containers detection
|
•delete, •quarantine—move to quarantine |
no
|
action-infected-files
|
Action on infected files detection
|
•cure, •delete, •quarantine—move to quarantine |
no
|
action-infected-mail
|
Action on infected email files detection
|
•ignore, •quarantine—move to quarantine |
no
|
action-jokes
|
Action on joke programs detection
|
•delete, •ignore, •quarantine—move to quarantine |
no
|
action-riskware
|
Action on riskware detection
|
•delete, •ignore, •quarantine—move to quarantine |
no
|
action-suspicious-files
|
Action on suspicious files detection
|
•delete, •ignore, •quarantine—move to quarantine |
no
|
id
|
Station identifier.
This parameter can be defined in the request several times to launch the scan on several stations at a time.
|
–
|
yes
|
reboot
|
Set automatic reboot of a user computer after the scan is completed if during the check infected objects detected and the cure process requires reboot of operating system
|
yes | no
|
no
|
type
|
Scan type.
Default is quick
|
•full—full scan, •quick—quick scan |
no
|
Request Example
http://192.168.1.1:9080/api/stations/start-scanner.ds?id=d071625c-d21d-b211-9bc4-bc02713bf843&id=70200e02-d21d-b211-8a39-a00ca2f8be36
|
XML and JSON response structure examples are described below.
XML Response
<drweb-es-api api_version="4.3.0" timestamp="1558521952" server="192.168.1.1" srv_version="12.00.0.201909260" status="true">
<stations total="2">
<station id="d071625c-d21d-b211-9bc4-bc02713bf843" status="initiated"/>
<station id="70200e02-d21d-b211-8a39-a00ca2f8be36" status="failed"/>
</stations>
</drweb-es-api>
|
Description of XML Response Parameters
The <stations /> element contains information on a result of scan launch at stations.
The <stations /> element attribute:
Attribute
|
Description
|
total
|
Number of stations with launched scan
|
•The <station /> element contains information on specific stations on which remote scan was launched. The <station /> element attributes:
Attribute
|
Description
|
id
|
Station identifier
|
status
|
The state of scan remote launch. May take the following values:
•delayed—scan launch is delayed, •failed—scan launch is failed, •initiated—scan is initiated. |
JSON Response
{ "head": {
"status": true,
"timestamp": 1558522040,
"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": {
"70200e02-d21d-b211-8a39-a00ca2f8be36": "failed",
"d071625c-d21d-b211-9bc4-bc02713bf843": "initiated"}}}
|
Description of JSON Response Parameters
The data block contains information on a result of scan launch on stations.
The data block elements:
Field name
|
Description
|
total
|
Number of stations with launched scan
|
•The list array contains information about specific stations, where remote scanning was launched. Elements in the list array:
Field name
|
Description
|
Identifier of a station on which remote scanning has been launched
|
Remote scanning process status. May take the following values:
•delayed—scan is delayed, •failed—scan is failed, •initiated—scan is initiated. |
|