List Managed Antivirus Scans: list_mav_scans

Service name: list_mav_scans

https://SERVER/api/?apikey=yourAPItoken&service=list_mav_scans

&required_parameters=required_parameters

[&optional_parameters=optional_parameters]

Returns list of Managed Antivirus scans for a device; these could be in-progress or complete.

The information is available as summaries (details=NO) or with threats, quarantine and errors included (details=YES).

Parameters

Default

0

0

0

2

Example Service Call =list_mav_scans

https://SERVER/api/?apikey=yourAPItoken&service=list_mav_scans&deviceid=DEVICEID&details=DETAIL&v=VERSION

Example Responses

VIPRE engine: the following example response displays data for scans on a device running the Managed Antivirus VIPRE engine.

<?xml version="1.0" ?>

<result created="2012-04-05T10:48:40+01:00" host="SERVER" status="OK">

<scan>[example when details=YES]

<type>[one of: QUICK, DEEP, ACTIVE or CUSTOM]</type>

<status>[one of: NONE, PENDING, PENDING_AGENT, FINISHED, CANCELED, ERROR, PAUSED, RUNNING]</status>

<start>2013-01-15 05:41:55[UTC start time]</start>

<end>2013-01-15 05:41:55[UTC end time; only included if scanning complete]</end>

<cookies_scanned>0</cookies_scanned>

<registry_scanned>0</registry_scanned>

<files_scanned>1</files_scanned>

<folders_scanned>0</folders_scanned>

<processes_scanned>0</processes_scanned>

<threats>[only included when at least one threat is discovered AND details=YES]

<threat>

 <name>Worm.Win32.Downad.Gen (v)</name>

 <category>Worm.W32</category>

 <status>[one of: QUARANTINED, RELEASE_PENDING, RELEASED, DELETE_PENDING, DELETED, REPORTED, FAILED_TO_QUARANTINE, FAILED_TO_RELEASE, FAILED_TO_DELETE]</status>

 <quarantine>[only included when item(s) quarantined]

 <item>

  <guid>{55778734-483C-4BCF-A0F5-4C78ED28CBE1}</guid>

  <count>1[number of files (or other scanned entities) included with this quarantine item]</count>

  <deleted>[YES or NO]</deleted>

 </item>

[...more item entries if they exist...]

 </quarantine>

 <traces>

 <trace>

  <type>[one of: COOKIE, PROCESS, REGISTRY_ENTRY, FILE, FOLDER, ARCHIVE, PROCESS_MODULE, DEVICE_DRIVER, DLL_EXPORT, SYSTEM_DLL_EXPORT, MASTER_BOOT_RECORD, ROOTKIT, SYSTEM_MODULE, HOOK, UNKNOWN]</type>

  <description>[e.g. filename, or registry key with value, or reference to a process etc.]</description>

 </trace>

[...more trace entries if they exist...]

 </traces>

</threat>

[...more threat entries if they exist...]

</threats>

<errors>[only included if at least one scan error occurred AND details=YES]

<error>

 <item>[filename or identifier]</item>

 <reason>[scan error - see below]</reason>

</error>

[...more error entries if they exist...]

</errors>

</scan>

<scan>[example when details=NO, i.e. a summary]

<type>QUICK</type>

<status>FINISHED</status>

<start>2013-01-15 08:59:50</start>

<end>2013-01-15 09:03:57</end>

<cookies_scanned>0</cookies_scanned>

<registry_scanned>29563</registry_scanned>

<files_scanned>3297</files_scanned>

<folders_scanned>818</folders_scanned>

<processes_scanned>35</processes_scanned>

<threat_count>37</threat_count>

<quarantine_count>4</quarantine_count>

<error_count>3</error_count>

</scan>

[...more scan entries if they exist...]

</result>

</example>

Field Descriptions

A result element containing zero or more entries (scan elements in XML), each scan having:

description

Scan type, one of:

Scan status, one of:

Scan start time, e.g. 2013-06-21 19:18:17

For VIPRE engine scans the time is UTC

For Bitdefender engine scans the time is the agent local time.

Scan end time, e.g. 2013-06-21 19:27:35

For VIPRE engine scans the time is UTC

For Bitdefender engine scans the time is the agent local time.

Number of cookies scanned

Number of registry entries scanned

Number of files scanned

Number of folders scanned

Note: For Bitdefender engine scans this is always 0 as the Bitdefender engine does not scan by folder.

Number of processes scanned

Count of threats found

Count of items quarantined

Count of errors encountered

List of threats, each threat having:

This field is only present for scans performed by the VIPRE engine and only when at least one scanning error occurred. It provides a list of errors which occurred while scanning, each having:

Managed Antivirus engine where this data originates from, either VIPRE or Bitdefender