---
updatedAt: 2025-08-14T16:13:23.000Z
agentTools:
  siteIndex: https://developer.n-able.com/llms.txt
  projectIndex: https://developer.n-able.com/n-sight/llms.txt
---

# Start Scan

Service name: mav_scan_start

## Base URL

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

## Description

Start 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_start&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_start&required_parameters={parameter-value}&optional_parameters={parameter-value}
```

| Parameter                      | Description                                                                                                                                     | Type    | Options | Default |
| :----------------------------- | :---------------------------------------------------------------------------------------------------------------------------------------------- | :------ | :------ | :------ |
| [describe](describe-parameter) | 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](list-devices-at-client) | https\://\{SERVER}/api/?apikey=yourAPIkey\&service=list\_devices\_at\_client\&clientid=CLIENTID\&devicetype=server |
|           | [list\_servers](listing-servers)                    | https\://\{SERVER}/api/?apikey=yourAPIkey\&service=list\_servers\&siteid=SITEID                                    |
|           | [list\_workstations](listing-workstations)          | https\://\{SERVER}/api/?apikey=yourAPIkey\&service=list\_workstations\&siteid=SITEID                               |
| siteid    | [list\_sites](listing-sites)                        | https\://\{SERVER}/api/?apikey=yourAPIkey\&service=list\_sites\&clientid=CLIENTID                                  |
| clientid  | [list\_clients](listing-clients)                    | https\://\{SERVER}/api/?apikey=yourAPIkey\&service=list\_clients                                                   |

## Examples

### Start a scan on a device

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

#### Example response - Success

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

#### Example response - Failure

```xml
<?xml version="1.0" ?>
<result created="2024-08-25T15:54:05" host="SERVER" status="FAIL">
  <msg>{fail message}</msg>
</result>
```

## Returned fields

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