Scan Cancel

Use this API Call to query our Data Extraction API to extract data gathered by N-sight RMM.This section shows the service name and parameters needed in the API Call query, and provides examples of some queries and system responses. For more information, see Data Extraction API.

Service name: mav_scan_cancel

URL

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

&required_parameters=required_parameters

[&optional_parameters=optional_parameters]

Description

Cancel a Managed Antivirus scan on the specified device

 

Parameters

Post Variable

Description

Type

Required

Options

Default

describe

Optional. Returns a description of the service.

boolean

no

true

0

deviceid

The deviceid must be a valid device id.

integer

yes

0

0

 

Example Service Call =mav_scan_cancel

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

Example Response: Success

<?xml version="1.0" ?>

<result created="2011-08-25T15:54:05" host="SERVER" status="OK">

 <msg />

</result>

Example Response: Failure

<?xml version="1.0" ?>

<result created="2011-08-25T15:54:05" host="SERVER" status="FAIL">

 <msg>Cannot execute action : scan is not running.</msg>

</result>

 

Fields Description

Field

Type

Can Be Empty

Description

msg

string

yes

Message related to the action status.

 

Example Associated Service Calls
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