Scan Cancel

Base URL

https://{SERVER}/api/?apikey={yourAPIkey}&service=mav_scan_cancel

Description

Cancel a Managed Antivirus scan on the specified device.

Parameters

Required parameters

Add required parameters immediately after the base URL.

https://{SERVER}/api/?apikey={yourAPIkey}&service=mav_scan_cancel&required_parameters={parameter-value}

Parameter	Description	Type	Options	Default
deviceid	The deviceid must be a valid device id.	integer	0	0

Optional parameters

Add optional parameters after the required parameters in the base URL.

https://{SERVER}/api/?apikey={yourAPIkey}&service=mav_scan_cancel&required_parameters={parameter-value}&optional_parameters={parameter-value}

Parameter	Description	Type	Options	Default
describe	Optional. Returns a description of the entered call, the available parameters, an example of its output, and returned fields with descriptions.	boolean	true	0

Determine parameter values

Use the following associated service calls to determine parameter values.

Parameter	Call	URL Format
deviceid	list_devices_at_client	https://{SERVER}/api/?apikey=yourAPIkey&service=list_devices_at_client&clientid=CLIENTID&devicetype=server
	list_servers	https://{SERVER}/api/?apikey=yourAPIkey&service=list_servers&siteid=SITEID
	list_workstations	https://{SERVER}/api/?apikey=yourAPIkey&service=list_workstations&siteid=SITEID
siteid	list_sites	https://{SERVER}/api/?apikey=yourAPIkey&service=list_sites&clientid=CLIENTID
clientid	list_clients	https://{SERVER}/api/?apikey=yourAPIkey&service=list_clients

Examples

Cancel a scan on a device

https://{SERVER}/api/?apikey={yourAPIkey}&service=mav_scan_cancel&deviceid=DEVICEID

Example response - Success

<?xml version="1.0" ?>
<result created="2024-08-25T15:54:05" host="SERVER" status="OK">
  <msg />
</result>

Example response - Failure

<?xml version="1.0" ?>
<result created="2024-08-25T15:54:05" host="SERVER" status="FAIL">
  <msg>Cannot execute action : scan is not running.</msg>
</result>

Returned fields

Field	Type	Can Be Empty	Description
msg	string	yes	Message related to the action status.