{{docApp.title}}

{{docApp.description}}

Filter

Clear All

Books

All
{{book.title}}
{{book.foundCount}} 0

Products

{{product.name}} {{docApp.searchFilteredProducts[product.id].returnedCount}}

{{docApp.searchError}}

{{product.name}}

Searching in {{docApp.searchFilterBySpecificBookTitle}}

{{docApp.searchResultFilteredItems.length}} results for: {{docApp.currentResultsSearchText}} in {{docApp.searchFilterBySpecificBookTitle}}
Search results have been limited. There are a total of {{docApp.searchResponse.totalResultsAvailable}} matches.

You have an odd number of " characters in your search terms - each one needs closing with a matching " character!

{{resultItem.title}}

{{resultItem.url}}

{{docApp.libraryHomeViewProduct.title || docApp.libraryHomeViewProduct.id}}

{{docApp.libraryHomeViewProduct.description}}

{{book.title}}

{{group.title || group.id}}

{{group.description}}

{{book.title}}

{{group.title}}

{{book.title}}

More...

Start Scan

Operation Information

Starts a Scan against a Host on a Site.

See the InsightVM operation documentation for more information: https://help.rapid7.com/insightvm/en-us/api/index.html#operation/startScan

Extra Credentials

This operation requires an extra credential to be provided, stored in KeySafe, to the following specification:

Credential Reference: credential1
Credential Keysafe Key Type: Username + Password

Notes

When set to true, the IgnoreBadCerts input parameter will allow the operation to function even if the SSL certificate on your InsightVM deployment is self-certified or expired.

Input Parameters

Name	Type	Description	Required	Sensitive
`IgnoreBadCerts`	`boolean`	When set to true, the IgnoreBadCerts input parameter will allow the operation to function even if the SSL certificate on your InsightVM deployment is self-certified or expired	Yes	No
`SiteID`	`decimal`	The ID of the Site to initiate the scan against	Yes	No
`EngineID`	`decimal`	The identifier of the scan engine	Yes	No
`Asset`	`string`	The IP or Name of the Asset to scan	Yes	No
`TemplateID`	`string`	The identifier of the scan template	Yes	No
`Name`	`string`	The user-driven scan name for the scan	No	No

Output Parameters

Name	Type	Description	Required	Sensitive
`outcome`	`string`	Outcome of the operation. Can be OK or FAIL	Yes	No
`errors`	`string`	Any errors returned by the operation	No	No
`id`	`decimal`	The ID of the scan	No	No

In This Document

{{tocItem.eleText}}