Rapid7 InsightVM
App · 12 actions
Work with Rapid7 InsightVM vulnerability management: search assets and vulnerabilities, see what changed on an asset, start, check and stop scans, and start workflows when a scan finishes, a new asset or vulnerability is found, or a vulnerability is fixed.
Actions
| Action | What it does |
|---|---|
| Get asset | Get one asset with its operating system, risk score and vulnerability counts, and optionally the vulnerabilities found and fixed on it since a time. |
| Get scan | Get one scan's status (such as Running, Success or Stopped), engine and start and end times. |
| Get scan engine | Get one scan engine's name, address, status (such as HEALTHY) and when it was last seen. |
| Get vulnerability | Get one vulnerability by its InsightVM id: its title, description, severity, CVEs, CVSS scores and references. |
| List asset vulnerabilities | List the vulnerabilities an asset has now: each one's id, status, port, proof and the solution that fixes it. |
| List scan engines | List the scan engines paired with the Insight Platform, with each one's status and when it was last seen. |
| List scans | List scans with their status, engine and start and end times. |
| List sites | List the names of the sites assets are grouped into. |
| Search assets | Find assets (servers, workstations, devices) by host name, IP address, when they were last assessed or any InsightVM criteria, with their operating system, risk score and vulnerability counts. |
| Search vulnerabilities | Search the vulnerabilities InsightVM checks for by severity, when they last changed or any InsightVM criteria, with their CVEs, CVSS scores, risk score and references. |
| Start scan | Scan assets now, optionally with a chosen engine or for only some vulnerabilities. |
| Stop scan | Ask InsightVM to stop a running scan. |
Get asset
Get one asset with its operating system, risk score and vulnerability counts, and optionally the vulnerabilities found and fixed on it since a time.
Inputs
- Asset ID
asset_idtextRequired - The asset's id, such as 1234...-default-asset-7912, from 'Search assets' or an earlier step.
- Compare with
compare_sincedate and time - List the vulnerabilities found and fixed on the asset since this time, in 'new' and 'remediated'. Leave empty for the asset alone.
- Include unchanged
include_unchangedtrue/false - Also list the vulnerabilities it still has, in 'same'. Without a comparison time, that is every vulnerability it has now.
- Include fixes between scans
include_remediated_between_scanstrue/false - Also count as remediated the vulnerabilities found and fixed between the two times.
Outputs
assetobject- The asset
Example output
{
"asset": {
"assessed_for_policies": false,
"assessed_for_vulnerabilities": true,
"critical_vulnerabilities": 16,
"exploits": 24,
"host_name": "host.domain.com",
"id": "12344375-34a7-40d3-9821-90db0b5cc90e-default-asset-7912",
"ip": "10.1.0.128",
"last_assessed_for_vulnerabilities": "2026-11-02T21:19:41.090Z",
"last_scan_end": "2026-11-02T21:19:41.090Z",
"last_scan_start": "2026-11-02T21:05:35.014Z",
"mac": "00:50:56:8B:62:45",
"malware_kits": 1,
"moderate_vulnerabilities": 31,
"new": [
{
"check_id": "acrobat-cve-2018-16015",
"first_found": "2026-10-18T10:46:15Z",
"key": "key-123",
"last_found": "2026-11-02T19:18:13.611Z",
"nic": "eth0",
"port": 443,
"proof": "<p>Vulnerable version of Adobe Acrobat installed</p>",
"protocol": "TCP",
"remediation_date": "",
"solution_fix": "Download and apply the upgrade from Adobe.",
"solution_id": "adobe-acrobat-upgrade-latest",
"solution_summary": "Upgrade Adobe Acrobat to the latest version",
"solution_type": "rollup",
"status": "VULNERABLE_VERS",
"vulnerability_id": "acrobat-cve-2018-16015"
}
],
"os_architecture": "",
"os_description": "Microsoft Windows Server 2008 R2, Standard Edition SP1",
"os_family": "Windows",
"os_name": "Windows Server 2008 R2, Standard Edition",
"os_system_name": "Microsoft Windows",
"os_type": "General",
"os_vendor": "Microsoft",
"os_version": "SP1",
"remediated": [
{
"check_id": "acrobat-cve-2018-16015",
"first_found": "2026-10-18T10:46:15Z",
"key": "key-123",
"last_found": "2026-11-02T19:18:13.611Z",
"nic": "eth0",
"port": 443,
"proof": "<p>Vulnerable version of Adobe Acrobat installed</p>",
"protocol": "TCP",
"remediation_date": "2026-11-01T00:00:00Z",
"solution_fix": "Download and apply the upgrade from Adobe.",
"solution_id": "adobe-acrobat-upgrade-latest",
"solution_summary": "Upgrade Adobe Acrobat to the latest version",
"solution_type": "rollup",
"status": "VULNERABLE_VERS",
"vulnerability_id": "acrobat-cve-2018-16031"
}
],
"risk_score": 74621.5625,
"same": [],
"severe_vulnerabilities": 229,
"tags": [
{
"name": "lab",
"type": "SITE"
},
{
"name": "Windows",
"type": "CUSTOM"
}
],
"total_vulnerabilities": 276,
"type": "guest",
"unique_identifiers": [
{
"id": "10.1.0.128",
"source": "Endpoint Agent"
}
]
}
}Get scan
Get one scan's status (such as Running, Success or Stopped), engine and start and end times.
Inputs
- Scan ID
scan_idtextRequired - The scan's id, from 'Start scan', 'List scans' or an earlier step.
- Include details
include_detailstrue/false - Also return the extra details InsightVM keeps about each scan.
Outputs
scanobject- The scan
Example output
{
"scan": {
"details": {},
"engine_id": "b177d730-5cde-468a-89a4-2c5b9d26b465",
"finished": "2026-11-02T09:08:54.404Z",
"id": "bcc3fd8f-7bb6-41cc-a52f-4046c8742bf0",
"name": "Scan API Example Name",
"started": "2026-11-02T09:00:12.199Z",
"status": "Success"
}
}Get scan engine
Get one scan engine's name, address, status (such as HEALTHY) and when it was last seen.
Inputs
- Scan engine
engine_idtextRequired - The scan engine. Pick one, or give its id.
Outputs
engineobject- The scan engine
Example output
{
"engine": {
"host_name": "127.0.0.1",
"id": "6c384978-3545-455b-a69a-afa6e8cbd2dd",
"last_seen": "2026-11-02T22:29:05.006Z",
"name": "Scan Engine Example Name",
"profile": {
"configuration": {
"last_retrieved": "2026-11-01T13:23:17.433Z",
"properties": [
"property1:value1"
]
}
},
"registered": "2026-09-11T18:36:49.973Z",
"status": "HEALTHY"
}
}Get vulnerability
Get one vulnerability by its InsightVM id: its title, description, severity, CVEs, CVSS scores and references.
Inputs
- Vulnerability ID
vulnerability_idtextRequired - The vulnerability's InsightVM id, such as 7-zip-cve-2008-6536, from a search or an asset's findings.
Outputs
vulnerabilityobject- The vulnerability
Example output
{
"vulnerability": {
"added": "2018-05-16T00:00:00Z",
"categories": "7-Zip",
"cves": "CVE-2008-6536",
"cvss_v2_score": 10,
"cvss_v3_score": 0,
"cvss_v3_vector": "",
"denial_of_service": false,
"description": "Unspecified vulnerability in 7-zip before 4.5.7 has unknown impact and remote attack vectors.",
"exploits": [],
"id": "7-zip-cve-2008-6536",
"links": [
{
"href": "http://nvd.nist.gov/vuln/detail/CVE-2008-6536",
"id": "CVE-2008-6536",
"rel": "advisory",
"source": "cve"
}
],
"malware_kits": [],
"modified": "2018-06-08T00:00:00Z",
"pci_fail": true,
"pci_status": "fail",
"published": "2009-03-29T00:00:00Z",
"references": "bid:28285,cve:CVE-2008-6536",
"risk_score": 885.16,
"severity": "critical",
"severity_score": 10,
"title": "7-Zip: CVE-2008-6536: Unspecified vulnerability in 7-zip before 4.5.7"
}
}List asset vulnerabilities
List the vulnerabilities an asset has now: each one's id, status, port, proof and the solution that fixes it.
Inputs
- Asset ID
asset_idtextRequired - The asset's id, such as 1234...-default-asset-7912, from 'Search assets' or an earlier step.
Outputs
asset_idtext- The asset's id
countnumber- How many
host_nametext- The asset's host name
vulnerabilitieslist- The vulnerabilities found
Example output
{
"asset_id": "12344375-34a7-40d3-9821-90db0b5cc90e-default-asset-7912",
"count": 1,
"host_name": "host.domain.com",
"vulnerabilities": [
{
"check_id": "acrobat-cve-2018-16015",
"first_found": "2026-10-18T10:46:15Z",
"key": "key-123",
"last_found": "2026-11-02T19:18:13.611Z",
"nic": "eth0",
"port": 443,
"proof": "<p>Vulnerable version of Adobe Acrobat installed</p>",
"protocol": "TCP",
"remediation_date": "",
"solution_fix": "Download and apply the upgrade from Adobe.",
"solution_id": "adobe-acrobat-upgrade-latest",
"solution_summary": "Upgrade Adobe Acrobat to the latest version",
"solution_type": "rollup",
"status": "VULNERABLE_VERS",
"vulnerability_id": "acrobat-cve-2018-16015"
}
]
}List scan engines
List the scan engines paired with the Insight Platform, with each one's status and when it was last seen.
Inputs
- Page size
page_sizenumber - How many to return, 1 to 500. Defaults to 50.From 1 to 500.
- Page
pagenumber - Which page to return, counting from 0. Use 'next_page' from an earlier result to read on.At least 0.
Outputs
countnumber- How many are on this page
cursortext- The cursor to send with the next page, to read past 10,000 results; empty when InsightVM gives none
engineslist- The scan engines
has_moretrue/false- Whether a later page exists
next_pagenumber- The page number to ask for next, while has_more is true
pagenumber- This page's number, from 0
totalnumber- How many match in all
total_pagesnumber- How many pages there are
Example output
{
"count": 1,
"cursor": "",
"engines": [
{
"host_name": "127.0.0.1",
"id": "6c384978-3545-455b-a69a-afa6e8cbd2dd",
"last_seen": "2026-11-02T22:29:05.006Z",
"name": "Scan Engine Example Name",
"profile": {
"configuration": {
"last_retrieved": "2026-11-01T13:23:17.433Z",
"properties": [
"property1:value1"
]
}
},
"registered": "2026-09-11T18:36:49.973Z",
"status": "HEALTHY"
}
],
"has_more": false,
"next_page": 0,
"page": 0,
"total": 1,
"total_pages": 1
}List scans
List scans with their status, engine and start and end times.
Inputs
- Include details
include_detailstrue/false - Also return the extra details InsightVM keeps about each scan.
- Page size
page_sizenumber - How many to return, 1 to 500. Defaults to 50.From 1 to 500.
- Page
pagenumber - Which page to return, counting from 0. Use 'next_page' from an earlier result to read on.At least 0.
Outputs
countnumber- How many are on this page
cursortext- The cursor to send with the next page, to read past 10,000 results; empty when InsightVM gives none
has_moretrue/false- Whether a later page exists
next_pagenumber- The page number to ask for next, while has_more is true
pagenumber- This page's number, from 0
scanslist- The scans on this page
totalnumber- How many match in all
total_pagesnumber- How many pages there are
Example output
{
"count": 1,
"cursor": "",
"has_more": false,
"next_page": 0,
"page": 0,
"scans": [
{
"details": {},
"engine_id": "b177d730-5cde-468a-89a4-2c5b9d26b465",
"finished": "2026-11-02T09:08:54.404Z",
"id": "bcc3fd8f-7bb6-41cc-a52f-4046c8742bf0",
"name": "Scan API Example Name",
"started": "2026-11-02T09:00:12.199Z",
"status": "Success"
}
],
"total": 1,
"total_pages": 1
}List sites
List the names of the sites assets are grouped into.
Inputs
- Page size
page_sizenumber - How many to return, 1 to 500. Defaults to 50.From 1 to 500.
- Page
pagenumber - Which page to return, counting from 0. Use 'next_page' from an earlier result to read on.At least 0.
- Cursor
cursortext - The 'cursor' from the previous page. Needed only to read past the first 10,000 results.
Outputs
countnumber- How many are on this page
cursortext- The cursor to send with the next page, to read past 10,000 results; empty when InsightVM gives none
has_moretrue/false- Whether a later page exists
next_pagenumber- The page number to ask for next, while has_more is true
pagenumber- This page's number, from 0
siteslist- The sites
totalnumber- How many match in all
total_pagesnumber- How many pages there are
Example output
{
"count": 1,
"cursor": "",
"has_more": false,
"next_page": 0,
"page": 0,
"sites": [
{
"name": "lab",
"type": "SITE"
}
],
"total": 1,
"total_pages": 1
}Search assets
Find assets (servers, workstations, devices) by host name, IP address, when they were last assessed or any InsightVM criteria, with their operating system, risk score and vulnerability counts.
Inputs
- Host name starts with
host_name_starts_withtext - Only assets whose name starts with this, such as web-.
- IP address
ip_addresstext - Only the asset with this IPv4 or IPv6 address.
- Assessed since
assessed_sincedate and time - Only assets checked for vulnerabilities at or after this time.
- Asset criteria
asset_filtertext - Any other InsightVM asset criteria, as built in InsightVM's query builder, such as os_family = 'Windows'. Joined to the fields above with AND.
- Vulnerability criteria
vulnerability_filtertext - InsightVM vulnerability criteria, such as cvss_score >= 9. It narrows the findings listed on each asset, not which assets are returned.
- Sort by
sorttext - A property, then ,ASC or ,DESC, such as risk_score,DESC. Leave empty for InsightVM's order.
- Page size
page_sizenumber - How many to return, 1 to 500. Defaults to 50.From 1 to 500.
- Page
pagenumber - Which page to return, counting from 0. Use 'next_page' from an earlier result to read on.At least 0.
- Cursor
cursortext - The 'cursor' from the previous page. Needed only to read past the first 10,000 results.
Outputs
assetslist- The assets on this page
countnumber- How many are on this page
cursortext- The cursor to send with the next page, to read past 10,000 results; empty when InsightVM gives none
has_moretrue/false- Whether a later page exists
next_pagenumber- The page number to ask for next, while has_more is true
pagenumber- This page's number, from 0
totalnumber- How many match in all
total_pagesnumber- How many pages there are
Example output
{
"assets": [
{
"assessed_for_policies": false,
"assessed_for_vulnerabilities": true,
"critical_vulnerabilities": 16,
"exploits": 24,
"host_name": "host.domain.com",
"id": "12344375-34a7-40d3-9821-90db0b5cc90e-default-asset-7912",
"ip": "10.1.0.128",
"last_assessed_for_vulnerabilities": "2026-11-02T21:19:41.090Z",
"last_scan_end": "2026-11-02T21:19:41.090Z",
"last_scan_start": "2026-11-02T21:05:35.014Z",
"mac": "00:50:56:8B:62:45",
"malware_kits": 1,
"moderate_vulnerabilities": 31,
"new": [],
"os_architecture": "",
"os_description": "Microsoft Windows Server 2008 R2, Standard Edition SP1",
"os_family": "Windows",
"os_name": "Windows Server 2008 R2, Standard Edition",
"os_system_name": "Microsoft Windows",
"os_type": "General",
"os_vendor": "Microsoft",
"os_version": "SP1",
"remediated": [],
"risk_score": 74621.5625,
"same": [],
"severe_vulnerabilities": 229,
"tags": [
{
"name": "lab",
"type": "SITE"
},
{
"name": "Windows",
"type": "CUSTOM"
}
],
"total_vulnerabilities": 276,
"type": "guest",
"unique_identifiers": [
{
"id": "10.1.0.128",
"source": "Endpoint Agent"
}
]
}
],
"count": 1,
"cursor": "",
"has_more": false,
"next_page": 0,
"page": 0,
"total": 1,
"total_pages": 1
}Search vulnerabilities
Search the vulnerabilities InsightVM checks for by severity, when they last changed or any InsightVM criteria, with their CVEs, CVSS scores, risk score and references.
Inputs
- Severities
severitieslist - Only vulnerabilities of these severities.One or more of:
critical,severe,moderate. - Changed after
modified_sincedate - Only vulnerabilities Rapid7 changed after this date.
- Vulnerability criteria
vulnerability_filtertext - Any other InsightVM vulnerability criteria, such as cvss_v3_score >= 9. Joined to the fields above with AND.
- Sort by
sorttext - A property, then ,ASC or ,DESC, such as risk_score,DESC. Leave empty for InsightVM's order.
- Page size
page_sizenumber - How many to return, 1 to 500. Defaults to 50.From 1 to 500.
- Page
pagenumber - Which page to return, counting from 0. Use 'next_page' from an earlier result to read on.At least 0.
- Cursor
cursortext - The 'cursor' from the previous page. Needed only to read past the first 10,000 results.
Outputs
countnumber- How many are on this page
cursortext- The cursor to send with the next page, to read past 10,000 results; empty when InsightVM gives none
has_moretrue/false- Whether a later page exists
next_pagenumber- The page number to ask for next, while has_more is true
pagenumber- This page's number, from 0
totalnumber- How many match in all
total_pagesnumber- How many pages there are
vulnerabilitieslist- The vulnerabilities
Example output
{
"count": 1,
"cursor": "",
"has_more": false,
"next_page": 0,
"page": 0,
"total": 1,
"total_pages": 1,
"vulnerabilities": [
{
"added": "2018-05-16T00:00:00Z",
"categories": "7-Zip",
"cves": "CVE-2008-6536",
"cvss_v2_score": 10,
"cvss_v3_score": 0,
"cvss_v3_vector": "",
"denial_of_service": false,
"description": "Unspecified vulnerability in 7-zip before 4.5.7 has unknown impact and remote attack vectors.",
"exploits": [],
"id": "7-zip-cve-2008-6536",
"links": [
{
"href": "http://nvd.nist.gov/vuln/detail/CVE-2008-6536",
"id": "CVE-2008-6536",
"rel": "advisory",
"source": "cve"
}
],
"malware_kits": [],
"modified": "2018-06-08T00:00:00Z",
"pci_fail": true,
"pci_status": "fail",
"published": "2009-03-29T00:00:00Z",
"references": "bid:28285,cve:CVE-2008-6536",
"risk_score": 885.16,
"severity": "critical",
"severity_score": 10,
"title": "7-Zip: CVE-2008-6536: Unspecified vulnerability in 7-zip before 4.5.7"
}
]
}Start scan
Scan assets now, optionally with a chosen engine or for only some vulnerabilities. Returns the new scan's id and any assets InsightVM couldn't scan, with the reason.
Inputs
- Asset IDs
asset_idslistRequired - The ids of the assets to scan, from 'Search assets'.
- Scan name
nametext - A name to find the scan by in InsightVM.
- Scan engine
engine_idtext - The engine to scan with. Leave empty to let InsightVM use the engine that last scanned each asset.
- Only check vulnerabilities
vulnerability_idslist - Check only these vulnerabilities, by id, such as 7-zip-cve-2008-6536. Leave empty for a full scan.
- Site for results
site_nametext - The site the scanned assets' results are stored in.
Outputs
scan_idtext- The first new scan's id
scan_idslist- Every scan started, one per engine
scanned_asset_idslist- The assets being scanned
scanslist- The scans started
unscanned_assetslist- Assets left out, each with the reason
Example output
{
"scan_id": "bcc3fd8f-7bb6-41cc-a52f-4046c8742bf0",
"scan_ids": [
"bcc3fd8f-7bb6-41cc-a52f-4046c8742bf0"
],
"scanned_asset_ids": [
"12344375-34a7-40d3-9821-90db0b5cc90e-default-asset-7912"
],
"scans": [
{
"asset_ids": [
"12344375-34a7-40d3-9821-90db0b5cc90e-default-asset-7912"
],
"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."
}
]
}Stop scan
Ask InsightVM to stop a running scan. 'Get scan' then shows it as Stopped.
Inputs
- Scan ID
scan_idtextRequired - The scan's id, from 'Start scan', 'List scans' or an earlier step.
Outputs
scan_idtext- The scan asked to stop
stop_requestedtrue/false- True once InsightVM accepted the request
Example output
{
"scan_id": "bcc3fd8f-7bb6-41cc-a52f-4046c8742bf0",
"stop_requested": true
}