|
Request Parameters
Parameter
|
Description
|
Valid values
|
Mandatory
|
id
|
Group identifier.
This parameter can be defined in the request several times to launch the scan on stations of several groups at a time.
|
-
|
yes
|
type
|
Scan type. Default is quick.
|
•full—full scan, •quick—quick scan. |
no
|
action-infected-files
|
Action on infected files detection
|
•cure, •delete, •quarantine—move to quarantine. |
no
|
action-suspicious-files
|
Action on suspicious files detection
|
•ignore, •delete, •quarantine—move to quarantine. |
no
|
action-incurable-files
|
Action when infected object cannot be cured
|
•delete, •quarantine—move to quarantine. |
no
|
action-infected-container
|
Action on infected files containers detection
|
no
|
action-infected-archive
|
Action on infected archives detection
|
no
|
action-infected-mail
|
Action on infected e-mail files detection
|
•ignore, •quarantine—move to quarantine. |
no
|
action-infected-boot
|
Action on infected boot sectors detection
|
•report—send notification to the Server, •cure. |
no
|
action-adware
|
Action on adware detection
|
•ignore, •delete, •quarantine—move to quarantine. |
no
|
action-dialers
|
Action on dialers detection
|
no
|
action-jokes
|
Action on joke programs detection
|
no
|
action-riskware
|
Action on riskware detection
|
no
|
action-hacktools
|
Action on hacktools detection
|
no
|
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
|
Request Example
http://192.168.1.1:9080/api/groups/start-scanner.ds?id=4
Response Documents Structure
•XML response. •JSON response. XML Response Structure
<drweb-avdesk-api api_version="4.1.3" timestamp="1391508276"
server="192.168.1.1" srv_version="10.01.0.201707130" status="true">
<stations total="2">
<station id="e8702ab1-a176-4aef-8660-f01851fcae80" status="initiated"/>
<station id="1" status="failed"/>
</stations>
</drweb-avdesk-api>
|
Description of XML Response Parameters
•The <stations /> element contains information on a result of scan launch at stations. The <stations /> element attributes:
Attribute
|
Description
|
total
|
Number of stations with launched scan
|
▫The <station /> element contains information on specific stations on which remote scan is 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 Structure
{ "head": {
"status": true,
"timestamp": 1392968145,
"api": {
"version": 40103
},
"server": {
"name": "192.168.1.1",
"version": 1000201707130,
"uuid": "7209d122-3b23-4134-94a9-0c1c645e21f3"
}
},
"data": {
"results": {
"success": [
"70200e02-d21d-b211-8a39-a00ca2f8be36"
],
"fail": []
}
}
}
|
Description of JSON Response Parameters
The results block contains information on a result of scan launch at groups.
The results block elements:
Field name
|
Description
|
success
|
Contains array with identifiers of stations on which remote scan is successfully initiated
|
fail
|
Contains array with identifiers of stations on which remote scan is failed
|
|
