Documentation

    {{docApp.userSession.userId}}
    {{docApp.userSession.userName}}
    {{docApp.userSession.email}}
    Issuer : {{docApp.userSession.issuerInstance}}
    Expires : {{new Date(docApp.userSession.validUntil).toLocaleDateString()}}

{{docApp.title}}

{{docApp.description}}

Connect an AI assistant

Your AI assistant can read this documentation directly, so it answers from the current content instead of guessing. Add one of the servers below to your client — they use the Model Context Protocol (MCP). Each one covers a different body of content, so add the one you need.

The catalog did not load. Refresh the page to try again.

Loading…

How can we help?

{{docApp.searchError}}

Searching in {{docApp.searchFilterBySpecificBookTitle}}

 {{docApp.currentResultsSearchText}}  in {{docApp.searchFilterBySpecificBookTitle}}
Found {{docApp.searchResponse.totalResultsAvailable}} matches. Showing the top {{docApp.searchResponse.results ? docApp.searchResponse.results.length : 0}}. Use a more specific search to further narrow down the results.
No documentation pages match this search, so all content types are shown. Most matches are in {{docApp.searchDocTypeRescue.best.name}}.
There is no book with the ID "{{docApp.searchBookRescue.bid}}", so the book filter from this link was ignored and results from all books are shown.

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

  • {{resultItem.title}} {{resultItem.matchedBy === 'semantic' ? 'semantic' : (resultItem.matchedBy === 'both' ? 'keyword + semantic' : 'keyword')}}

    {{resultItem.url}}

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

{{docApp.libraryHomeViewProduct.description}}

  1. {{book.title}}

Rapid7 InsightVM - Start Scan

  • Article
  • 1 minutes to read

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
  • Version {{docApp.book.version}}
  • Node {{docApp.node}} / {{docApp.build}}
In This Document