--- title: Rapid7 Insight VM slug: connectors/rapid7-insight-vm docTags: createdAt: 2026-06-09T16:29:58.803Z --- The Rapid7 Insight VM connector facilitates seamless integration with Swimlane Turbine, enabling automated vulnerability management and security processes. Rapid7 InsightVM is a powerful vulnerability management tool that provides comprehensive visibility into the security posture of your assets. This connector enables Swimlane Turbine users to automate asset discovery, vulnerability assessment, and reporting tasks within their security workflows. By integrating with Rapid7 InsightVM, users can streamline vulnerability management processes, enhance asset visibility, and expedite remediation efforts, all from within the Swimlane platform. The connector's actions facilitate real-time security analytics and proactive risk management, empowering users to maintain a robust security posture. ## Prerequisites To effectively utilize the Rapid7 Insight VM connector with Swimlane Turbine, ensure you have the following prerequisites: - HTTP Basic Authentication with the following parameters: - URL: The base endpoint for the Rapid7 Insight VM API. - Username: Your Insight VM account username. - Password: Your Insight VM account password. ## Capabilities The Rapid7 InsightVM connector has the following capabilities: - Get Scan Details - Create Tag - Get Tag - Get Tags - Create Report for Report Generation - Report Download - Report Generation - Get Affected Assets - Get All Assets - Get All Vulnerabilities - Get Asset Vulnerabilities - Get Solution - Get Vulnerability - Get Vulnerability Solutions ## Create Report for Report Generation Notes ### Filters The following filter elements may be defined for non-templatized report formats: | Format | Categories | Severity | Statuses | | ------------------ | ---------- | -------- | -------- | | arf-xm | | | | | csv-export | ✓ | ✓ | ✓ | | cyberscope-xml | | | | | database-export | | | | | nexpose-simple-xml | ✓ | ✓ | | | oval-xml | | | | | qualys-xml | ✓ | ✓ | | | scap-xml | ✓ | ✓ | | | sql-query | ✓ | ✓ | ✓ | | xccdf-csv | | | | | xccdf-xml | ✓ | ✓ | | | xml-export | ✓ | ✓ | ✓ | | xml-export-v2 | ✓ | ✓ | ✓ | The following filter elements may be defined for templatized report formats: | Template | Categories | Severity | Statuses | | ------------------------------------- | ---------- | -------- | -------- | | audit-report | ✓ | ✓ | | | baseline-comparison | | | | | basic-vulnerability-check-results | ✓ | ✓ | ✓ | | executive-overview | | | | | highest-risk-vulns | | | | | pci-attestation-v12 | | | | | pci-executive-summary-v12 | | | | | pci-vuln-details-v12 | | | | | policy-details | ✓ | ✓ | ✓ | | policy-eval | | | | | policy-summary | ✓ | ✓ | ✓ | | prioritized-remediations | ✓ | ✓ | ✓ | | prioritized-remediations-with-details | ✓ | ✓ | ✓ | | r7-discovered-assets | ✓ | ✓ | ✓ | | r7-vulnerability-exceptions | ✓ | ✓ | ✓ | | remediation-plan | ✓ | ✓ | | | report-card | ✓ | ✓ | | | risk-scorecard | ✓ | ✓ | ✓ | | rule-breakdown-summary | ✓ | ✓ | ✓ | | top-policy-remediations | ✓ | ✓ | ✓ | | top-policy-remediations-with-details | ✓ | ✓ | ✓ | | top-riskiest-assets | ✓ | ✓ | ✓ | | top-vulnerable-assets | ✓ | ✓ | ✓ | | vulnerability-trends | ✓ | ✓ | ✓ | ### Scope The following scope elements may be defined for non-templatized report formats: | Format | Assets | Sites | Asset Groups | Tags | Scans | | | ------------------ | ------ | ----- | ------------ | ---- | ----- | - | | arf-xml | ✓ | ✓ | ✓ | ✓ | ✓ | | | csv-export | ✓ | ✓ | ✓ | ✓ | ✓ | | | cyberscope-xml | ✓ | ✓ | ✓ | ✓ | ✓ | | | database-export | | ✓ | | | | | | nexpose-simple-xml | ✓ | ✓ | ✓ | ✓ | ✓ | | | oval-xml | ✓ | ✓ | ✓ | ✓ | | | | qualys-xml | ✓ | ✓ | ✓ | ✓ | ✓ | | | scap-xml | ✓ | ✓ | ✓ | ✓ | ✓ | | | xccdf-csv | ✓ | | | | | | | xccdf-xml | ✓ | ✓ | ✓ | ✓ | ✓ | | | xml-export | ✓ | ✓ | ✓ | ✓ | ✓ | | | xml-export-v2 | ✓ | ✓ | ✓ | ✓ | ✓ | | The following scope elements may be defined for templatized report formats: | Template | Assets | Sites | Asset Groups | Tags | Scans | | ------------------------------------- | ------ | ----- | ------------ | ---- | ----- | | audit-report | ✓ | ✓ | ✓ | ✓ | ✓ | | baseline-comparison | ✓ | ✓ | ✓ | ✓ | | | basic-vulnerability-check-results | ✓ | ✓ | ✓ | ✓ | ✓ | | executive-overview | ✓ | ✓ | ✓ | ✓ | | | highest-risk-vulns | ✓ | ✓ | ✓ | ✓ | | | pci-attestation-v12 | ✓ | ✓ | ✓ | ✓ | ✓ | | pci-executive-summary-v12 | ✓ | ✓ | ✓ | ✓ | ✓ | | pci-vuln-details-v12 | ✓ | ✓ | ✓ | ✓ | ✓ | | policy-details | ✓ | ✓ | ✓ | ✓ | | | policy-eval | ✓ | ✓ | ✓ | ✓ | | | policy-summary | ✓ | ✓ | ✓ | ✓ | ✓ | | prioritized-remediations | ✓ | ✓ | ✓ | ✓ | ✓ | | prioritized-remediations-with-details | ✓ | ✓ | ✓ | ✓ | ✓ | | r7-discovered-assets | ✓ | ✓ | ✓ | ✓ | ✓ | | r7-vulnerability-exceptions | ✓ | ✓ | ✓ | ✓ | ✓ | | remediation-plan | ✓ | ✓ | ✓ | ✓ | ✓ | | report-card | ✓ | ✓ | ✓ | ✓ | ✓ | | risk-scorecard | ✓ | ✓ | ✓ | ✓ | | | rule-breakdown-summary | ✓ | ✓ | ✓ | ✓ | | | top-policy-remediations | ✓ | ✓ | ✓ | ✓ | | | top-policy-remediations-with-details | ✓ | ✓ | ✓ | ✓ | | | top-riskiest-assets | ✓ | ✓ | ✓ | ✓ | ✓ | | top-vulnerable-assets | ✓ | ✓ | ✓ | ✓ | ✓ | | vulnerability-trends | ✓ | ✓ | ✓ | ✓ | | If a report supports specifying a scan as the scope and a scan is specified, no other scope elements can be defined. In all other cases, many different types of supported scope elements can be specified in any combination. All reports except the SQL-query format require at least one element to be specified as the scope. Template Assets Sites Asset Groups Tags Scan ✓ ✓ ✓ ✓ ✓ ✓ ✓ ✓ ✓ ✓ ✓ ✓ ✓ ✓ ✓ ✓ ✓ ✓ ✓ ✓ ✓ ✓ ✓ ✓ ✓ ✓ ✓ ✓ ✓ ✓ ✓ ✓ ✓ ✓ ✓ ✓ ✓ ✓ ✓ ✓ ✓ ✓ ✓ ✓ ✓ ✓ ✓ ✓ ✓ ✓ ✓ ✓ ✓ ✓ ✓ ✓ ✓ ✓ ✓ ✓ ✓ ✓ ✓ ✓ ✓ ✓ ✓ ✓ ✓ ✓ ✓ ✓ ✓ ✓ ✓ ✓ ✓ ✓ ✓ ✓ ✓ ✓ ✓ ✓ ✓ ✓ ✓ ✓ ✓ ✓ ✓ ✓ ✓ ✓ ✓ ✓ ✓ ✓ ✓ ✓ ✓ ✓ ✓ ✓ ✓ ✓ ✓ ✓ ✓ ✓ ## Create Tag Action Notes Create Tag receives two optional inputs that requires a specific format: - Filters This input receives a string/text than can be converted to JSON. A reference from rapid7 with all the posibilities can be found [here](https://help.rapid7.com/insightvm/en-us/api/#section/Responses/SearchCriteria). e.g.: \[\{"field": "","lower": "","operator": "","upper": "","value": "","values": \["string"]}] ## Notes You can find information on Search Criteria [here](https://help.rapid7.com/insightvm/en-us/api/index.html#section/Overview/Responses). # Configurations ## HTTP Basic Authentication Authenticates using username and password. ### Configuration Parameters | **Parameter** | **Description** | **Type** | **Required** | | ------------- | ---------------------------------- | -------- | ------------ | | url | A URL to the target host. | string | Required | | username | Username | string | Required | | password | Password | string | Required | | verify\_ssl | Verify SSL certificate | boolean | Optional | | http\_proxy | A proxy to route requests through. | string | Optional | # Actions ## Assets Search Conducts a comprehensive search for assets in Rapid7 InsightVM, enabling quick retrieval of specific asset information. ### Endpoint - **URL:** `api/3/assets/search` - **Method:** `POST` ### Input | **Argument Name** | **Type** | **Required** | **Description** | | ------------------ | -------- | ------------ | --------------------------- | | `match` | string | Optional | Parameter for Assets Search | | `filters` | array | Optional | Parameter for Assets Search | | `filters.field` | string | Optional | Parameter for Assets Search | | `filters.operator` | string | Optional | Parameter for Assets Search | | `filters.value` | string | Optional | Value for the parameter | ### Input Example `{"json_body":{"match":"all","filters":[{"field":"host-name","operator":"is","value":"WIN-UAG2LHC1T75.swimlane.us"}]}}` ### Output | **Parameter** | **Type** | **Description** | | -------------------------------------- | -------- | -------------------------------------------------- | | `status_code` | number | HTTP status code of the response | | `reason` | string | Response reason phrase | | `resources` | array | Output field: resources | | `resources.addresses` | array | Output field: resources.addresses | | `resources.addresses.ip` | string | Output field: resources.addresses.ip | | `resources.addresses.mac` | string | Output field: resources.addresses.mac | | `resources.assessedForPolicies` | boolean | Output field: resources.assessedForPolicies | | `resources.assessedForVulnerabilities` | boolean | Output field: resources.assessedForVulnerabilities | | `resources.history` | array | Output field: resources.history | | `resources.history.date` | string | Date value | | `resources.history.scanId` | number | Unique identifier | | `resources.history.type` | string | Type of the resource | | `resources.history.version` | number | Output field: resources.history.version | | `resources.hostName` | string | Name of the resource | | `resources.hostNames` | array | Name of the resource | | `resources.hostNames.name` | string | Name of the resource | | `resources.hostNames.source` | string | Name of the resource | | `resources.id` | number | Unique identifier | | `resources.ip` | string | Output field: resources.ip | | `resources.links` | array | Output field: resources.links | | `resources.links.href` | string | Output field: resources.links.href | | `resources.links.rel` | string | Output field: resources.links.rel | | `resources.mac` | string | Output field: resources.mac | | `resources.os` | string | Output field: resources.os | | `resources.osCertainty` | string | Output field: resources.osCertainty | ### Output Example `{"status_code":200,"response_headers":{"X-Frame-Options":"SAMEORIGIN","X-UA-Compatible":"IE=edge,chrome=1","X-Content-Type-Options":"nosniff","X-XSS-Protection":"1; mode=block","Cache-Control":"no-store, must-revalidate","Content-Type":"application/json;charset=UTF-8","Transfer-Encoding":"chunked","Content-Encoding":"gzip","Vary":"Accept-Encoding","Date":"Fri, 06 Jan 2023 19:19:17 GMT","Server":"Security Console"},"reason":"OK","json_body":{"resources":[{}],"page":{"number":0,"size":10,"totalRes...` ## Create Report for Report Generation Generates a customizable report within Rapid7 Insight VM to facilitate subsequent reporting processes. ### Endpoint - **URL:** `api/3/reports` - **Method:** `POST` ### Input | **Argument Name** | **Type** | **Required** | **Description** | | ------------------------------- | -------- | ------------ | ------------------------------------------------- | | `bureau` | string | Optional | Parameter for Create Report for Report Generation | | `component` | string | Optional | Parameter for Create Report for Report Generation | | `database` | object | Optional | Response data | | `database.credentials` | object | Optional | Response data | | `database.credentials.username` | string | Optional | Response data | | `database.host` | string | Optional | Response data | | `database.name` | string | Optional | Response data | | `database.port` | number | Optional | Response data | | `database.vendor` | string | Optional | Response data | | `email` | object | Optional | Parameter for Create Report for Report Generation | | `email.access` | string | Optional | Parameter for Create Report for Report Generation | | `email.additional` | string | Optional | Parameter for Create Report for Report Generation | | `email.additionalRecipients` | array | Optional | Parameter for Create Report for Report Generation | | `email.assetAccess` | boolean | Optional | Parameter for Create Report for Report Generation | | `email.owner` | string | Optional | Parameter for Create Report for Report Generation | | `email.smtp` | object | Optional | Parameter for Create Report for Report Generation | | `email.smtp.global` | boolean | Optional | Parameter for Create Report for Report Generation | | `email.smtp.relay` | string | Optional | Parameter for Create Report for Report Generation | | `email.smtp.sender` | string | Optional | Parameter for Create Report for Report Generation | | `enclave` | string | Optional | Parameter for Create Report for Report Generation | | `filters` | object | Optional | Parameter for Create Report for Report Generation | | `filters.categories` | object | Optional | Parameter for Create Report for Report Generation | | `filters.categories.excluded` | array | Optional | Parameter for Create Report for Report Generation | | `filters.categories.included` | array | Optional | Parameter for Create Report for Report Generation | | `filters.categories.links` | array | Optional | Parameter for Create Report for Report Generation | ### Input Example `{"json_body":{"bureau":"Bureau","component":"Component","database":{"credentials":{"username":"admin"},"host":"database.acme.com","name":"database","port":3306,"vendor":"mysql"},"email":{"access":"zip","additional":"file","additionalRecipients":["string"],"assetAccess":true,"owner":"file","smtp":{"global":true,"relay":"mail.acme.com","sender":"john_smith@acme.com"}},"enclave":"Enclave","filters":{"categories":{"excluded":["string"],"included":["string"],"links":[{"href":"https://hostname:3780/api/3/...","rel":"self"}]},"severity":"","statuses":["vulnerable"]},"format":"pdf","frequency":{"repeat":{"dayOfWeek":"","every":"date-of-month","interval":1,"lastDayOfMonth":true,"weekOfMonth":""},"start":"2018-03-01T04:31:56Z"},"language":"en-US","name":"Monthly Corporate Site Summary","organization":"Acme, Inc.","owner":1,"policy":789,"query":"SELECT * FROM dim_asset ORDER BY ip_address ASC","scope":{"assetGroups":[0],"assets":[0],"scan":68,"sites":[0],"tags":[0]},"storage":{"location":"monthly_reports/site/corporate"},"template":"executive-overview","timezone":"America/Los_Angeles","users":"7","version":"2.3.0"}}` ### Output | **Parameter** | **Type** | **Description** | | ------------- | -------- | -------------------------------- | | `status_code` | number | HTTP status code of the response | | `reason` | string | Response reason phrase | | `status` | number | Status value | | `message` | string | Response message | | `links` | array | Output field: links | | `links.href` | string | Output field: links.href | | `links.rel` | string | Output field: links.rel | ### Output Example `{"status":123,"message":"string","links":[{"href":"string","rel":"string"}]}` ## Create Tag Creates a new asset tag in Rapid7 Insight VM for effective organization and categorization of assets. ### Endpoint - **URL:** `api/3/tags` - **Method:** `POST` ### Input | **Argument Name** | **Type** | **Required** | **Description** | | ----------------- | -------- | ------------ | -------------------- | | `name` | string | Optional | Name of the resource | | `type` | string | Optional | Type of the resource | ### Input Example `{"json_body":{"name":"my tag","type":"criticality"}}` ### Output | **Parameter** | **Type** | **Description** | | ------------- | -------- | -------------------------------- | | `status_code` | number | HTTP status code of the response | | `reason` | string | Response reason phrase | | `status` | number | Status value | | `message` | string | Response message | | `links` | array | Output field: links | | `links.href` | string | Output field: links.href | | `links.rel` | string | Output field: links.rel | ### Output Example `{"status_code":500,"response_headers":{"X-Frame-Options":"SAMEORIGIN","X-UA-Compatible":"IE=edge,chrome=1","X-Content-Type-Options":"nosniff","X-XSS-Protection":"1; mode=block","Cache-Control":"no-store, must-revalidate","Content-Type":"application/json;charset=UTF-8","Transfer-Encoding":"chunked","Content-Encoding":"gzip","Vary":"Accept-Encoding","Date":"Tue, 09 May 2023 17:19:56 GMT","Connection":"close","Server":"Security Console"},"reason":"Internal Server Error","json_body":{"status":500,"m...` ## Get Affected Assets Retrieve a list of assets affected by a specified vulnerability using its unique identifier in Rapid7 Insight VM. ### Endpoint - **URL:** `api/3/vulnerabilities/{{id}}/assets` - **Method:** `GET` ### Input | **Argument Name** | **Type** | **Required** | **Description** | | -------------------- | -------- | ------------ | --------------------------------------------- | | `path_parameters.id` | string | Required | Parameters for the Get Affected Assets action | ### Input Example `{"path_parameters":{"id":"ssh-default-account-admin-password-password"}}` ### Output | **Parameter** | **Type** | **Description** | | ------------- | -------- | -------------------------------- | | `status_code` | number | HTTP status code of the response | | `reason` | string | Response reason phrase | | `links` | array | Output field: links | | `links.href` | string | Output field: links.href | | `links.rel` | string | Output field: links.rel | ### Output Example `{"status_code":200,"response_headers":{"X-Frame-Options":"SAMEORIGIN","X-UA-Compatible":"IE=edge,chrome=1","X-Content-Type-Options":"nosniff","X-XSS-Protection":"1; mode=block","Cache-Control":"no-store, must-revalidate","Content-Type":"application/json;charset=UTF-8","Transfer-Encoding":"chunked","Content-Encoding":"gzip","Vary":"Accept-Encoding","Date":"Mon, 09 Jan 2023 16:40:56 GMT","Server":"Security Console"},"reason":"OK","json_body":{"links":[{}]}}` ## Get All Assets Fetches a comprehensive list of all assets within the Rapid7 Insight VM environment, providing an overview of networked devices. ### Endpoint - **URL:** `api/3/assets` - **Method:** `GET` ### Input | **Argument Name** | **Type** | **Required** | **Description** | | | ----------------- | -------- | ------------ | ----------------------------------------------------------------- | ------ | | `parameters.page` | number | Optional | The index of the page (zero-based) to retrieve. | | | `parameters.size` | number | Optional | The number of records per page to retrieve. | | | `parameters.sort` | string | Optional | The criteria to sort the records by, in the format property\[,ASC | DESC]. | ### Input Example `{"parameters":{"page":0,"size":10}}` ### Output | **Parameter** | **Type** | **Description** | | -------------------------------------- | -------- | -------------------------------------------------- | | `status_code` | number | HTTP status code of the response | | `reason` | string | Response reason phrase | | `resources` | array | Output field: resources | | `resources.addresses` | array | Output field: resources.addresses | | `resources.addresses.ip` | string | Output field: resources.addresses.ip | | `resources.addresses.mac` | string | Output field: resources.addresses.mac | | `resources.assessedForPolicies` | boolean | Output field: resources.assessedForPolicies | | `resources.assessedForVulnerabilities` | boolean | Output field: resources.assessedForVulnerabilities | | `resources.history` | array | Output field: resources.history | | `resources.history.date` | string | Date value | | `resources.history.scanId` | number | Unique identifier | | `resources.history.type` | string | Type of the resource | | `resources.history.version` | number | Output field: resources.history.version | | `resources.hostName` | string | Name of the resource | | `resources.hostNames` | array | Name of the resource | | `resources.hostNames.name` | string | Name of the resource | | `resources.hostNames.source` | string | Name of the resource | | `resources.id` | number | Unique identifier | | `resources.ip` | string | Output field: resources.ip | | `resources.links` | array | Output field: resources.links | | `resources.links.href` | string | Output field: resources.links.href | | `resources.links.rel` | string | Output field: resources.links.rel | | `resources.mac` | string | Output field: resources.mac | | `resources.rawRiskScore` | number | Score value | | `resources.riskScore` | number | Score value | ### Output Example `{"status_code":200,"response_headers":{"X-Frame-Options":"SAMEORIGIN","X-UA-Compatible":"IE=edge,chrome=1","X-Content-Type-Options":"nosniff","X-XSS-Protection":"1; mode=block","Cache-Control":"no-store, must-revalidate","Content-Type":"application/json;charset=UTF-8","Transfer-Encoding":"chunked","Content-Encoding":"gzip","Vary":"Accept-Encoding","Date":"Fri, 06 Jan 2023 18:19:53 GMT","Server":"Security Console"},"reason":"OK","json_body":{"resources":[{"addresses":[{"ip":"10.32.0.162","mac":"0...` ## Get Asset Retrieves detailed information for a specified asset using its unique asset\_id in Rapid7 Insight VM. ### Endpoint - **URL:** `/api/3/assets/{{asset_id}}` - **Method:** `GET` ### Input | **Argument Name** | **Type** | **Required** | **Description** | | -------------------------- | -------- | ------------ | ----------------------------------- | | `path_parameters.asset_id` | number | Required | Parameters for the Get Asset action | ### Input Example `{"path_parameters":{"asset_id":37}}` ### Output | **Parameter** | **Type** | **Description** | | ---------------------------- | -------- | ---------------------------------------- | | `status_code` | number | HTTP status code of the response | | `reason` | string | Response reason phrase | | `addresses` | array | Output field: addresses | | `addresses.ip` | string | Output field: addresses.ip | | `addresses.mac` | string | Output field: addresses.mac | | `assessedForPolicies` | boolean | Output field: assessedForPolicies | | `assessedForVulnerabilities` | boolean | Output field: assessedForVulnerabilities | | `configurations` | array | Output field: configurations | | `configurations.name` | string | Name of the resource | | `configurations.value` | string | Value for the parameter | | `history` | array | Output field: history | | `history.date` | string | Date value | | `history.scanId` | number | Unique identifier | | `history.type` | string | Type of the resource | | `history.version` | number | Output field: history.version | | `hostName` | string | Name of the resource | | `hostNames` | array | Name of the resource | | `hostNames.name` | string | Name of the resource | | `hostNames.source` | string | Name of the resource | | `id` | number | Unique identifier | | `ids` | array | Unique identifier | | `ids.id` | string | Unique identifier | | `ids.source` | string | Unique identifier | | `ip` | string | Output field: ip | | `links` | array | Output field: links | ### Output Example `{"status_code":200,"response_headers":{"X-Frame-Options":"SAMEORIGIN","X-UA-Compatible":"IE=edge,chrome=1","X-Content-Type-Options":"nosniff","X-XSS-Protection":"1; mode=block","Cache-Control":"no-store, must-revalidate","Content-Type":"application/json;charset=UTF-8","Transfer-Encoding":"chunked","Content-Encoding":"gzip","Vary":"Accept-Encoding","Date":"Tue, 23 May 2023 18:41:25 GMT","Server":"Security Console"},"reason":"OK","json_body":{"addresses":[{}],"assessedForPolicies":true,"assessedFo...` ## Get Asset Vulnerability Retrieve all vulnerabilities for a specified asset in Rapid7 Insight VM, including exceptions, by providing an asset\_id. ### Endpoint - **URL:** `api/3/assets/{{asset_id}}/vulnerabilities` - **Method:** `GET` ### Input | **Argument Name** | **Type** | **Required** | **Description** | | -------------------------- | -------- | ------------ | ------------------------------------------------- | | `path_parameters.asset_id` | number | Required | Parameters for the Get Asset Vulnerability action | | `parameters.page` | number | Optional | Parameters for the Get Asset Vulnerability action | | `parameters.size` | number | Optional | Parameters for the Get Asset Vulnerability action | ### Input Example `{"parameters":{"page":64,"size":10},"path_parameters":{"asset_id":37}}` ### Output | **Parameter** | **Type** | **Description** | | ---------------------------- | -------- | ---------------------------------- | | `status_code` | number | HTTP status code of the response | | `reason` | string | Response reason phrase | | `resources` | array | Output field: resources | | `resources.id` | string | Unique identifier | | `resources.instances` | number | Output field: resources.instances | | `resources.links` | array | Output field: resources.links | | `resources.links.href` | string | Output field: resources.links.href | | `resources.links.rel` | string | Output field: resources.links.rel | | `resources.links.id` | string | Unique identifier | | `resources.results` | array | Result of the operation | | `resources.results.port` | number | Result of the operation | | `resources.results.proof` | string | Result of the operation | | `resources.results.protocol` | string | Result of the operation | | `resources.results.since` | string | Result of the operation | | `resources.results.status` | string | Status value | | `resources.since` | string | Output field: resources.since | | `resources.status` | string | Status value | | `page` | object | Output field: page | | `page.number` | number | Output field: page.number | | `page.size` | number | Output field: page.size | | `page.totalResources` | number | Output field: page.totalResources | | `page.totalPages` | number | Output field: page.totalPages | | `links` | array | Output field: links | | `links.href` | string | Output field: links.href | | `links.rel` | string | Output field: links.rel | ### Output Example `{"status_code":200,"response_headers":{"X-Frame-Options":"SAMEORIGIN","X-UA-Compatible":"IE=edge,chrome=1","X-Content-Type-Options":"nosniff","X-XSS-Protection":"1; mode=block","Cache-Control":"no-store, must-revalidate","Content-Type":"application/json;charset=UTF-8","Transfer-Encoding":"chunked","Content-Encoding":"gzip","Vary":"Accept-Encoding","Date":"Mon, 09 Jan 2023 21:00:46 GMT","Server":"Security Console"},"reason":"OK","json_body":{"resources":[{}],"page":{"number":0,"size":10,"totalRes...` ## Get Scan Retrieves detailed information for a specific scan in Rapid7 Insight VM using the provided scan ID. ### Endpoint - **URL:** `api/3/scans/{{id}}` - **Method:** `GET` ### Input | **Argument Name** | **Type** | **Required** | **Description** | | -------------------- | -------- | ------------ | ---------------------------------- | | `path_parameters.id` | number | Required | Parameters for the Get Scan action | ### Input Example `{"path_parameters":{"id":2}}` ### Output | **Parameter** | **Type** | **Description** | | -------------------------- | -------- | -------------------------------------- | | `status_code` | number | HTTP status code of the response | | `reason` | string | Response reason phrase | | `assets` | number | Output field: assets | | `engineId` | number | Unique identifier | | `engineIds` | array | Unique identifier | | `engineName` | string | Name of the resource | | `id` | number | Unique identifier | | `links` | array | Output field: links | | `links.href` | string | Output field: links.href | | `links.rel` | string | Output field: links.rel | | `links.id` | number | Unique identifier | | `scanName` | string | Name of the resource | | `scanType` | string | Type of the resource | | `startTime` | string | Time value | | `startedByUsername` | string | Name of the resource | | `status` | string | Status value | | `vulnerabilities` | object | Output field: vulnerabilities | | `vulnerabilities.critical` | number | Output field: vulnerabilities.critical | | `vulnerabilities.moderate` | number | Output field: vulnerabilities.moderate | | `vulnerabilities.severe` | number | Output field: vulnerabilities.severe | | `vulnerabilities.total` | number | Output field: vulnerabilities.total | ### Output Example `{"status_code":200,"response_headers":{"X-Frame-Options":"SAMEORIGIN","X-UA-Compatible":"IE=edge,chrome=1","X-Content-Type-Options":"nosniff","X-XSS-Protection":"1; mode=block","Cache-Control":"no-store, must-revalidate","Content-Type":"application/json;charset=UTF-8","Transfer-Encoding":"chunked","Content-Encoding":"gzip","Vary":"Accept-Encoding","Date":"Mon, 09 Jan 2023 16:38:18 GMT","Server":"Security Console"},"reason":"OK","json_body":{"assets":0,"engineId":3,"engineIds":[3],"engineName":"L...` ## Get Solution Retrieve detailed information for a specific solution in Rapid7 Insight VM using the solution ID. ### Endpoint - **URL:** `api/3/solutions/{{id}}` - **Method:** `GET` ### Input | **Argument Name** | **Type** | **Required** | **Description** | | -------------------- | -------- | ------------ | -------------------------------------- | | `path_parameters.id` | string | Required | Parameters for the Get Solution action | ### Input Example `{"path_parameters":{"id":"1"}}` ### Output | **Parameter** | **Type** | **Description** | | ------------- | -------- | -------------------------------- | | `status_code` | number | HTTP status code of the response | | `reason` | string | Response reason phrase | | `status` | number | Status value | | `message` | string | Response message | | `links` | array | Output field: links | | `links.href` | string | Output field: links.href | | `links.rel` | string | Output field: links.rel | ### Output Example `{"status":123,"message":"string","links":[{"href":"string","rel":"string"}]}` ## Get Tag Retrieves detailed information for a specified tag in Rapid7 Insight VM using the tag's unique identifier. ### Endpoint - **URL:** `api/3/tags/{{id}}` - **Method:** `GET` ### Input | **Argument Name** | **Type** | **Required** | **Description** | | -------------------- | -------- | ------------ | --------------------------------- | | `path_parameters.id` | string | Required | Parameters for the Get Tag action | ### Input Example `{"path_parameters":{"id":"1"}}` ### Output | **Parameter** | **Type** | **Description** | | -------------- | -------- | -------------------------------- | | `status_code` | number | HTTP status code of the response | | `reason` | string | Response reason phrase | | `color` | string | Output field: color | | `created` | string | Output field: created | | `id` | number | Unique identifier | | `links` | array | Output field: links | | `links.href` | string | Output field: links.href | | `links.rel` | string | Output field: links.rel | | `name` | string | Name of the resource | | `riskModifier` | string | Output field: riskModifier | | `source` | string | Output field: source | | `type` | string | Type of the resource | ### Output Example `{"status_code":200,"response_headers":{"X-Frame-Options":"SAMEORIGIN","X-UA-Compatible":"IE=edge,chrome=1","X-Content-Type-Options":"nosniff","X-XSS-Protection":"1; mode=block","Cache-Control":"no-store, must-revalidate","Content-Type":"application/json;charset=UTF-8","Transfer-Encoding":"chunked","Content-Encoding":"gzip","Vary":"Accept-Encoding","Date":"Fri, 06 Jan 2023 20:16:31 GMT","Server":"Security Console"},"reason":"OK","json_body":{"color":"default","created":"2020-03-25T19:47:10.179Z",...` ## Get Tags Retrieves a list of configured tags from Rapid7 Insight VM without requiring an ID. ### Endpoint - **URL:** `api/3/tags` - **Method:** `GET` ### Input | **Argument Name** | **Type** | **Required** | **Description** | | ----------------- | -------- | ------------ | ---------------------------------- | | `parameters.name` | string | Optional | Parameters for the Get Tags action | | `parameters.type` | string | Optional | Parameters for the Get Tags action | | `parameters.sort` | string | Optional | Parameters for the Get Tags action | ### Input Example `{"parameters":{"name":"","type":"criticality","sort":"asc"}}` ### Output | **Parameter** | **Type** | **Description** | | ------------------------ | -------- | ------------------------------------ | | `status_code` | number | HTTP status code of the response | | `reason` | string | Response reason phrase | | `resources` | array | Output field: resources | | `resources.color` | string | Output field: resources.color | | `resources.created` | string | Output field: resources.created | | `resources.id` | number | Unique identifier | | `resources.links` | array | Output field: resources.links | | `resources.links.href` | string | Output field: resources.links.href | | `resources.links.rel` | string | Output field: resources.links.rel | | `resources.name` | string | Name of the resource | | `resources.riskModifier` | string | Output field: resources.riskModifier | | `resources.source` | string | Output field: resources.source | | `resources.type` | string | Type of the resource | | `page` | object | Output field: page | | `page.number` | number | Output field: page.number | | `page.size` | number | Output field: page.size | | `page.totalResources` | number | Output field: page.totalResources | | `page.totalPages` | number | Output field: page.totalPages | | `links` | array | Output field: links | | `links.href` | string | Output field: links.href | | `links.rel` | string | Output field: links.rel | ### Output Example `{"status_code":200,"response_headers":{"X-Frame-Options":"SAMEORIGIN","X-UA-Compatible":"IE=edge,chrome=1","X-Content-Type-Options":"nosniff","X-XSS-Protection":"1; mode=block","Cache-Control":"no-store, must-revalidate","Content-Type":"application/json;charset=UTF-8","Transfer-Encoding":"chunked","Content-Encoding":"gzip","Vary":"Accept-Encoding","Date":"Fri, 06 Jan 2023 20:11:11 GMT","Server":"Security Console"},"reason":"OK","json_body":{"resources":[{"color":"default","created":"2020-03-25T1...` ## Get Vulnerabilities Retrieve a comprehensive list of vulnerabilities from Rapid7 Insight VM for analysis and action. ### Endpoint - **URL:** `api/3/vulnerabilities` - **Method:** `GET` ### Input | **Argument Name** | **Type** | **Required** | **Description** | | ----------------- | -------- | ------------ | --------------------------------------------- | | `parameters.sort` | string | Optional | Parameters for the Get Vulnerabilities action | ### Input Example `{"parameters":{"sort":"asc"}}` ### Output | **Parameter** | **Type** | **Description** | | ----------------------------------------- | -------- | -------------------------------------------------- | | `status_code` | number | HTTP status code of the response | | `reason` | string | Response reason phrase | | `resources` | array | Output field: resources | | `resources.added` | string | Output field: resources.added | | `resources.categories` | array | Output field: resources.categories | | `resources.cvss` | object | Output field: resources.cvss | | `resources.cvss.links` | array | Output field: resources.cvss.links | | `resources.cvss.links.href` | string | Output field: resources.cvss.links.href | | `resources.cvss.links.rel` | string | Output field: resources.cvss.links.rel | | `resources.cvss.v2` | object | Output field: resources.cvss.v2 | | `resources.cvss.v2.accessComplexity` | string | Output field: resources.cvss.v2.accessComplexity | | `resources.cvss.v2.accessVector` | string | Output field: resources.cvss.v2.accessVector | | `resources.cvss.v2.authentication` | string | Output field: resources.cvss.v2.authentication | | `resources.cvss.v2.availabilityImpact` | string | Output field: resources.cvss.v2.availabilityImpact | | `resources.cvss.v2.confidentialityImpact` | string | Unique identifier | | `resources.cvss.v2.exploitScore` | number | Score value | | `resources.cvss.v2.impactScore` | number | Score value | | `resources.cvss.v2.integrityImpact` | string | Output field: resources.cvss.v2.integrityImpact | | `resources.cvss.v2.score` | number | Score value | | `resources.cvss.v2.vector` | string | Output field: resources.cvss.v2.vector | | `resources.denialOfService` | boolean | Output field: resources.denialOfService | | `resources.description` | object | Output field: resources.description | | `resources.description.html` | string | Output field: resources.description.html | | `resources.description.text` | string | Output field: resources.description.text | | `resources.exploits` | number | Output field: resources.exploits | ### Output Example `{"status_code":200,"response_headers":{"X-Frame-Options":"SAMEORIGIN","X-UA-Compatible":"IE=edge,chrome=1","X-Content-Type-Options":"nosniff","X-XSS-Protection":"1; mode=block","Cache-Control":"no-store, must-revalidate","Content-Type":"application/json;charset=UTF-8","Transfer-Encoding":"chunked","Content-Encoding":"gzip","Vary":"Accept-Encoding","Date":"Mon, 09 Jan 2023 14:20:00 GMT","Server":"Security Console"},"reason":"OK","json_body":{"resources":[{"added":"2013-01-15","categories":["Defau...` ## Get Vulnerabilities Solutions Retrieve potential solutions for remediation of a specified vulnerability in Rapid7 Insight VM, identified by its unique ID. ### Endpoint - **URL:** `api/3/vulnerabilities/{{id}}/solutions` - **Method:** `GET` ### Input | **Argument Name** | **Type** | **Required** | **Description** | | -------------------- | -------- | ------------ | ------------------------------------------------------- | | `path_parameters.id` | string | Required | Parameters for the Get Vulnerabilities Solutions action | ### Input Example `{"path_parameters":{"id":"inconclusive-host"}}` ### Output | **Parameter** | **Type** | **Description** | | ------------- | -------- | -------------------------------- | | `status_code` | number | HTTP status code of the response | | `reason` | string | Response reason phrase | | `links` | array | Output field: links | | `links.href` | string | Output field: links.href | | `links.rel` | string | Output field: links.rel | | `resources` | array | Output field: resources | ### Output Example `{"status_code":200,"response_headers":{"X-Frame-Options":"SAMEORIGIN","X-UA-Compatible":"IE=edge,chrome=1","X-Content-Type-Options":"nosniff","X-XSS-Protection":"1; mode=block","Cache-Control":"no-store, must-revalidate","Content-Type":"application/json;charset=UTF-8","Transfer-Encoding":"chunked","Content-Encoding":"gzip","Vary":"Accept-Encoding","Date":"Mon, 09 Jan 2023 21:20:40 GMT","Server":"Security Console"},"reason":"OK","json_body":{"links":[{},{}],"resources":["contact-admin"]}}` ## Get Vulnerability Retrieve detailed vulnerability findings for a specific asset in Rapid7 Insight VM using the provided 'id'. ### Endpoint - **URL:** `api/3/vulnerabilities/{{id}}` - **Method:** `GET` ### Input | **Argument Name** | **Type** | **Required** | **Description** | | -------------------- | -------- | ------------ | ------------------------------------------- | | `path_parameters.id` | string | Required | Parameters for the Get Vulnerability action | ### Input Example `{"path_parameters":{"id":"ssh-default-account-admin-password-password"}}` ### Output | **Parameter** | **Type** | **Description** | | ------------------------------- | -------- | ---------------------------------------- | | `status_code` | number | HTTP status code of the response | | `reason` | string | Response reason phrase | | `added` | string | Output field: added | | `categories` | array | Output field: categories | | `cvss` | object | Output field: cvss | | `cvss.links` | array | Output field: cvss.links | | `cvss.links.href` | string | Output field: cvss.links.href | | `cvss.links.rel` | string | Output field: cvss.links.rel | | `cvss.v2` | object | Output field: cvss.v2 | | `cvss.v2.accessComplexity` | string | Output field: cvss.v2.accessComplexity | | `cvss.v2.accessVector` | string | Output field: cvss.v2.accessVector | | `cvss.v2.authentication` | string | Output field: cvss.v2.authentication | | `cvss.v2.availabilityImpact` | string | Output field: cvss.v2.availabilityImpact | | `cvss.v2.confidentialityImpact` | string | Unique identifier | | `cvss.v2.exploitScore` | number | Score value | | `cvss.v2.impactScore` | number | Score value | | `cvss.v2.integrityImpact` | string | Output field: cvss.v2.integrityImpact | | `cvss.v2.score` | number | Score value | | `cvss.v2.vector` | string | Output field: cvss.v2.vector | | `denialOfService` | boolean | Output field: denialOfService | | `description` | object | Output field: description | | `description.html` | string | Output field: description.html | | `description.text` | string | Output field: description.text | | `exploits` | number | Output field: exploits | | `id` | string | Unique identifier | ### Output Example `{"status_code":200,"response_headers":{"X-Frame-Options":"SAMEORIGIN","X-UA-Compatible":"IE=edge,chrome=1","X-Content-Type-Options":"nosniff","X-XSS-Protection":"1; mode=block","Cache-Control":"no-store, must-revalidate","Content-Type":"application/json;charset=UTF-8","Transfer-Encoding":"chunked","Content-Encoding":"gzip","Vary":"Accept-Encoding","Date":"Mon, 09 Jan 2023 15:07:55 GMT","Server":"Security Console"},"reason":"OK","json_body":{"added":"2009-05-12","categories":["Default Account","S...` ## Report Download Downloads a specified report from Rapid7 Insight VM using the provided report ID and instance ID. ### Endpoint - **URL:** `api/3/reports/{{report_id}}/history/{{instance_id}}/output` - **Method:** `GET` ### Input | **Argument Name** | **Type** | **Required** | **Description** | | ----------------------------- | -------- | ------------ | ---------------------------------------------------------------------------------- | | `path_parameters.report_id` | string | Required | Parameters for the Report Download action | | `path_parameters.instance_id` | string | Required | The identifier of the report instance. Accepts integer as string and value latest. | ### Input Example `{"path_parameters":{"report_id":7,"instance_id":37}}` ### Output | **Parameter** | **Type** | **Description** | | ---------------- | -------- | -------------------------------- | | `status_code` | number | HTTP status code of the response | | `reason` | string | Response reason phrase | | `file` | object | Output field: file | | `file.file` | string | Output field: file.file | | `file.file_name` | string | Name of the resource | ### Output Example `{"status_code":200,"response_headers":{"X-Frame-Options":"SAMEORIGIN","X-UA-Compatible":"IE=edge,chrome=1","X-Content-Type-Options":"nosniff","X-XSS-Protection":"1; mode=block","Set-Cookie":"nexposeCCSessionID=ACF13C7DB78999431B71567100B920767EAFDDD8; Path=/; Secure; Htt...","Cache-Control":"no-store, must-revalidate","Content-Type":"text/html;charset=UTF-8","Transfer-Encoding":"chunked","Content-Encoding":"gzip","Vary":"Accept-Encoding","Date":"Mon, 09 Jan 2023 20:08:40 GMT","Connection":"close...` ## Report Generation Generates a configured report in Rapid7 Insight VM using the specified 'id' and returns the instance identifier. ### Endpoint - **URL:** `api/3/reports/{{id}}/generate` - **Method:** `POST` ### Input | **Argument Name** | **Type** | **Required** | **Description** | | -------------------- | -------- | ------------ | ------------------------------------------- | | `path_parameters.id` | number | Required | Parameters for the Report Generation action | ### Input Example `{"path_parameters":{"id":7}}` ### Output | **Parameter** | **Type** | **Description** | | ------------- | -------- | -------------------------------- | | `status_code` | number | HTTP status code of the response | | `reason` | string | Response reason phrase | | `links` | array | Output field: links | | `links.href` | string | Output field: links.href | | `links.rel` | string | Output field: links.rel | | `id` | number | Unique identifier | ### Output Example `{"status_code":200,"response_headers":{"X-Frame-Options":"SAMEORIGIN","X-UA-Compatible":"IE=edge,chrome=1","X-Content-Type-Options":"nosniff","X-XSS-Protection":"1; mode=block","Cache-Control":"no-store, must-revalidate","Content-Type":"application/json;charset=UTF-8","Transfer-Encoding":"chunked","Content-Encoding":"gzip","Vary":"Accept-Encoding","Date":"Mon, 09 Jan 2023 20:28:34 GMT","Server":"Security Console"},"reason":"OK","json_body":{"links":[{},{}],"id":9}}` ## Start Scan Initiates a scan in Rapid7 Insight VM using specified engine, hosts, and template ID, with 'id' as the required path parameter. ### Endpoint - **URL:** `api/3/sites/{{id}}/scans` - **Method:** `POST` ### Input | **Argument Name** | **Type** | **Required** | **Description** | | -------------------- | -------- | ------------ | ------------------------------------ | | `path_parameters.id` | number | Required | Parameters for the Start Scan action | | `engineId` | number | Optional | Unique identifier | | `hosts` | array | Optional | Parameter for Start Scan | | `name` | string | Optional | Name of the resource | | `templateId` | string | Optional | Unique identifier | ### Input Example `{"json_body":{"engineId":1,"hosts":["1.1.1.1"],"name":"scan test 1000","templateId":"full-audit-without-web-spider"},"path_parameters":{"id":1}}` ### Output | **Parameter** | **Type** | **Description** | | ------------- | -------- | -------------------------------- | | `status_code` | number | HTTP status code of the response | | `reason` | string | Response reason phrase | | `links` | array | Output field: links | | `links.href` | string | Output field: links.href | | `links.rel` | string | Output field: links.rel | | `id` | number | Unique identifier | ### Output Example `{"status_code":201,"response_headers":{"X-Frame-Options":"SAMEORIGIN","X-UA-Compatible":"IE=edge,chrome=1","X-Content-Type-Options":"nosniff","X-XSS-Protection":"1; mode=block","Cache-Control":"no-store, must-revalidate","Location":"https://10.32.0.199:3780/api/3/scans/3","Content-Type":"application/json;charset=UTF-8","Transfer-Encoding":"chunked","Content-Encoding":"gzip","Vary":"Accept-Encoding","Date":"Mon, 09 Jan 2023 19:10:31 GMT","Server":"Security Console"},"reason":"Created","json_body"...` # Response Headers | **Header** | **Description** | **Example** | | ---------------------- | -------------------------------------------------------- | ------------------------------------------------------------------------------------- | | Cache-Control | Directives for caching mechanisms | no-store, must-revalidate | | Connection | HTTP response header: Connection | close | | Content-Encoding | HTTP response header: Content-Encoding | gzip | | Content-Type | The media type of the resource | application/json | | Date | The date and time at which the message was originated | Mon, 09 Jan 2023 21:00:46 GMT | | Location | The URL to redirect a page to | [https://10.32.0.199:3780/api/3/scans/3](https://10.32.0.199:3780/api/3/scans/3) | | Server | Information about the software used by the origin server | Security Console | | Set-Cookie | HTTP response header: Set-Cookie | nexposeCCSessionID=ACF13C7DB78999431B71567100B920767EAFDDD8; Path=/; Secure; HttpOnly | | Transfer-Encoding | HTTP response header: Transfer-Encoding | chunked | | Vary | HTTP response header: Vary | Accept-Encoding | | X-Content-Type-Options | HTTP response header: X-Content-Type-Options | nosniff | | X-Frame-Options | HTTP response header: X-Frame-Options | SAMEORIGIN | | X-UA-Compatible | HTTP response header: X-UA-Compatible | IE=edge,chrome=1 | | X-XSS-Protection | HTTP response header: X-XSS-Protection | 1; mode=block |