Skip to main content

Start Scan

Starts a scan.

External Documentation

To learn more, visit the Rapid7 InsightVM Cloud documentation.

Parameters

ParameterDescription
Scan NameThe name of the scan.

Example Output

{
"description": "The identifier of the newly started scan.",
"summary": "Example",
"value": {
"scans": [
{
"asset_ids": [
"12344375-34a7-40d3-9821-90db0b5cc90e-default-asset-1",
"12344375-34a7-40d3-9821-90db0b5cc90e-default-asset-2",
"12344375-34a7-40d3-9821-90db0b5cc90e-default-asset-3"
],
"engine_id": "b177d730-5cde-468a-89a4-2c5b9d26b465",
"id": "bcc3fd8f-7bb6-41cc-a52f-4046c8742bf0",
"name": "Scan API Example Name"
}
],
"unscanned_assets": [
{
"id": "12344375-34a7-40d3-9821-90db0b5cc90e-default-asset-4",
"reason": "Asset has never been scanned with an InsightVM Platform registered engine."
},
{
"id": "12344375-34a7-40d3-9821-90db0b5cc90e-default-asset-5",
"reason": "Too many assets in request."
}
]
}
}

Workflow Library Example

Start Scan with Rapid7 Insightvm Cloud and Send Results Via Email

Workflow LibraryPreview this Workflow on desktop