> ## Documentation Index
> Fetch the complete documentation index at: https://docs.blinkops.com/llms.txt
> Use this file to discover all available pages before exploring further.

# Create Scan

Create a scan.

**Note:** Set the scan targets using one or more of the following:

* `Asset Groups` - scan by asset groups.
* `Ad Hoc Targets` - scan by ad hoc IPs and ports.
* `Asset Filter` - scan by ad hoc dynamic assets.
* `Ad Hoc Named Asset Targets` - scan by ad hoc hostnames.

At least one target method is required. Unused methods can be left empty.

<Note>
  External Documentation

  To learn more, visit the [Fortra VM documentation](https://hstechdocs.helpsystems.com/manuals/fortravm/userguide/content/vm/integrations/quickconnectapi.htm).
</Note>

## Basic Parameters

<div className="integrations-table">
  | Parameter                 | Description                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                             |
  | ------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
  | Adhoc Named Asset Targets | A JSON array of ad hoc hostname target objects to scan. Each object requires a `named_asset` object, a `network_profile_id` and a `rule_action` of either `include` or `exclude`.<br /><br />**For Example:**<br />  <pre><code>\[\{<br />      "inclusion": "full",<br />      "named\_asset": \{<br />        "code": 0,<br />        "codename": "DNS",<br />        "name": "host.local"<br />      },<br />      "network\_profile\_id": 8386,<br />      "rule\_action": "include"<br />    }]<br /></code></pre> |
  | Adhoc Targets             | A JSON array of ad hoc IP and port target objects to scan. Each object requires an `ip_address_range` object, a `network_profile_id` and a `rule_action` of either `include` or `exclude`.<br /><br />**For Example:**<br />  <pre><code>\[\{<br />      "autoadd": true,<br />      "ip\_address\_range": \{<br />        "low\_ip\_address": "192.168.1.1"<br />      },<br />      "network\_profile\_id": 8386,<br />      "rule\_action": "include"<br />    }]<br /></code></pre>                                 |
  | Asset Filter              | A JSON object of asset and vulnerability filters that dynamically selects the assets to scan.<br /><br />**For Example:**<br />  <pre><code>\{<br />      "\_0\_contains\_host\_os": "Windows",<br />      "\_1\_iexact\_host\_os\_type": "server"<br />    }</code></pre>                                                                                                                                                                                                                                              |
  | Asset Groups              | A comma-separated list of the IDs of the asset groups to scan. Use the asset group `id`, not its `group_id`.                                                                                                                                                                                                                                                                                                                                                                                                            |
  | Name                      | The name of the scan.<br /><br />**Notes:**<br />\* limited to 100 characters.<br />\* Defaults to a generated name such as `Scan Wed Sep 25 2024 14:20:57 GMT+0000 (UTC)`.                                                                                                                                                                                                                                                                                                                                             |
  | Start Date                | The date and time at which the scan is to start.                                                                                                                                                                                                                                                                                                                                                                                                                                                                        |
  | Timezone                  | The timezone location that the start date is expressed in.<br /><br />**For Example:** `America/Chicago`                                                                                                                                                                                                                                                                                                                                                                                                                |
</div>

## Advanced Parameters

<div className="integrations-table">
  | Parameter                | Description                                                                                                                                                                                     |
  | ------------------------ | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
  | Build Reports            | Select to automatically generate an Executive Summary report and a Vulnerability Details report when the scan completes.                                                                        |
  | Business Groups          | A JSON array containing a single object with the ID of the business group to scan under.<br /><br />**For Example:**<br />  <pre><code>\[\{<br />      "id": 540<br />    }]<br /></code></pre> |
  | Description              | The description of the scan.                                                                                                                                                                    |
  | Exclude From Active View | Select to exclude the scan results from reconciling into `Active View`.                                                                                                                         |
  | Notify                   | Select to notify the recipients that do not receive automatic scan notifications.                                                                                                               |
  | Recipients               | A comma-separated list of the Fortra VM email addresses to notify. Leave empty when notify is disabled.                                                                                         |
  | Scan Policy              | The name of the scan policy to use for this scan.                                                                                                                                               |
  | Scan Speed               | Select the speed to run the scan at. If not specified, `normal` is used.<br /><br />**Warning:** Faster scan speeds require more processing resources.                                          |
  | Workflow                 | Select the workflow type to run for this scan. If not specified, `Vulnerability Assessment` is used.                                                                                            |
</div>

## Example Output

```json theme={"dark"}
{
	"id": "string",
	"account": {
		"id": 0
	},
	"account_user": "string",
	"account_user_id": 0,
	"businessgroups": [
		{
			"id": 0,
			"name": "string"
		}
	],
	"name": "string",
	"description": "string",
	"scan_policy": "string",
	"scan_speed": "string",
	"schedule": {
		"id": 0,
		"start_date": "2019-08-24T14:15:22Z",
		"end_date": "2019-08-24T14:15:22Z",
		"recurring": false,
		"recurrence_rules": [],
		"timezone": "string",
		"occurrences": 0
	},
	"workflow": "string",
	"adhoc_targets": [],
	"adhoc_named_asset_targets": [],
	"active": true,
	"exclude_from_active_view": false,
	"force_target_detection": false,
	"build_reports": false,
	"asset_groups": [
		0
	],
	"asset_filter": {},
	"recipients": [],
	"notify": false,
	"account_id": 0
}
```

## Workflow Library Example

[Create Scan with Fortra Vm and Send Results Via Email](https://library.blinkops.com/workflows/create-scan-with-fortra-vm-and-send-results-via-email)

<div className="iframe-wrapper">
  <div className="iframe-media">
    <img src="https://mintcdn.com/blinkops-2/ojHYuDeYX5FWuN8a/img/Icons/play-box.svg?fit=max&auto=format&n=ojHYuDeYX5FWuN8a&q=85&s=b8af968e71438a9499c3223c9bd29fb2" alt="Workflow Library" width="16" height="16" data-path="img/Icons/play-box.svg" />

    Preview this Workflow on desktop
  </div>

  <iframe className="iframe" src="https://library.blinkops.com/workflows/create-scan-with-fortra-vm-and-send-results-via-email/canvas" />
</div>
