Create Scan - BlinkOps Documentation

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.

External DocumentationTo learn more, visit the Fortra VM documentation.

Basic Parameters

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`. For Example: `[{ “inclusion”: “full”, “named_asset”: { “code”: 0, “codename”: “DNS”, “name”: “host.local” }, “network_profile_id”: 8386, “rule_action”: “include” }]`
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`. For Example: `[{ “autoadd”: true, “ip_address_range”: { “low_ip_address”: “192.168.1.1” }, “network_profile_id”: 8386, “rule_action”: “include” }]`
Asset Filter	A JSON object of asset and vulnerability filters that dynamically selects the assets to scan. For Example: `{ “_0_contains_host_os”: “Windows”, “_1_iexact_host_os_type”: “server” }`
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. Notes: * limited to 100 characters. * 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. For Example: `America/Chicago`

Advanced Parameters

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. For Example: `[{ “id”: 540 }]`
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. 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.

Example Output

{
	"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
}