InsightConnect Marketplace

Rapid7 InsightVM

Back to Marketplace

Rapid7 InsightVM

v4.0.1

InsightVM is a powerful vulnerability management tool which finds, prioritizes, and remediates vulnerabilities. This plugin can get top remediations, scan results and start scans

Tags: insightvm, rapid7

Triggers
  • New Vulnerability Exception
  • New Scans

Actions
  • Add Scan Engine Pool Engine
  • Add User Asset Group Access
  • Add User Site Access
  • Asset Search
  • Create Asset Group
  • Create Vulnerability Exception Submission
  • Create Scan Engine
  • Create Scan Engine Pool
  • Create Site
  • Create Tag
  • Create User
  • Delete Asset Group
  • Delete Vulnerability Exception
  • Delete Scan Engine
  • Delete Scan Engine Pool
  • Delete Site
  • Delete Tag
  • Delete User
  • Disable User
  • Download Report
  • Enable User
  • Generate AdHoc SQL Report
  • Generate Shared Secret
  • Get Asset
  • Get Asset Group
  • Get Asset Group Assets
  • Get Asset Groups
  • Get Asset Software
  • Get Asset Tags
  • Get Asset Vulnerabilities
  • Get Authentication Source
  • Get Authentication Sources
  • Get Role
  • Get Roles
  • Get Scan
  • Get Scan Assets
  • Get Scan Engine
  • Get Scan Engine Pool
  • Get Scan Engine Pools
  • Get Scan Engines
  • Get Scans
  • Get Site
  • Get Site Assets
  • Get Sites
  • Get Tag
  • Get Tag Asset Groups
  • Get Tag Assets
  • Get Tags
  • Get Tag Sites
  • Get User
  • Get Users
  • Get Vulnerabilities by CVE
  • Get Vulnerability Details
  • Get Vulnerability Affected Assets
  • List Reports
  • Remove Asset Group Tags
  • Remove Asset Tag
  • Remove Scan Engine Pool Engine
  • Remove Tag Asset Groups
  • Remove Tag Search Criteria
  • Remove Tag Sites
  • Remove User Asset Group Access
  • Remove User Site Access
  • Review Vulnerability Exception
  • Scan
  • Tag Asset
  • Tag Asset Group
  • Tag Site
  • Top Remediations
  • Update Asset Group Search Criteria
  • Update Scan Status
  • Update Site
  • Update Site Excluded Asset Groups
  • Update Site Excluded Targets
  • Update Site Included Asset Groups
  • Update Site Included Targets
  • Update Site Scan Engine
  • Update Tag Search Criteria
  • Update User
  • Update User Asset Group Access
  • Update User Role
  • Update User Site Access

Description

Automate your vulnerability management operations with the combined power of InsightVM and InsightConnect by using this plugin. Simplify getting data in and data out of InsightVM. As a Security Admin your time is valuable - save time by orchestrating site administration, user management, asset tagging, asset scanning and much much more!

This plugin utilizes the InsightVM API 3.

Key Features

  • Get top remediations
  • Start scans
  • Get scan results

Requirements

  • Username and password for a user with the necessary permissions

Documentation

Setup

The connection configuration accepts the following parameters:

Name Type Default Required Description Enum Example
credentials credential_username_password None True Username and password None None
url string None True URL to your InsightVM console, without trailing slashes, e.g. https://insightvm.example.com:3780|None|None|

Example input:

Technical Details

Actions

Get Asset Group Assets

This action is used to get Asset Group Assets.

Input
Name Type Default Required Description Enum Example
id integer None True Asset group ID None None

Example input:

Output
Name Type Required Description
links []link True Hypermedia links to corresponding or related resources
resources []integer False The identifiers of the associated resources

Example Output:

{
  "links": [
    {
      "href": "https://insightvm:3780/api/3/asset_groups/1/assets",
      "rel": "self"
    }
  ],
  "resources": []
}

Get Asset

This action gets an asset by ID.

Input
Name Type Default Required Description Enum Example
id integer None True Get an asset by ID None None

Example input:

Output
Name Type Required Description
asset asset True Asset details

Example Output:

{
  "asset": {
    "addresses": [
      {
        "ip": "10.0.0.1",
        "mac": "00:50:56:8A:3D:8C"
      }
    ],
    "assessedForPolicies": False,
    "assessedForVulnerabilities": True,
    "history": [
      {
        "date": "2018-08-28T11:06:47.738Z",
        "scanId": 189170,
        "type": "SCAN",
        "version": 1
      }
    ],
    "id": 74708,
    "ip": "10.0.0.1",
    "links": [
      {
        "href": "https://insightvm:3780/api/3/assets/74708",
        "rel": "self"
      },
      {
        "href": "https://insightvm:3780/api/3/assets/74708/software",
        "rel": "Software"
      },
      {
        "href": "https://insightvm:3780/api/3/assets/74708/files",
        "rel": "Files"
      },
      {
        "href": "https://insightvm:3780/api/3/assets/74708/users",
        "rel": "Users"
      },
      {
        "href": "https://insightvm:3780/api/3/assets/74708/user_groups",
        "rel": "User Groups"
      },
      {
        "href": "https://insightvm:3780/api/3/assets/74708/databases",
        "rel": "Databases"
      },
      {
        "href": "https://insightvm:3780/api/3/assets/74708/services",
        "rel": "Services"
      },
      {
        "href": "https://insightvm:3780/api/3/assets/74708/tags",
        "rel": "Tags"
      }
    ],
    "mac": "00:50:56:8A:3D:8C",
    "os": "Microsoft Windows Server 2012",
    "osFingerprint": {
      "cpe": {
        "part": "o",
        "product": "windows_server_2012",
        "update": "gold",
        "v2.2": "cpe:/o:microsoft:windows_server_2012:-:gold",
        "v2.3": "cpe:2.3:o:microsoft:windows_server_2012:-:gold:*:*:*:*:*:*",
        "vendor": "microsoft",
        "version": "-"
      },
      "description": "Microsoft Windows Server 2012",
      "family": "Windows",
      "id": 720,
      "product": "Windows Server 2012",
      "systemName": "Microsoft Windows",
      "type": "General",
      "vendor": "Microsoft"
    },
    "rawRiskScore": 4787.376953125,
    "riskScore": 4787.376953125,
    "services": [
      {
        "configurations": [
          {
            "name": "ssl",
            "value": "true"
          },
          {
            "name": "ssl.cert.chainerror",
            "value": "[Path does not chain with any of the trust anchors]"
          }
        ],
        "links": [
          {
            "href": "https://insightvm:3780/api/3/assets/74708/services/tcp/3389",
            "rel": "self"
          },
          {
            "href": "https://insightvm:3780/api/3/assets/74708/services/tcp/3389/configurations",
            "rel": "Configurations"
          },
          {
            "href": "https://insightvm:3780/api/3/assets/74708/services/tcp/3389/databases",
            "rel": "Databases"
          },
          {
            "href": "https://insightvm:3780/api/3/assets/74708/services/tcp/3389/users",
            "rel": "Users"
          },
          {
            "href": "https://insightvm:3780/api/3/assets/74708/services/tcp/3389/user_groups",
            "rel": "User Groups"
          },
          {
            "href": "https://insightvm:3780/api/3/assets/74708/services/tcp/3389/web_applications",
            "rel": "Web Applications"
          }
        ],
        "port": 3389,
        "protocol": "tcp"
      }
    ],
    "vulnerabilities": {
      "critical": 0,
      "exploits": 1,
      "malwareKits": 0,
      "moderate": 7,
      "severe": 7,
      "total": 14
    }
  }
}

Get Asset Tags

This action is used to get a listing of all tags for an asset.

Input
Name Type Default Required Description Enum Example
asset_id integer None True Identifier of asset None None

Example input:

Output
Name Type Required Description
tags []tag True List of tags

Example Output:

{
  "tags": [
    {
      "color": "default",
      "created": "2019-02-06T15:07:07.517Z",
      "id": 83,
      "links": [
        {
          "href": "https://insightvm:3780/api/3/tags/83",
          "rel": "self"
        },
        {
          "href": "https://insightvm:3780/api/3/tags/83/assets",
          "rel": "Tag Assets"
        },
        {
          "href": "https://insightvm:3780/api/3/tags/83/asset_groups",
          "rel": "Tag Asset Groups"
        },
        {
          "href": "https://insightvm:3780/api/3/tags/83/sites",
          "rel": "Tag Sites"
        },
        {
          "href": "https://insightvm:3780/api/3/tags/83/search_criteria",
          "rel": "Tag Search Criteria"
        },
        {
          "href": "https://insightvm:3780/api/3/users/2",
          "rel": "Tag Creator"
        }
      ],
      "name": "windows",
      "source": "custom",
      "sources": [
        {
          "id": 9,
          "links": [
            {
              "id": 9,
              "href": "https://insightvm:3780/api/3/asset_groups/9",
              "rel": "Asset Group"
            }
          ],
          "source": "asset-group"
        }
      ],
      "type": "custom"
    },
    {
      "color": "default",
      "created": "2019-04-24T17:06:29.296Z",
      "id": 168,
      "links": [
        {
          "href": "https://insightvm:3780/api/3/tags/168",
          "rel": "self"
        },
        {
          "href": "https://insightvm:3780/api/3/tags/168/assets",
          "rel": "Tag Assets"
        },
        {
          "href": "https://insightvm:3780/api/3/tags/168/asset_groups",
          "rel": "Tag Asset Groups"
        },
        {
          "href": "https://insightvm:3780/api/3/tags/168/sites",
          "rel": "Tag Sites"
        },
        {
          "href": "https://insightvm:3780/api/3/tags/168/search_criteria",
          "rel": "Tag Search Criteria"
        },
        {
          "href": "https://insightvm:3780/api/3/users/1",
          "rel": "Tag Creator"
        }
      ],
      "name": "Windows Servers",
      "source": "custom",
      "sources": [
        {
          "id": 12,
          "links": [
            {
              "id": 12,
              "href": "https://insightvm:3780/api/3/asset_groups/12",
              "rel": "Asset Group"
            }
          ],
          "source": "asset-group"
        }
      ],
      "type": "custom"
    }
  ]
}

Get Asset Vulnerabilities

This action is used to get vulnerabilities found on an asset. Can only be used if the asset has first been scanned (via Komand or other means).

Input
Name Type Default Required Description Enum Example
asset_id string None True ID of the asset for which to find vulnerabilities None None

Example input:

Output
Name Type Required Description
vulnerabilities []asset_vulnerability False Vulnerabilities found on the asset

Example Output:


{
  "vulnerabilities": [{
    "id": "tlsv1_1-enabled",
    "instances": 2,
    "links": [{
        "href": "",
        "rel": "self"
      },
      {
        "id": "tlsv1_1-enabled",
        "href": "",
        "rel": "Vulnerability"
      },
      {
        "id": "tlsv1_1-enabled",
        "href": "",
        "rel": "Vulnerability Validations"
      },
      {
        "id": "tlsv1_1-enabled",
        "href": "",
        "rel": "Vulnerability Solutions"
      }
    ],
    "results": [{
        "port": 995,
        "proof": "<p><p>Successfully connected to 10.4.22.249:995 over TLSv1.1</p></p>",
        "protocol": "tcp",
        "since": "2016-02-23T18:20:33.811Z",
        "status": "vulnerable"
      },
      {
        "port": 110,
        "proof": "<p><p>Successfully connected to 10.4.22.249:110 over TLSv1.1</p></p>",
        "protocol": "tcp",
        "since": "2016-02-23T18:20:33.811Z",
        "status": "vulnerable"
      }
    ],
    "since": "2016-02-23T18:20:33.811Z",
    "status": "vulnerable"
  }]
}

Get Asset Software

This action is used to get software found on an asset. Can only be used if the asset has first been scanned.

Input
Name Type Default Required Description Enum Example
asset_id string None True ID of the asset for which to find software None None

Example input:

Output
Name Type Required Description
software []software False Software found on the asset

Example Output:

{
  "software": [
    {
      "description": "Apache Struts 1.3.10",
      "family": "Struts",
      "id": 3910,
      "product": "Struts",
      "type": "Middleware",
      "vendor": "Apache",
      "version": "1.3.10"
    }
  }
}

Get Scan

This action is used to get the status of a scan.

Input
Name Type Default Required Description Enum Example
scan_id string None True ID of the scan to obtain None None

Example input:

Output
Name Type Required Description
assets integer False Number of assets within the scan
duration string False Duration of the scan in ISO8601 format
endTime string False End time of the scan in ISO8601 format
engineName string False Name of the engine used for the scan
id integer False ID of the scan
links []link False Hypermedia links to corresponding or related resources
scanName string False User-driven scan name for the scan
scanType string False Scan type (manual, automated, scheduled)
startTime string False Start time of the scan in ISO8601 format
status string False Scan status (aborted, unknown, running, finished, stopped, error, paused, dispatched or integrating)
vulnerabilities vulnerabilities_count False Counts of vulnerabilities found within the scan

Example Output:


{
  "result": {
    "assets": 0,
    "engineName": "Local scan engine",
    "id": 188934,
    "links": [
      {
        "href": "https://insightvm:3780/api/3/scans/188934",
        "rel": "self"
      }
    ],
    "scanName": "API Scan - 2018-04-23T04:21:05Z",
    "scanType": "Manual",
    "startTime": "2018-04-23T04:21:05.500Z",
    "status": "running",
    "vulnerabilities": {
      "critical": 0,
      "moderate": 0,
      "severe": 0,
      "total": 0
    }
  }
}

Get Site Assets

This action is used to get assets for a site.

Input
Name Type Default Required Description Enum Example
site_id string None True ID of the site to get assets for None None

Example input:

Output
Name Type Required Description
assets []asset False Assets

Example Output:


{
  "assets": [{
    "addresses": [{
      "ip": ""
    }],
    "assessedForPolicies": true,
    "assessedForVulnerabilities": true,
    "history": [{
      "date": "2015-04-08T20:12:24.353Z",
      "type": "SCAN",
      "version": 1
    }],
    "hostName": "",
    "hostNames": [{
          "name": "42:878126666232_i-2377d629",
          "source": "epsec"
      },
      {
          "name": "",
          "source": "dns"
      }
    ],
    "id": 18086,
    "ip": "",
    "links": [{
      "href": "",
      "rel": "self"
    }],
    "os": "Asus embedded",
    "osFingerprint": {
      "description": "Asus embedded",
      "family": "embedded",
      "id": 13792,
      "product": "embedded",
      "systemName": "Asus embedded",
      "type": "WAP",
      "vendor": "Asus"
    },
    "rawRiskScore": 0,
    "riskScore": 0,
    "vulnerabilities": {
      "critical": 0,
      "exploits": 0,
      "malwareKits": 0,
      "moderate": 0,
      "severe": 0,
      "total": 0
    }
  }]
}

Scan

This action is used to start a scan on a site.

Input
Name Type Default Required Description Enum Example
hosts []string None False The hosts that should be included in the scan None ["192.0.2.3", "192.0.2.10-192.0.2.20", "ADSRV.local"]
site_id string None True ID of the site to scan None 1

Example input:

{
  "hosts": [
    "192.0.2.3",
    "192.0.2.10-192.0.2.20",
    "ADSRV.local"
  ],
  "site_id": 1
}
Output
Name Type Required Description
id integer False Identifier of the resource created
links []link False Hypermedia links to corresponding or related resources

Example Output:


{
  "result": {
    "links": [
      {
        "href": "https://insightvm:3780/api/3/sites/44/scans",
        "rel": "self"
      },
      {
        "id": 188935,
        "href": "https://insightvm:3780/api/3/scans/188935",
        "rel": "Scan"
      }
    ],
    "id": 188935
  }
}

Generate AdHoc SQL Report

This action is used to create, generate, download, and cleanup a SQL report based on the provided query.

Input
Name Type Default Required Description Enum Example
filters string False Filters in JSON format to be applied to the contents of the report; review InsightVM API documentation for filter options None None
query string None True Reporting Data Model SQL query None None
scope string none True Scope context for generated report; if set, remediations will be scoped by each in scope ID, e.g Site ID, Tag ID, Asset Group ID; scan scope only supports single scan ID as input ['none', 'assets', 'assetGroups', 'sites', 'tags', 'scan'] None
scope_ids []integer [] False Scope IDs for which tickets should be generated, by default all are included None None

Example input:

Output
Name Type Required Description
report file True Base64 encoded file making up the report

Example Output:

{
  "report": {
    "content": "YXNzZXRfaWQsbWFjX2FkZHJlc3MsaXBfYWRkcmVzcyxob3N0X25hbWUsb3BlcmF0aW5nX3N5c3RlbV9pZCxob3N0X3R5cGVfaWQsbWF0Y2hfdmFsdWUsc2l0ZXMsbGFzdF9hc3Nlc3NlZF9mb3JfdnVsbmVyYWJpbGl0aWVzCjE0OCwsMy4xNy4yMTQuNjgsZWMyLTMtMTctMjE0LTY4LnVzLWVhc3QtMi5jb21wdXRlLmFtYXpvbmF3cy5jb20sNjEsLTEsMC4zMjQ5OTk5ODgsVGVzdC1FQzIsMjAxOS0wNC0xNiAyMDoyNzo0Mi4yNTUKMTQ5LCwzLjE5LjEyNC4yNCxlYzItMy0xOS0xMjQtMjQudXMtZWFzdC0yLmNvbXB1dGUuYW1hem9uYXdzLmNvbSwtMSwtMSwwLjMyNDk5OTk4OCxUZXN0LUVDMiwyMDE5LTA0LTE2IDIwOjI3OjU3LjM4OQo=",
    "filename": "adhoc_sql_report.csv"
  }
}

Download Report

This action is used to return the contents of a generated report.

Input
Name Type Default Required Description Enum Example
id integer None True Identifier of the report to download e.g. 265 None None
instance string None True The identifier of the report instance, 'latest' or ID e.g. 100 None None

Example input:

Output
Name Type Required Description
report bytes False Base64 encoded report

Example Output:


{
  "report": "<base64 encoded report>"
}

List Reports

This action is used to list reports and return their identifiers.

Input
Name Type Default Required Description Enum Example
name string None False Name of report, otherwise all reports by criteria None None
sort string None True Sort order, ascending or descending ['Ascending', 'Descending'] None

Example input:

Output
Name Type Required Description
found boolean False Whether optional user supplied report name was found
list []report_id False List of report identifiers

Example Output:


{
  "found": false,
  "list": [
    {
      "name": "Host Inventory",
      "id": 111
    },
    {
      "name": "PCI Host Details - Critical Assets",
      "id": 112
    },
  ]
}

Get Vulnerability Affected Assets

This action is used to get the assets affected by the vulnerability.

Input
Name Type Default Required Description Enum Example
vulnerability_id string None True The identifier of the vulnerability e.g. jre-vuln-cve-2013-2471 None None

Example input:

Output
Name Type Required Description
links []link True Hypermedia links to corresponding or related resources
resources []integer True The identifiers of the associated resources

Example Output:


{
  "links": [
    {
      "href": "https://insightvm:3780/api/3/vulnerabilities/jre-vuln-cve-2013-2471/assets",
      "rel": "self"
    },
    {
      "href": "https://insightvm:3780/api/3/assets/259",
      "rel": "Asset"
    },
    {
      "href": "https://insightvm:3780/api/3/assets/22754",
      "rel": "Asset"
    }
  ],
  "resources": [
    259,
    22754
  ]
}

Create Tag

This action is used to create a new tag.

Input
Name Type Default Required Description Enum Example
color string default False Tag color (only available for custom tags) ['default', 'blue', 'green', 'orange', 'purple', 'red'] None
name string None True Tag name None None
searchCriteria object None False Tag search Criteria - options documentation https://help.rapid7.com/insightvm/en-us/api/#section/Responses/SearchCriteria|None|None|
type string None True Tag type ['owner', 'location', 'custom'] None

Example input:

Output
Name Type Required Description
id integer True ID of the created tag

Example Output:

{
  "id": 665
}

Delete Tag

This action is used to delete an existing tag.

Input
Name Type Default Required Description Enum Example
id integer None True Tag ID None None

Example input:

Output
Name Type Required Description
links []link True Hypermedia links to corresponding or related resources

Example Output:

{
  "links": [
    {
      "href": "https://insightvm:3780/api/3/tags/20",
      "rel": "self"
    }
  ]
}

Get Tags

This action is used to get a listing of all tags and return their details.

Input
Name Type Default Required Description Enum Example
name string False Tag name regular expression by which to filter None None
type string False Type of tag by which to filter, all types are returned if none is specified ['owner', 'location', 'custom', 'criticality', ''] None

Example input:

Output
Name Type Required Description
tags []tag True List of tags

Example Output:

{
  "tags": [
    {
      "color": "default",
      "created": "2017-11-23T16:11:16.641Z",
      "id": 2,
      "links": [
        {
          "href": "https://insightvm:3780/api/3/tags/2",
          "rel": "self"
        },
        {
          "href": "https://insightvm:3780/api/3/tags/2/assets",
          "rel": "Tag Assets"
        },
        {
          "href": "https://insightvm:3780/api/3/tags/2/asset_groups",
          "rel": "Tag Asset Groups"
        },
        {
          "href": "https://insightvm:3780/api/3/tags/2/sites",
          "rel": "Tag Sites"
        },
        {
          "href": "https://insightvm:3780/api/3/tags/2/search_criteria",
          "rel": "Tag Search Criteria"
        },
        {
          "href": "https://insightvm:3780/api/3/users/0",
          "rel": "Tag Creator"
        }
      ],
      "name": "High",
      "riskModifier": "1.5",
      "source": "built-in",
      "type": "criticality"
    },
    {
      "color": "default",
      "created": "2017-11-23T16:11:16.641Z",
      "id": 4,
      "links": [
        {
          "href": "https://insightvm:3780/api/3/tags/4",
          "rel": "self"
        },
        {
          "href": "https://insightvm:3780/api/3/tags/4/assets",
          "rel": "Tag Assets"
        },
        {
          "href": "https://insightvm:3780/api/3/tags/4/asset_groups",
          "rel": "Tag Asset Groups"
        },
        {
          "href": "https://insightvm:3780/api/3/tags/4/sites",
          "rel": "Tag Sites"
        },
        {
          "href": "https://insightvm:3780/api/3/tags/4/search_criteria",
          "rel": "Tag Search Criteria"
        },
        {
          "href": "https://insightvm:3780/api/3/users/0",
          "rel": "Tag Creator"
        }
      ],
      "name": "Low",
      "riskModifier": "0.75",
      "source": "built-in",
      "type": "criticality"
    }
  ]
}

Get Tag

This action is used to get tag details by tag ID.

Input
Name Type Default Required Description Enum Example
id integer None True Tag ID, e.g. 1 None None

Example input:

Output
Name Type Required Description
tag tag True Tag Details

Example Output:

{
  "tag": {
    "color": "default",
    "created": "2014-03-21T01:45:04.584Z",
    "id": 1,
    "links": [
      {
        "href": "https://insightvm:3780/api/3/tags/1",
        "rel": "self"
      },
      {
        "href": "https://insightvm:3780/api/3/tags/1/assets",
        "rel": "Tag Assets"
      },
      {
        "href": "https://insightvm:3780/api/3/tags/1/asset_groups",
        "rel": "Tag Asset Groups"
      },
      {
        "href": "https://insightvm:3780/api/3/tags/1/sites",
        "rel": "Tag Sites"
      },
      {
        "href": "https://insightvm:3780/api/3/tags/1/search_criteria",
        "rel": "Tag Search Criteria"
      },
      {
        "href": "https://insightvm:3780/api/3/users/0",
        "rel": "Tag Creator"
      }
    ],
    "name": "Very High",
    "riskModifier": "2",
    "searchCriteria": {
      "match": "all",
      "filters": [
        {
          "field": "operating-system",
          "operator": "contains",
          "value": "windows"
        },
        {
          "field": "site-id",
          "operator": "in",
          "values": [
            "1"
          ]
        }
      ]
    },
    "source": "built-in",
    "type": "criticality"
  }
}

Get Tag Sites

This action is used to get site IDs associated with a tag.

Input
Name Type Default Required Description Enum Example
id integer None True Tag ID for which to retrieve site associations None None

Example input:

Output
Name Type Required Description
site_ids []integer True Site IDs associated with the tag

Example Output:

{
  "site_ids": [
    42
  ]
}

Get Tag Assets

This action is used to tag ID for which to retrieve asset associations.

Input
Name Type Default Required Description Enum Example
id integer None True Tag ID to add to site None None

Example input:

Output
Name Type Required Description
assets []tag_asset True Asset IDs and tag association sources for the tag

Example Output:

{
  "assets": [
    {
      "id": 3,
      "sources": [
        "asset-group",
        "criteria"
      ]
    },
    {
      "id": 18,
      "sources": [
        "site"
      ]
    }
  ]
}

Get Tag Asset Groups

This action is used to get asset groups associated with a tag.

Input
Name Type Default Required Description Enum Example
id integer None True Tag ID for which to retrieve asset group associations None None

Example input:

Output
Name Type Required Description
asset_group_ids []integer True Asset group IDs associated with the tag

Example Output:

{
  "asset_group_ids": [
    15,
    42
  ]
}

Remove Asset Tag

This action is used to remove a tag from an asset.

Input
Name Type Default Required Description Enum Example
asset_id integer None True Asset ID from which to remove the tag None None
tag_id integer None True Tag ID to remove from the asset None None

Example input:

Output
Name Type Required Description
links []link True Hypermedia links to corresponding or related resources

Example Output:

{
  "links": [
    {
      "href": "https://insightvm:3780/api/3/assets/21150/tags/69",
      "rel": "self"
    }
  ]
}

Remove Asset Group Tags

This action is used to remove all tags from an asset group.

Input
Name Type Default Required Description Enum Example
id integer None True Asset group ID from which to remove all tags None None

Example input:

Output
Name Type Required Description
links []link True Hypermedia links to corresponding or related resources

Example Output:

{
  "links": [
    {
      "href": "https://insightvm:3780/api/3/asset_groups/20/tags",
      "rel": "self"
    }
  ]
}

Remove Tag Asset Groups

This action is used to remove all asset group associations from a tag.

Input
Name Type Default Required Description Enum Example
id integer None True Tag ID from which to remove all asset group associations None None

Example input:

Output
Name Type Required Description
links []link True Hypermedia links to corresponding or related resources

Example Output:

{
  "links": [
    {
      "href": "https://insightvm:3780/api/3/tags/69/asset_groups",
      "rel": "self"
    }
  ]
}

Remove Tag Sites

This action is used to remove all site associations from a tag.

Input
Name Type Default Required Description Enum Example
id integer None True Tag ID from which to remove all site associations None None

Example input:

Output
Name Type Required Description
links []link True Hypermedia links to corresponding or related resources

Example Output:

{
  "links": [
    {
      "href": "https://insightvm:3780/api/3/tags/69/sites",
      "rel": "self"
    }
  ]
}

Remove Tag Search Criteria

This action is used to remove all search criteria from a tag.

Input
Name Type Default Required Description Enum Example
id integer None True Tag ID from which to remove all search criteria None None

Example input:

Output
Name Type Required Description
links []link True Hypermedia links to corresponding or related resources

Example Output:

{
  "links": [
    {
      "href": "https://insightvm:3780/api/3/tags/69/search_criteria",
      "rel": "self"
    }
  ]
}

Tag Asset

This action is used to add a tag to an asset.

Input
Name Type Default Required Description Enum Example
asset_id integer None True Asset ID to tag None None
tag_id integer None True Tag ID to add to site None None

Example input:

Output
Name Type Required Description
links []link True Hypermedia links to corresponding or related resources

Example Output:

{
  "links": [
    {
      "href": "https://insightvm:3780/api/3/assets/21150/tags/4",
      "rel": "self"
    }
  ]
}

Tag Asset Group

This action is used to add a tag to an asset group.

Input
Name Type Default Required Description Enum Example
asset_group_id integer None True Asset group ID to tag None None
tag_id integer None True Tag ID to add to site None None

Example input:

Output
Name Type Required Description
links []link True Hypermedia links to corresponding or related resources

Example Output:

{
  "links": [
    {
      "href": "https://insightvm:3780/api/3/asset_groups/20/tags/69",
      "rel": "self"
    }
  ]
}

Tag Site

This action is used to add a tag to a site.

Input
Name Type Default Required Description Enum Example
site_id integer None True Site ID to tag None None
tag_id integer None True Tag ID to add to site None None

Example input:

Output
Name Type Required Description
links []link True Hypermedia links to corresponding or related resources

Example Output:

{
  "links": [
    {
      "href": "https://insightvm:3780/api/3/sites/42/tags/69",
      "rel": "self"
    }
  ]
}

Update Tag Search Criteria

This action is used to update the search criteria for an existing tag.

Input
Name Type Default Required Description Enum Example
id integer None True Tag ID None None
searchCriteria object None True Tag search criteria - options documentation: https://help.rapid7.com/insightvm/en-us/api/#section/Responses/SearchCriteria|None|None|

Example input:

Output
Name Type Required Description
links []link True Hypermedia links to corresponding or related resources

Example Output:

{
  "links": [
    {
      "href": "https://insightvm:3780/api/3/tags/69/search_criteria",
      "rel": "self"
    }
  ]
}

This action is used to search for assets using a filtered asset search.

Input
Name Type Default Required Description Enum Example
searchCriteria object None True Tag search criteria - options documentation: https://help.rapid7.com/insightvm/en-us/api/#section/Responses/SearchCriteria|None|None|

Example input:

Output
Name Type Required Description
assets []asset True List of asset details returned by the search

Example Output:

{
  "assets": [
      {
          "addresses": [
              {
                  "ip": "10.0.0.1",
                  "mac": "00:50:56:8A:3D:8C"
              }
          ],
          "assessedForPolicies": False,
          "assessedForVulnerabilities": True,
          "history": [
              {
                  "date": "2018-08-28T11:06:47.738Z",
                  "scanId": 189170,
                  "type": "SCAN",
                  "version": 1
              }
          ],
          "id": 74708,
          "ip": "10.0.0.1",
          "links": [
              {
                  "href": "https://insightvm:3780/api/3/assets/74708",
                  "rel": "self"
              },
              {
                  "href": "https://insightvm:3780/api/3/assets/74708/software",
                  "rel": "Software"
              },
              {
                  "href": "https://insightvm:3780/api/3/assets/74708/files",
                  "rel": "Files"
              },
              {
                  "href": "https://insightvm:3780/api/3/assets/74708/users",
                  "rel": "Users"
              },
              {
                  "href": "https://insightvm:3780/api/3/assets/74708/user_groups",
                  "rel": "User Groups"
              },
              {
                  "href": "https://insightvm:3780/api/3/assets/74708/databases",
                  "rel": "Databases"
              },
              {
                  "href": "https://insightvm:3780/api/3/assets/74708/services",
                  "rel": "Services"
              },
              {
                  "href": "https://insightvm:3780/api/3/assets/74708/tags",
                  "rel": "Tags"
              }
          ],
          "mac": "00:50:56:8A:3D:8C",
          "os": "Microsoft Windows Server 2012",
          "osFingerprint": {
              "cpe": {
                  "part": "o",
                  "product": "windows_server_2012",
                  "update": "gold",
                  "v2.2": "cpe:/o:microsoft:windows_server_2012:-:gold",
                  "v2.3": "cpe:2.3:o:microsoft:windows_server_2012:-:gold:*:*:*:*:*:*",
                  "vendor": "microsoft",
                  "version": "-"
              },
              "description": "Microsoft Windows Server 2012",
              "family": "Windows",
              "id": 720,
              "product": "Windows Server 2012",
              "systemName": "Microsoft Windows",
              "type": "General",
              "vendor": "Microsoft"
          },
          "rawRiskScore": 4787.376953125,
          "riskScore": 4787.376953125,
          "services": [
              {
                  "configurations": [
                      {
                          "name": "ssl",
                          "value": "true"
                      },
                      {
                          "name": "ssl.cert.chainerror",
                          "value": "[Path does not chain with any of the trust anchors]"
                      }
                  ],
                  "links": [
                      {
                          "href": "https://insightvm:3780/api/3/assets/74708/services/tcp/3389",
                          "rel": "self"
                      },
                      {
                          "href": "https://insightvm:3780/api/3/assets/74708/services/tcp/3389/configurations",
                          "rel": "Configurations"
                      },
                      {
                          "href": "https://insightvm:3780/api/3/assets/74708/services/tcp/3389/databases",
                          "rel": "Databases"
                      },
                      {
                          "href": "https://insightvm:3780/api/3/assets/74708/services/tcp/3389/users",
                          "rel": "Users"
                      },
                      {
                          "href": "https://insightvm:3780/api/3/assets/74708/services/tcp/3389/user_groups",
                          "rel": "User Groups"
                      },
                      {
                          "href": "https://insightvm:3780/api/3/assets/74708/services/tcp/3389/web_applications",
                          "rel": "Web Applications"
                      }
                  ],
                  "port": 3389,
                  "protocol": "tcp"
              }
          ],
          "vulnerabilities": {
              "critical": 0,
              "exploits": 1,
              "malwareKits": 0,
              "moderate": 7,
              "severe": 7,
              "total": 14
          }
      }
  ]
}

Create Asset Group

This action is used to create an asset group.

Input
Name Type Default Required Description Enum Example
description string None False Asset group description None None
name string None True Asset group name None None
searchCriteria object None False Asset group search criteria - options documentation: https://help.rapid7.com/insightvm/en-us/api/#section/Responses/SearchCriteria|None|None|
type string None True Asset group type ['dynamic', 'static'] None

Example input:

Output
Name Type Required Description
id integer True ID of the created tag

Example Output:

{
  "id": 20
}

Create Site

This action is used to create a new site.

Input
Name Type Default Required Description Enum Example
description string None False The site's description None None
engine_id integer None False The identifier of a scan engine. Default scan engine is selected when not specified None None
excluded_addresses []string [] False List of addresses to exclude in scan scope None None
excluded_asset_groups []integer [] False Assets associated with these asset group IDs will be excluded in the site None None
importance string normal False The site importance ['very_low', 'low', 'normal', 'high', 'very_high'] None
included_addresses []string [] False List of addresses to include in scan scope None None
included_asset_groups []integer [] False Assets associated with these asset group IDs will be included in the site None None
name string None True The site name. Name must be unique None None
scan_template_id string None False The identifier of a scan template None None

Example input:

Output
Name Type Required Description
id integer True The identifier of the created site
links []link True Hypermedia links to corresponding or related resources

Example Output:

{
  "links": [
    {
      "href": "https://insightvm:3780/api/3/sites",
      "rel": "self"
    },
    {
      "id": 15,
      "href": "https://insightvm:3780/api/3/sites/15",
      "rel": "Site"
    }
  ],
  "id": 15
}

Update Site

This action is used to update an existing site.

Input
Name Type Default Required Description Enum Example
description string None True The site's description None None
engine_id integer None True The identifier of a scan engine. Default scan engine is selected when not specified None None
id integer None True The identifier of the site None None
importance string normal True The site importance ['very_low', 'low', 'normal', 'high', 'very_high'] None
name string None True The site name. Name must be unique None None
scan_template_id string None True The identifier of a scan template None None

Example input:

Output
Name Type Required Description
id integer True The identifier of the updated site
links []link True Hypermedia links to corresponding or related resources

Example Output:

{
  "id": 332,
  "links": [
    {
      "href": "https://insightvm:3780/api/3/sites/332",
      "rel": "self"
    }
  ]
}

Update Site Included Targets

This action is used to update an existing site scope of included IP address and hostname targets.

Input
Name Type Default Required Description Enum Example
id integer None True The identifier of the site None None
included_targets []string None False List of addresses that represent either a hostname, IPv4 address, IPv4 address range, IPv6 address, or CIDR notation None None
overwrite boolean True True Whether to overwrite the included targets to the current site or append to the previous list of included targets None None

Example input:

Output
Name Type Required Description
id integer True The identifier of the updated site
links []link True Hypermedia links to corresponding or related resources

Example Output:

{
  "id": 332,
  "links": [
    {
      "href": "https://insightvm:3780/api/3/sites/332/included_targets",
      "rel": "self"
    }
  ]
}

Update Site Excluded Targets

This action is used to update an existing site scope of excluded IP address and hostname targets.

Input
Name Type Default Required Description Enum Example
excluded_targets []string None False List of addresses that represent either a hostname, IPv4 address, IPv4 address range, IPv6 address, or CIDR notation None None
id integer None True The identifier of the site None None
overwrite boolean True True Whether to overwrite the excluded targets to the current site or append to the previous list of excluded targets None None

Example input:

Output
Name Type Required Description
id integer True The identifier of the updated site
links []link True Hypermedia links to corresponding or related resources

Example Output:

{
  "id": 332,
  "links": [
    {
      "href": "https://insightvm:3780/api/3/sites/332/excluded_targets",
      "rel": "self"
    }
  ]
}

Update Site Included Asset Groups

This action is used to update an existing site scope of included asset groups.

Input
Name Type Default Required Description Enum Example
id integer None True The identifier of the site None None
included_asset_groups []integer None False Assets associated with these asset group IDs will be included in the site None None
overwrite boolean True True Whether to overwrite the included asset group IDs to the current site or append to the previous list of asset group IDs None None

Example input:

Output
Name Type Required Description
id integer True The identifier of the updated site
links []link True Hypermedia links to corresponding or related resources

Example Output:

{
  "id": 332,
  "links": [
    {
      "href": "https://insightvm:3780/api/3/sites/332/included_asset_groups",
      "rel": "self"
    }
  ]
}

Update Site Excluded Asset Groups

This action is used to update an existing site scope of excluded asset groups.

Input
Name Type Default Required Description Enum Example
excluded_asset_groups []integer None False Assets associated with these asset group IDs will be excluded from the site None None
id integer None True The identifier of the site None None
overwrite boolean True True Whether to overwrite the excluded asset group IDs to the current site or append to the previous list of asset group IDs None None

Example input:

Output
Name Type Required Description
id integer True The identifier of the updated site
links []link True Hypermedia links to corresponding or related resources

Example Output:

{
  "id": 332,
  "links": [
    {
      "href": "https://insightvm:3780/api/3/sites/332/excluded_asset_groups",
      "rel": "self"
    }
  ]
}

Delete Site

This action is used to delete an existing site.

Input
Name Type Default Required Description Enum Example
id integer None True Site ID None None

Example input:

Output
Name Type Required Description
links []link True Hypermedia links to corresponding or related resources

Example Output:

{
  "links": [
    {
      "href": "https://insightvm:3780/api/3/sites/322",
      "rel": "self"
    }
  ]
}

Get Asset Groups

This action is used to get a list of asset groups.

Input
Name Type Default Required Description Enum Example
name string False Asset group name regular expression by which to filter None None

Example input:

Output
Name Type Required Description
asset_groups []asset_group True List of asset groups

Example Output:

{
  "asset_groups": [
    {
      "assets": 5,
      "description": "This is a test",
      "id": 53,
      "links": [
        {
          "href": "https://insightvm:3780/api/3/asset_groups/53",
          "rel": "self"
        },
        {
          "href": "https://insightvm:3780/api/3/asset_groups/53/tags",
          "rel": "Asset Group Tags"
        },
        {
          "href": "https://insightvm:3780/api/3/asset_groups/53/assets",
          "rel": "Asset Group Assets"
        },
        {
          "href": "https://insightvm:3780/api/3/asset_groups/53/users",
          "rel": "Asset Group Users"
        }
      ],
      "name": "Test Asset Group",
      "riskScore": 1305499,
      "searchCriteria": {
        "match": "all",
        "filters": [
          {
            "field": "host-name",
            "operator": "contains",
            "value": "meta"
          }
        ]
      },
      "type": "dynamic",
      "vulnerabilities": {
        "critical": 449,
        "moderate": 150,
        "severe": 1101,
        "total": 1700
      }
    }
  ]
}

Get Asset Group

This action is used to get an asset group by ID.

Input
Name Type Default Required Description Enum Example
id integer None True Asset group ID None None

Example input:

Output
Name Type Required Description
asset_group asset_group True Asset group

Example Output:

{
  "asset_group": {
    "assets": 5,
    "description": "This is a test",
    "id": 53,
    "links": [
      {
        "href": "https://insightvm:3780/api/3/asset_groups/53",
        "rel": "self"
      },
      {
        "href": "https://insightvm:3780/api/3/asset_groups/53/tags",
        "rel": "Asset Group Tags"
      },
      {
        "href": "https://insightvm:3780/api/3/asset_groups/53/assets",
        "rel": "Asset Group Assets"
      },
      {
        "href": "https://insightvm:3780/api/3/asset_groups/53/users",
        "rel": "Asset Group Users"
      }
    ],
    "name": "Test Asset Group",
    "riskScore": 1305499,
    "searchCriteria": {
      "match": "all",
      "filters": [
        {
          "field": "host-name",
          "operator": "contains",
          "value": "meta"
        }
      ]
    },
    "type": "dynamic",
    "vulnerabilities": {
      "critical": 449,
      "moderate": 150,
      "severe": 1101,
      "total": 1700
    }
  }
}

Delete Asset Group

This action is used to delete an existing asset group.

Input
Name Type Default Required Description Enum Example
id integer None True Asset group ID None None

Example input:

Output
Name Type Required Description
links []link True Hypermedia links to corresponding or related resources

Example Output:

{
  "links": [
    {
      "href": "https://insightvm:3780/api/3/asset_groups/20",
      "rel": "self"
    }
  ]
}

Update Asset Group Search Criteria

This action is used to update the search criteria for an existing asset group.

Input
Name Type Default Required Description Enum Example
id integer None True Asset group ID None None
searchCriteria object None True Asset group search criteria - options documentation: https://help.rapid7.com/insightvm/en-us/api/#section/Responses/SearchCriteria|None|None|

Example input:

Output
Name Type Required Description
links []link True Hypermedia links to corresponding or related resources

Example Output:

{
  "links": [
    {
      "href": "https://insightvm:3780/api/3/tags/69/search_criteria",
      "rel": "self"
    }
  ]
}

Get Sites

This action is used to get a list of sites.

Input
Name Type Default Required Description Enum Example
name string False Site name regular expression by which to filter None None

Example input:

Output
Name Type Required Description
sites []site True List of sites

Example Output:

{
  "sites": [
    {
      "assets": 13,
      "id": 37,
      "importance": "normal",
      "lastScanTime": "2016-03-26T19:17:30.806Z",
      "links": [
        {
          "href": "https://insightvm:3780/api/3/sites/37",
          "rel": "self"
        },
        {
          "href": "https://insightvm:3780/api/3/sites/37/alerts",
          "rel": "Alerts"
        },
        {
          "href": "https://insightvm:3780/api/3/sites/37/scan_engine",
          "rel": "Scan Engine"
        },
        {
          "href": "https://insightvm:3780/api/3/sites/37/scan_schedules",
          "rel": "Schedules"
        },
        {
          "href": "https://insightvm:3780/api/3/sites/37/organization",
          "rel": "Organization"
        },
        {
          "href": "https://insightvm:3780/api/3/sites/37/tags",
          "rel": "Tags"
        },
        {
          "href": "https://insightvm:3780/api/3/sites/37/users",
          "rel": "Users"
        },
        {
          "href": "https://insightvm:3780/api/3/sites/37/scan_template",
          "rel": "Template"
        },
        {
          "href": "https://insightvm:3780/api/3/sites/37/site_credentials",
          "rel": "Site Credentials"
        },
        {
          "href": "https://insightvm:3780/api/3/sites/37/shared_credentials",
          "rel": "Assigned Shared Credentials"
        },
        {
          "href": "https://insightvm:3780/api/3/sites/37/web_authentication/html_forms",
          "rel": "Web HTML Forms Authentication"
        },
        {
          "href": "https://insightvm:3780/api/3/sites/37/web_authentication/http_headers",
          "rel": "Web HTTP Headers Authentication"
        },
        {
          "href": "https://insightvm:3780/api/3/sites/37/assets",
          "rel": "Assets"
        },
        {
          "href": "https://insightvm:3780/api/3/sites/37/included_targets",
          "rel": "Included Targets"
        },
        {
          "href": "https://insightvm:3780/api/3/sites/37/excluded_targets",
          "rel": "Excluded Targets"
        },
        {
          "href": "https://insightvm:3780/api/3/sites/37/included_asset_groups",
          "rel": "Included Asset Groups"
        },
        {
          "href": "https://insightvm:3780/api/3/sites/37/excluded_asset_groups",
          "rel": "Excluded Asset Groups"
        }
      ],
      "name": "Toronto - Discovery",
      "riskScore": 0,
      "scanEngine": 2,
      "scanTemplate": "aggressive-discovery",
      "type": "static",
      "vulnerabilities": {
        "critical": 0,
        "moderate": 0,
        "severe": 0,
        "total": 0
      }
    }
  ]
}

Get Site

This action is used to get a site by ID.

Input
Name Type Default Required Description Enum Example
id integer None True Site ID None None

Example input:

Output
Name Type Required Description
site site True Site details

Example Output:

{
  "site": {
    "assets": 10,
    "id": 39,
    "importance": "normal",
    "links": [
      {
        "href": "https://insightvm:3780/api/3/sites/39",
        "rel": "self"
      },
      {
        "href": "https://insightvm:3780/api/3/sites/39/alerts",
        "rel": "Alerts"
      },
      {
        "href": "https://insightvm:3780/api/3/sites/39/scan_engine",
        "rel": "Scan Engine"
      },
      {
        "href": "https://insightvm:3780/api/3/sites/39/scan_schedules",
        "rel": "Schedules"
      },
      {
        "href": "https://insightvm:3780/api/3/sites/39/organization",
        "rel": "Organization"
      },
      {
        "href": "https://insightvm:3780/api/3/sites/39/tags",
        "rel": "Tags"
      },
      {
        "href": "https://insightvm:3780/api/3/sites/39/users",
        "rel": "Users"
      },
      {
        "href": "https://insightvm:3780/api/3/sites/39/scan_template",
        "rel": "Template"
      },
      {
        "href": "https://insightvm:3780/api/3/sites/39/site_credentials",
        "rel": "Site Credentials"
      },
      {
        "href": "https://insightvm:3780/api/3/sites/39/shared_credentials",
        "rel": "Assigned Shared Credentials"
      },
      {
        "href": "https://insightvm:3780/api/3/sites/39/web_authentication/html_forms",
        "rel": "Web HTML Forms Authentication"
      },
      {
        "href": "https://insightvm:3780/api/3/sites/39/web_authentication/http_headers",
        "rel": "Web HTTP Headers Authentication"
      },
      {
        "href": "https://insightvm:3780/api/3/sites/39/assets",
        "rel": "Assets"
      },
      {
        "href": "https://insightvm:3780/api/3/sites/39/included_targets",
        "rel": "Included Targets"
      },
      {
        "href": "https://insightvm:3780/api/3/sites/39/excluded_targets",
        "rel": "Excluded Targets"
      },
      {
        "href": "https://insightvm:3780/api/3/sites/39/included_asset_groups",
        "rel": "Included Asset Groups"
      },
      {
        "href": "https://insightvm:3780/api/3/sites/39/excluded_asset_groups",
        "rel": "Excluded Asset Groups"
      }
    ],
    "name": "Toronto - Discovery",
    "riskScore": 0,
    "scanEngine": 2,
    "scanTemplate": "aggressive-discovery",
    "type": "static",
    "vulnerabilities": {
      "critical": 0,
      "moderate": 0,
      "severe": 0,
      "total": 0
    }
  }
}

Get Vulnerabilities by CVE

This action is used to get vulnerability details associated with a CVE.

Input
Name Type Default Required Description Enum Example
cve_id string None True Common Vulnerabilities and Exposures ID, e.g. CVE-2018-12345 None None

Example input:

Output
Name Type Required Description
vulnerabilities []vulnerability True Vulnerability details

Example Output:

{
  "vulnerabilities": [
    {
      "added": "2008-10-23",
      "categories": [
        "IAVM",
        "Microsoft",
        "Microsoft Patch",
        "Microsoft Windows",
        "RPC",
        "Remote Execution"
      ],
      "cves": [
        "CVE-2008-4250"
      ],
      "cvss": {
        "links": [
          {
            "href": "https://nvd.nist.gov/vuln-metrics/cvss/v2-calculator?vector=(AV:N/AC:L/Au:N/C:C/I:C/A:C)",
            "rel": "CVSS v2 Calculator"
          }
        ],
        "v2": {
          "accessComplexity": "L",
          "accessVector": "N",
          "authentication": "N",
          "availabilityImpact": "C",
          "confidentialityImpact": "C",
          "exploitScore": 9.9968,
          "impactScore": 10.0008,
          "integrityImpact": "C",
          "score": 10,
          "vector": "AV:N/AC:L/Au:N/C:C/I:C/A:C"
        }
      },
      "denialOfService": false,
      "description": {
        "html": "<p>This security update resolves a privately reported vulnerability in the Server service. The vulnerability could allow remote code execution if an affected system received a specially crafted RPC request. It is possible that an attacker could exploit this vulnerability without authentication to run arbitrary code. It is possible that this vulnerability could be used in the crafting of a wormable exploit. Firewall best practices and standard default firewall configurations can help protect network resources from attacks that originate outside the enterprise perimeter.</p>",
        "text": "This security update resolves a privately reported vulnerability in the Server service. The vulnerability could allow remote code execution if an affected system received a specially crafted RPC request. It is possible that an attacker could exploit this vulnerability without authentication to run arbitrary code. It is possible that this vulnerability could be used in the crafting of a wormable exploit. Firewall best practices and standard default firewall configurations can help protect network resources from attacks that originate outside the enterprise perimeter."
      },
      "exploits": 6,
      "id": "windows-hotfix-ms08-067",
      "links": [
        {
          "href": "https://insightvm:3780/api/3/vulnerabilities/windows-hotfix-ms08-067",
          "rel": "self"
        },
        {
          "href": "https://insightvm:3780/api/3/vulnerabilities/windows-hotfix-ms08-067/checks",
          "rel": "Vulnerability Checks"
        },
        {
          "href": "https://insightvm:3780/api/3/vulnerabilities/windows-hotfix-ms08-067/references",
          "rel": "Vulnerability References"
        },
        {
          "href": "https://insightvm:3780/api/3/vulnerabilities/windows-hotfix-ms08-067/malware_kits",
          "rel": "Vulnerability Malware Kits"
        },
        {
          "href": "https://insightvm:3780/api/3/vulnerabilities/windows-hotfix-ms08-067/exploits",
          "rel": "Vulnerability Exploits"
        },
        {
          "href": "https://insightvm:3780/api/3/vulnerabilities/windows-hotfix-ms08-067/solutions",
          "rel": "Vulnerability Solutions"
        }
      ],
      "malwareKits": 0,
      "modified": "2018-03-21",
      "pci": {
        "adjustedCVSSScore": 10,
        "adjustedSeverityScore": 5,
        "fail": true,
        "status": "Fail"
      },
      "published": "2008-10-23",
      "riskScore": 902.24,
      "severity": "Critical",
      "severityScore": 10,
      "title": "MS08-067: Vulnerability in Server Service Could Allow Remote Code Execution (958644)"
    }
  ]
}

Get Scan Assets

This action gets assets for a scan.

Input
Name Type Default Required Description Enum Example
scan_id integer None True ID of the scan to get assets for None None

Example input:

Output
Name Type Required Description
assets []asset False Assets

Example Output:

{
  "assets": [
    {
      "addresses": [
        {
          "ip": "10.0.0.1"
        }
      ],
      "assessedForPolicies": false,
      "assessedForVulnerabilities": true,
      "history": [
        {
          "date": "2019-04-17T00:27:42.255Z",
          "scanId": 1235,
          "type": "SCAN",
          "version": 1
        },
        {
          "date": "2019-06-17T17:05:26.236Z",
          "scanId": 2160,
          "type": "SCAN",
          "version": 2
        },
        {
          "date": "2019-06-17T18:23:42.565Z",
          "scanId": 2161,
          "type": "SCAN",
          "version": 3
        },
        {
          "date": "2019-06-17T18:31:13.270Z",
          "scanId": 2162,
          "type": "SCAN",
          "version": 4
        }
      ],
      "hostName": "hostname.us-east-2.compute.amazonaws.com",
      "hostNames": [
        {
          "name": "hostname.us-east-2.compute.amazonaws.com",
          "source": "dns"
        }
      ],
      "id": 148,
      "ip": "10.0.0.1",
      "links": [
        {
          "href": "https://insightvm:3780/api/3/assets/148",
          "rel": "self"
        },
        {
          "href": "https://insightvm:3780/api/3/assets/148/software",
          "rel": "Software"
        },
        {
          "href": "https://insightvm:3780/api/3/assets/148/files",
          "rel": "Files"
        },
        {
          "href": "https://insightvm:3780/api/3/assets/148/users",
          "rel": "Users"
        },
        {
          "href": "https://insightvm:3780/api/3/assets/148/user_groups",
          "rel": "User Groups"
        },
        {
          "href": "https://insightvm:3780/api/3/assets/148/databases",
          "rel": "Databases"
        },
        {
          "href": "https://insightvm:3780/api/3/assets/148/services",
          "rel": "Services"
        },
        {
          "href": "https://insightvm:3780/api/3/assets/148/tags",
          "rel": "Tags"
        }
      ],
      "rawRiskScore": 0,
      "riskScore": 0,
      "vulnerabilities": {
        "critical": 0,
        "exploits": 0,
        "malwareKits": 0,
        "moderate": 0,
        "severe": 0,
        "total": 0
      }
    }
  ]
}

Get Scans

This action is used to get scans with optional site filter.

Input
Name Type Default Required Description Enum Example
active boolean False False Return running scans or past scans None None
id integer None False Site ID None None

Example input:

Output
Name Type Required Description
scans []scan True List of scan details

Example Output:

{
  "scans": [
    {
      "assets": 2,
      "duration": "PT2M24.049S",
      "endTime": "2018-10-28T16:03:24.173Z",
      "engineId": 2,
      "engineName": "Local scan engine",
      "id": 189739,
      "links": [
        {
          "href": "https://insightvm:3780/api/3/scans/189739",
          "rel": "self"
        },
        {
          "id": 2,
          "href": "https://insightvm:3780/api/3/scan_engines/2",
          "rel": "Scan Engine"
        }
      ],
      "scanName": "Sun 28 Oct 2018 09:01 AM",
      "scanType": "Scheduled",
      "startTime": "2018-10-28T16:01:00.124Z",
      "status": "finished",
      "vulnerabilities": {
        "critical": 0,
        "moderate": 0,
        "severe": 0,
        "total": 0
      },
      "siteId": 41,
      "siteName": "AWS"
    }
  ]
}

Update Scan Status

This action is used to update the status of a scan (pause, resume, stop).

Input
Name Type Default Required Description Enum Example
id integer None True Scan ID None None
status string stop True Status to which the scan should be set (stop, resume, pause) ['stop', 'resume', 'pause'] None

Example input:

Output
Name Type Required Description
links []link True Hypermedia links to corresponding or related resources

Example Output:

{
  "links": [
    {
      "href": "https://insightvm:3780/api/3/scans/1026/stop",
      "rel": "self"
    }
  ]
}

Generate Shared Secret

This action is used to generate a shared secret for use with pairing a scan engine using the engine -> console communication direction.

Input
Name Type Default Required Description Enum Example
time_to_live integer 3600 True Time to live in seconds for the shared secret None None

Example input:

Output
Name Type Required Description
shared_secret string True Scan engine pairing shared secret

Example Output:

{
  "shared_secret": "99DB-B9F0-CD8B-5997-06BF-607B-BA21-0A81"
}

Get Scan Engines

This action is used to list scan engines paired with the security console.

Input
Name Type Default Required Description Enum Example
address string None False Optional address (IP/hostname) by which to filter, accepts regular expression patterns None None
name string None False Optional engine name by which to filter, accepts regular expression patterns None None

Example input:

Output
Name Type Required Description
scan_engines []scan_engine True List of scan engines details

Example Output:

{
  "scan_engines": [
    {
      "address": "10.0.0.24",
      "contentVersion": "1327036290 (2018-10-24)",
      "id": 4,
      "lastRefreshedDate": "2018-10-29T14:43:31.201Z",
      "lastUpdatedDate": "2018-10-24T15:10:10.291Z",
      "links": [
        {
          "href": "https://insightvm:3780/api/3/scan_engines/4",
          "rel": "self"
        },
        {
          "href": "https://insightvm:3780/api/3/scan_engines/4/sites",
          "rel": "Sites"
        },
        {
          "id": 4,
          "href": "https://insightvm:3780/api/3/scan_engines/4/scan_engine_pools",
          "rel": "Associated Engine Pools"
        },
        {
          "href": "https://insightvm:3780/api/3/scan_engines/4/scans",
          "rel": "Scans"
        }
      ],
      "name": "AWS",
      "port": 40814,
      "productVersion": "2445745114 (2018-10-22)",
      "sites": [
        193,
        194,
        195,
        196,
        197,
        198,
        199
      ],
      "enginePools": [
        6
      ]
    },
    {
      "address": "10.0.0.23",
      "contentVersion": "1327036290 (2018-10-24)",
      "id": 5,
      "lastRefreshedDate": "2018-10-29T14:43:33.036Z",
      "lastUpdatedDate": "2018-10-24T15:10:10.291Z",
      "links": [
        {
          "href": "https://insightvm:3780/api/3/scan_engines/5",
          "rel": "self"
        },
        {
          "href": "https://insightvm:3780/api/3/scan_engines/5/sites",
          "rel": "Sites"
        },
        {
          "id": 5,
          "href": "https://insightvm:3780/api/3/scan_engines/5/scan_engine_pools",
          "rel": "Associated Engine Pools"
        },
        {
          "href": "https://insightvm:3780/api/3/scan_engines/5/scans",
          "rel": "Scans"
        }
      ],
      "name": "Azure",
      "port": 40814,
      "productVersion": "2445745114 (2018-10-22)",
      "sites": [
        207
      ],
      "enginePools": [
        6
      ]
    },
    {
      "address": "test",
      "id": 6,
      "links": [
        {
          "href": "https://insightvm:3780/api/3/scan_engines/6",
          "rel": "self"
        },
        {
          "href": "https://insightvm:3780/api/3/scan_engines/6/sites",
          "rel": "Sites"
        },
        {
          "id": 6,
          "href": "https://insightvm:3780/api/3/scan_engines/6/scan_engine_pools",
          "rel": "Associated Engine Pools"
        },
        {
          "href": "https://insightvm:3780/api/3/scan_engines/6/scans",
          "rel": "Scans"
        }
      ],
      "name": "test",
      "port": -1,
      "enginePools": []
    },
    {
      "address": "nse.extranet.rapid7.com",
      "id": 1,
      "links": [
        {
          "href": "https://insightvm:3780/api/3/scan_engines/1",
          "rel": "self"
        },
        {
          "href": "https://insightvm:3780/api/3/scan_engines/1/sites",
          "rel": "Sites"
        },
        {
          "id": 1,
          "href": "https://insightvm:3780/api/3/scan_engines/1/scan_engine_pools",
          "rel": "Associated Engine Pools"
        },
        {
          "href": "https://insightvm:3780/api/3/scan_engines/1/scans",
          "rel": "Scans"
        }
      ],
      "name": "Rapid7 Hosted Scan Engine",
      "port": 40814,
      "sites": [
        5
      ],
      "enginePools": []
    },
    {
      "address": "127.0.0.1",
      "contentVersion": "801603722 (2018-07-11)",
      "id": 3,
      "lastUpdatedDate": "2018-07-11T09:13:04.639Z",
      "links": [
        {
          "href": "https://insightvm:3780/api/3/scan_engines/3",
          "rel": "self"
        },
        {
          "href": "https://insightvm:3780/api/3/scan_engines/3/sites",
          "rel": "Sites"
        },
        {
          "id": 3,
          "href": "https://insightvm:3780/api/3/scan_engines/3/scan_engine_pools",
          "rel": "Associated Engine Pools"
        },
        {
          "href": "https://insightvm:3780/api/3/scan_engines/3/scans",
          "rel": "Scans"
        }
      ],
      "name": "Local scan engine",
      "port": 40814,
      "productVersion": "1267385905 (2018-07-11)",
      "sites": [
        256,
        1,
        257,
        258,
        259,
        260
      ],
      "enginePools": []
    }
  ]
}

Get Scan Engine

This action is used to get a scan engine by ID.

Input
Name Type Default Required Description Enum Example
id integer None True Scan engine identifier None None

Example input:

Output
Name Type Required Description
scan_engine scan_engine True Scan engine details

Example Output:

{
  "scan_engine": {
    "address": "10.0.0.26",
    "contentVersion": "1327036290 (2018-10-24)",
    "id": 4,
    "lastRefreshedDate": "2018-10-29T14:05:15.268Z",
    "lastUpdatedDate": "2018-10-24T15:10:10.291Z",
    "links": [
      {
        "href": "https://insightvm:3780/api/3/scan_engines/4",
        "rel": "self"
      },
      {
        "href": "https://insightvm:3780/api/3/scan_engines/4/sites",
        "rel": "Sites"
      },
      {
        "id": 4,
        "href": "https://insightvm:3780/api/3/scan_engines/4/scan_engine_pools",
        "rel": "Associated Engine Pools"
      },
      {
        "href": "https://insightvm:3780/api/3/scan_engines/4/scans",
        "rel": "Scans"
      }
    ],
    "name": "master-vm-engine-1",
    "port": 40814,
    "productVersion": "2445745114 (2018-10-21)",
    "sites": [
      1,
      2
    ],
    "enginePools": [
      5
    ]
  }
}

Create Scan Engine

This action is used to create a new scan engine with console -> engine connectivity.

Input
Name Type Default Required Description Enum Example
address string None True Scan engine address (IP/hostname) None None
name string None True Scan engine name None None
port integer 40814 True Scan engine connectivity port None None
sites []integer [] False List of site IDs with which to associate the engine None None

Example input:

Output
Name Type Required Description
id integer True Scan engine ID
links []link True Hypermedia links to corresponding or related resources

Example Output:

{
  "links": [
    {
      "href": "https://insightvm:3780/api/3/scan_engines",
      "rel": "self"
    },
    {
      "id": 12,
      "href": "https://insightvm:3780/api/3/scan_engines/12",
      "rel": "Scan Engine"
    }
  ],
  "id": 12
}

Delete Scan Engine

This action is used to delete an existing scan engine from the security console.

Input
Name Type Default Required Description Enum Example
id integer None True Scan engine identifier None None

Example input:

Output
Name Type Required Description
links []link True Hypermedia links to corresponding or related resources

Example Output:

{
  "links": [
    {
      "href": "https://insightvm:3780/api/3/scan_engines/12",
      "rel": "self"
    }
  ]
}

Get Scan Engine Pools

This action is used to retrieve a list of configured scan engine pools.

Input
Name Type Default Required Description Enum Example
name string None False Scan engine pool name by which to filter, accepts regular expression patterns None None

Example input:

Output
Name Type Required Description
scan_engine_pools []scan_engine_pool True List of scan engine pool details

Example Output:

{
  "scan_engine_pools": [
    {
      "engines": [
        5,
        4
      ],
      "id": 6,
      "links": [
        {
          "href": "https://insightvm:3780/api/3/scan_engines/6",
          "rel": "self"
        },
        {
          "href": "https://insightvm:3780/api/3/scan_engines/6/sites",
          "rel": "Sites"
        },
        {
          "id": 6,
          "href": "https://insightvm:3780/api/3/scan_engine_pools/6/engines",
          "rel": "Engine Pool Engines"
        }
      ],
      "name": "test"
    },
    {
      "id": 2,
      "links": [
        {
          "href": "https://insightvm:3780/api/3/scan_engines/2",
          "rel": "self"
        },
        {
          "href": "https://insightvm:3780/api/3/scan_engines/2/sites",
          "rel": "Sites"
        },
        {
          "id": 2,
          "href": "https://insightvm:3780/api/3/scan_engine_pools/2/engines",
          "rel": "Engine Pool Engines"
        }
      ],
      "name": "Default Engine Pool",
      "engines": []
    }
  ]
}

Get Scan Engine Pool

This action is used to retrieve scan engine pool details by ID.

Input
Name Type Default Required Description Enum Example
id integer None True Scan engine pool identifier None None

Example input:

Output
Name Type Required Description
scan_engine_pool scan_engine_pool True Scan engine pool details

Example Output:

{
  "scan_engine_pool": {
    "engines": [
      5,
      4
    ],
    "id": 6,
    "links": [
      {
        "href": "https://insightvm:3780/api/3/scan_engines/6",
        "rel": "self"
      },
      {
        "href": "https://insightvm:3780/api/3/scan_engines/6/sites",
        "rel": "Sites"
      },
      {
        "id": 6,
        "href": "https://insightvm:3780/api/3/scan_engine_pools/6/engines",
        "rel": "Engine Pool Engines"
      }
    ],
    "name": "test"
  }
}

Create Scan Engine Pool

This action is used to create a new scan engine pool. NOTE: If you are using output from a prior step to configure the engines assigned to the pool and that output is NOT an array, you will need to use a separate plugin (e.g Python script) to convert the data to an array.

Input
Name Type Default Required Description Enum Example
engines []integer None False List of scan engine IDs to associate with the scan engine pool None None
name string None True Scan engine pool name None None

Example input:

Output
Name Type Required Description
id integer True Scan engine pool ID
links []link True Hypermedia links to corresponding or related resources

Example Output:

{
  "links": [
    {
      "href": "https://insightvm:3780/api/3/scan_engine_pools",
      "rel": "self"
    },
    {
      "id": 13,
      "href": "https://insightvm:3780/api/3/scan_engine_pools/13",
      "rel": "Scan Engine Pool"
    }
  ],
  "id": 13
}

Add Scan Engine Pool Engine

This action is used to add a scan engine to a scan engine pool (AWS pre-authorized engine AMI engines cannot be pooled).

Input
Name Type Default Required Description Enum Example
engine_id integer None True Scan engine ID None None
pool_id integer None True Scan engine pool ID None None

Example input:

Output
Name Type Required Description
links []link True Hypermedia links to corresponding or related resources

Example Output:

{
  "links": [
    {
      "href": "https://insightvm:3780/api/3/scan_engine_pools/6/engines/5",
      "rel": "self"
    }
  ]
}

Remove Scan Engine Pool Engine

This action is used to remove a scan engine from a scan engine pool.

Input
Name Type Default Required Description Enum Example
engine_id integer None True Scan engine ID None None
pool_id integer None True Scan engine pool ID None None

Example input:

Output
Name Type Required Description
links []link True Hypermedia links to corresponding or related resources

Example Output:

{
  "links": [
    {
      "href": "https://insightvm:3780/api/3/scan_engine_pools/6/engines/5",
      "rel": "self"
    }
  ]
}

Delete Scan Engine Pool

This action is used to delete an existing scan engine pool from the security console.

Input
Name Type Default Required Description Enum Example
id integer None True Scan engine pool identifier None None

Example input:

Output
Name Type Required Description
links []link True Hypermedia links to corresponding or related resources

Example Output:

{
  "links": [
    {
      "href": "https://insightvm:3780/api/3/scan_engine_pools/13",
      "rel": "self"
    }
  ]
}

Update Site Scan Engine

This action is used to update the scan engine/scan engine pool associated with a site.

Input
Name Type Default Required Description Enum Example
engine_id integer None True Identifier of the scan engine/scan engine pool to associate with the site None None
site_id integer None True Identifier of the site to update None None

Example input:

Output
Name Type Required Description
links []link True Hypermedia links to corresponding or related resources

Example Output:

{
  "links": [
    {
      "href": "https://insightvm:3780/api/3/sites/272/scan_engine",
      "rel": "self"
    }
  ]
}

Create Vulnerability Exception Submission

This action is used to create a vulnerability exception submission.

Input
Name Type Default Required Description Enum Example
comment string Exception created with InsightConnect True Comment to include in the vulnerability exception submission None None
expiration date None False The date the vulnerability exception expires None None
key string None False The key to identify a specific instance if the type is Instance None None
port integer None False The port the vulnerability appears on if the type is Instance None None
reason string None True Reason for the exception ['False Positive', 'Compensating Control', 'Acceptable Use', 'Acceptable Risk', 'Other'] None
scope integer None False The ID of the scope the vulnerability exception applies to. May be empty if type is Global None None
type string None True The type of vulnerability exception to create ['Global', 'Site', 'Asset', 'Asset Group', 'Instance'] None
vulnerability string None True The vulnerability this exception applies to None None

Example input:

Output
Name Type Required Description
id integer True The vulnerability exception that was created
links []link True Hypermedia links to corresponding or related resources

Example Output:

{
  "id": 35,
  "links": [
    {
      "href": "https://insightvm:3780/api/3/vulnerability_exceptions",
      "rel": "self"
    },
    {
      "href": "https://insightvm:3780/api/3/vulnerability_exceptions/35",
      "id": 35,
      "rel": "Vulenrability Exception"
    }
  ]
}

Delete Vulnerability Exception

This action is used to delete an existing vulnerability exception.

Input
Name Type Default Required Description Enum Example
exception_id integer None True Vulnerability exception ID to delete None None

Example input:

Output
Name Type Required Description
links []link True Hypermedia links to corresponding or related resources

Example Output:

{
  "links": [
    {
      "href": "https://insightvm:3780/api/3/vulnerability_exceptions/32",
      "rel": "self"
    }
  ]
}

Get Vulnerability Details

This action is used to get the details of a specific vulnerability by ID.

Input
Name Type Default Required Description Enum Example
id string None True The identifier of the vulnerability to retrieve from InsightVM None None

Example input:

Output
Name Type Required Description
vulnerability vulnerability True The details of the vulnerability requested

Example Output:

{
  "vulnerability": {
    "added": "2012-02-06",
    "categories": [
      "Apple",
      "Apple iTunes",
      "Obsolete Software"
    ],
    "cvss": {
      "links": [
        {
          "href": "https://nvd.nist.gov/vuln-metrics/cvss/v2-calculator?vector=(AV:N/AC:L/Au:N/C:C/I:C/A:C)",
          "rel": "CVSS v2 Calculator"
        }
      ],
      "v2": {
        "accessComplexity": "L",
        "accessVector": "N",
        "authentication": "N",
        "availabilityImpact": "C",
        "confidentialityImpact": "C",
        "exploitScore": 9.9968,
        "impactScore": 10.0008,
        "integrityImpact": "C",
        "score": 10,
        "vector": "AV:N/AC:L/Au:N/C:C/I:C/A:C"
      }
    },
    "denialOfService": false,
    "description": {
      "html": "\u003cp\u003e\n        Apple only maintains one major version of iTunes.  Versions prior to\n        this are not supported. Unsupported versions of iTunes may contain\n        unpatched security flaws. It is recommended to upgrade to the latest\n        version.\n     \u003c/p\u003e",
      "text": "Apple only maintains one major version of iTunes. Versions prior to this are not supported. Unsupported versions of iTunes may contain unpatched security flaws. It is recommended to upgrade to the latest version."
    },
    "exploits": 0,
    "id": "apple-itunes-obsolete",
    "links": [
      {
        "href": "https://insightvm:3780/api/3/vulnerabilities/apple-itunes-obsolete",
        "rel": "self"
      },
      {
        "href": "https://insightvm:3780/api/3/vulnerabilities/apple-itunes-obsolete/checks",
        "rel": "Vulnerability Checks"
      },
      {
        "href": "https://insightvm:3780/api/3/vulnerabilities/apple-itunes-obsolete/references",
        "rel": "Vulnerability References"
      },
      {
        "href": "https://insightvm:3780/api/3/vulnerabilities/apple-itunes-obsolete/malware_kits",
        "rel": "Vulnerability Malware Kits"
      },
      {
        "href": "https://insightvm:3780/api/3/vulnerabilities/apple-itunes-obsolete/exploits",
        "rel": "Vulnerability Exploits"
      },
      {
        "href": "https://insightvm:3780/api/3/vulnerabilities/apple-itunes-obsolete/solutions",
        "rel": "Vulnerability Solutions"
      }
    ],
    "malwareKits": 0,
    "modified": "2013-05-03",
    "pci": {
      "adjustedCVSSScore": 10,
      "adjustedSeverityScore": 5,
      "fail": true,
      "status": "Fail"
    },
    "published": "2001-01-09",
    "riskScore": 911.25,
    "severity": "Critical",
    "severityScore": 10,
    "title": "Obsolete version of Apple iTunes"
  }
}

Review Vulnerability Exception

This action is used to approve or reject a vulnerability exception.

Input
Name Type Default Required Description Enum Example
comment string None False Comment to include in the review None None
exception integer None True The vulnerability exception ID to approve or reject None None
review string None True Approval or rejection of the exception ['Approved', 'Rejected'] None

Example input:

Output
Name Type Required Description
links []link True Hypermedia links to corresponding or related resources

Example Output:

{
  "links": [
    {
      "href": "https://insightvm:3780/api/3/vulnerability_exceptions/35/approve",
      "rel": "self"
    }
  ]
}

Get Authentication Sources

This action is used to list authentication sources available for InsightVM users.

Input
Name Type Default Required Description Enum Example
name string None False Authentication source name by which to filter, accepts regular expression patterns None None
type string False Authentication source type by which to filter ['', 'admin', 'kerberos', 'ldap', 'normal', 'saml'] None

Example input:

Output
Name Type Required Description
authentication_sources []authentication_source True List of authentication sources

Example Output:

{
  "authentication_sources": [
    {
      "external": true,
      "id": 5,
      "links": [
        {
          "href": "https://insightvm:3780/api/3/authentication_sources/5",
          "rel": "self"
        },
        {
          "href": "https://insightvm:3780/api/3/authentication_sources/5/users",
          "rel": "Authentication Source Users"
        }
      ],
      "name": "OpenLDAP",
      "type": "ldap"
    }
  ]
}

Get Authentication Source

This action is used to get the details for an authentication source.

Input
Name Type Default Required Description Enum Example
id integer None True Authentication source ID None None

Example input:

Output
Name Type Required Description
authentication_source authentication_source True User authentication source

Example Output:

{
  "authentication_source": {
    "external": false,
    "id": 1,
    "links": [
      {
        "href": "https://insightvm:3780/api/3/authentication_sources/1",
        "rel": "self"
      },
      {
        "href": "https://insightvm:3780/api/3/authentication_sources/1/users",
        "rel": "Authentication Source Users"
      }
    ],
    "name": "Builtin Administrators",
    "type": "admin"
  }
}

Get Roles

This action is used to list role details.

Input
Name Type Default Required Description Enum Example
name string None False Role name by which to filter, accepts regular expression patterns None None

Example input:

Output
Name Type Required Description
roles []role True List of roles

Example Output:

{
  "roles": [
    {
      "description": "Custom defined role.",
      "id": "custom",
      "links": [
        {
          "href": "https://insightvm:3780/api/3/roles/custom",
          "rel": "self"
        },
        {
          "href": "https://insightvm:3780/api/3/roles/custom/users",
          "rel": "Users"
        }
      ],
      "name": "Custom",
      "privileges": []
    },
    {
      "description": "site-admin-custom",
      "id": "Site Admin Custom",
      "links": [
        {
          "href": "https://insightvm:3780/api/3/roles/Site%20Admin%20Custom",
          "rel": "self"
        },
        {
          "href": "https://insightvm:3780/api/3/roles/Site%20Admin%20Custom/users",
          "rel": "Users"
        }
      ],
      "name": "Site Admin Custom",
      "privileges": [
        "approve-vulnerability-exceptions",
        "assign-scan-engine",
        "assign-scan-template",
        "assign-ticket-assignee",
        "close-tickets",
        "configure-global-settings",
        "create-reports",
        "create-tickets",
        "delete-vulnerability-exceptions",
        "manage-asset-group-access",
        "manage-asset-group-assets",
        "manage-dynamic-asset-groups",
        "manage-policies",
        "manage-report-access",
        "manage-report-templates",
        "manage-scan-alerts",
        "manage-scan-engines",
        "manage-scan-templates",
        "manage-site-access",
        "manage-site-credentials",
        "manage-sites",
        "manage-static-asset-groups",
        "manage-tags",
        "purge-site-asset-data",
        "schedule-automatic-scans",
        "specify-scan-targets",
        "specify-site-metadata",
        "start-unscheduled-scans",
        "submit-vulnerability-exceptions",
        "use-restricted-report-sections",
        "view-asset-group-asset-data",
        "view-site-asset-data"
      ]
    }
  ]
}

Get Role

This action is used to get role details by ID.

Input
Name Type Default Required Description Enum Example
id string None True Role ID, e.g 'global-admin' None None

Example input:

Output
Name Type Required Description
role role True Role details

Example Output:

{
  "role": {
    "description": "Manage configuration, maintenance, and diagnostic operations for the Security Console. Manage site, scan, and report operations, manage shared scan credentials, create tickets, and view asset data in accessible sites and asset groups. Manage vConnections.",
    "id": "global-admin",
    "links": [
      {
        "href": "https://insightvm:3780/api/3/roles/global-admin",
        "rel": "self"
      },
      {
        "href": "https://insightvm:3780/api/3/roles/global-admin/users",
        "rel": "Users"
      }
    ],
    "name": "Global Administrator",
    "privileges": [
      "all-permissions",
      "approve-vulnerability-exceptions",
      "assign-scan-engine",
      "assign-scan-template",
      "assign-ticket-assignee",
      "close-tickets",
      "configure-global-settings",
      "create-reports",
      "create-tickets",
      "delete-vulnerability-exceptions",
      "manage-asset-group-access",
      "manage-asset-group-assets",
      "manage-dynamic-asset-groups",
      "manage-policies",
      "manage-report-access",
      "manage-report-templates",
      "manage-scan-alerts",
      "manage-scan-engines",
      "manage-scan-templates",
      "manage-site-access",
      "manage-site-credentials",
      "manage-sites",
      "manage-static-asset-groups",
      "manage-tags",
      "purge-site-asset-data",
      "schedule-automatic-scans",
      "specify-scan-targets",
      "specify-site-metadata",
      "start-unscheduled-scans",
      "submit-vulnerability-exceptions",
      "use-restricted-report-sections",
      "view-asset-group-asset-data",
      "view-site-asset-data"
    ]
  }
}

Get Users

This action is used to list user accounts.

Input
Name Type Default Required Description Enum Example
login string None False User account login name by which to filter, accepts regular expression patterns None None
name string None False User account name by which to filter, accepts regular expression patterns None None

Example input:

Output
Name Type Required Description
users []user_account True List of user account details

Example Output:

{
  "users": [
    {
      "authentication": {
        "external": false,
        "id": 1,
        "links": [
          {
            "href": "https://insightvm:3780/api/3/authentication_sources/1",
            "rel": "self"
          },
          {
            "href": "https://insightvm:3780/api/3/authentication_sources/1/users",
            "rel": "Authentication Source Users"
          }
        ],
        "name": "Builtin Administrators",
        "type": "admin"
      },
      "email": "user@example.com",
      "enabled": true,
      "id": 1,
      "links": [
        {
          "href": "https://insightvm:3780/api/3/users/1",
          "rel": "self"
        },
        {
          "href": "https://insightvm:3780/api/3/authentication_sources/1",
          "rel": "Authentication Source"
        },
        {
          "href": "https://insightvm:3780/api/3/users/1/asset_groups",
          "rel": "Asset Groups"
        },
        {
          "href": "https://insightvm:3780/api/3/users/1/sites",
          "rel": "Sites"
        },
        {
          "href": "https://insightvm:3780/api/3/users/1/privileges",
          "rel": "Privileges"
        },
        {
          "href": "https://insightvm:3780/api/3/roles/global-admin",
          "rel": "Role"
        }
      ],
      "locale": {
        "default": "en-US",
        "reports": "en-US"
      },
      "locked": false,
      "login": "blaah",
      "name": "blaah",
      "role": {
        "allAssetGroups": true,
        "allSites": true,
        "id": "global-admin",
        "name": "Global Administrator",
        "privileges": [
          "all-permissions",
          "approve-vulnerability-exceptions",
          "assign-scan-engine",
          "assign-scan-template",
          "assign-ticket-assignee",
          "close-tickets",
          "configure-global-settings",
          "create-reports",
          "create-tickets",
          "delete-vulnerability-exceptions",
          "manage-asset-group-access",
          "manage-asset-group-assets",
          "manage-dynamic-asset-groups",
          "manage-policies",
          "manage-report-access",
          "manage-report-templates",
          "manage-scan-alerts",
          "manage-scan-engines",
          "manage-scan-templates",
          "manage-site-access",
          "manage-site-credentials",
          "manage-sites",
          "manage-static-asset-groups",
          "manage-tags",
          "purge-site-asset-data",
          "schedule-automatic-scans",
          "specify-scan-targets",
          "specify-site-metadata",
          "start-unscheduled-scans",
          "submit-vulnerability-exceptions",
          "use-restricted-report-sections",
          "view-asset-group-asset-data",
          "view-site-asset-data"
        ],
        "superuser": true
      }
    }
  ]
}

Get User

This action is used to get user account details by ID.

Input
Name Type Default Required Description Enum Example
id integer None True User account ID None None

Example input:

Output
Name Type Required Description
user user_account True User account details

Example Output:

{
  "user": {
    "authentication": {
      "external": false,
      "id": 1,
      "links": [
        {
          "href": "https://insightvm:3780/api/3/authentication_sources/1",
          "rel": "self"
        },
        {
          "href": "https://insightvm:3780/api/3/authentication_sources/1/users",
          "rel": "Authentication Source Users"
        }
      ],
      "name": "Builtin Administrators",
      "type": "admin"
    },
    "email": "user@example.com",
    "enabled": true,
    "id": 1,
    "links": [
      {
        "href": "https://insightvm:3780/api/3/users/1",
        "rel": "self"
      },
      {
        "href": "https://insightvm:3780/api/3/authentication_sources/1",
        "rel": "Authentication Source"
      },
      {
        "href": "https://insightvm:3780/api/3/users/1/asset_groups",
        "rel": "Asset Groups"
      },
      {
        "href": "https://insightvm:3780/api/3/users/1/sites",
        "rel": "Sites"
      },
      {
        "href": "https://insightvm:3780/api/3/users/1/privileges",
        "rel": "Privileges"
      },
      {
        "href": "https://insightvm:3780/api/3/roles/global-admin",
        "rel": "Role"
      }
    ],
    "locale": {
      "default": "en-US",
      "reports": "en-US"
    },
    "locked": false,
    "login": "blaah",
    "name": "blaah",
    "role": {
      "allAssetGroups": true,
      "allSites": true,
      "id": "global-admin",
      "name": "Global Administrator",
      "privileges": [
        "all-permissions",
        "approve-vulnerability-exceptions",
        "assign-scan-engine",
        "assign-scan-template",
        "assign-ticket-assignee",
        "close-tickets",
        "configure-global-settings",
        "create-reports",
        "create-tickets",
        "delete-vulnerability-exceptions",
        "manage-asset-group-access",
        "manage-asset-group-assets",
        "manage-dynamic-asset-groups",
        "manage-policies",
        "manage-report-access",
        "manage-report-templates",
        "manage-scan-alerts",
        "manage-scan-engines",
        "manage-scan-templates",
        "manage-site-access",
        "manage-site-credentials",
        "manage-sites",
        "manage-static-asset-groups",
        "manage-tags",
        "purge-site-asset-data",
        "schedule-automatic-scans",
        "specify-scan-targets",
        "specify-site-metadata",
        "start-unscheduled-scans",
        "submit-vulnerability-exceptions",
        "use-restricted-report-sections",
        "view-asset-group-asset-data",
        "view-site-asset-data"
      ],
      "superuser": true
    }
  }
}

Create User

This action is used to create a new user account (limited to external authentication sources).

Input
Name Type Default Required Description Enum Example
access_all_asset_groups boolean False True Whether to grant the user access to all asset groups None None
access_all_sites boolean False True Whether to grant the user access to all sites None None
authentication_id integer None False The identifier of the authentication source to use to authenticate the user. The source with the specified identifier must be of the type specified by Authentication Type. If Authentication ID is omitted, then one source of the specified Authentication Type is selected None None
authentication_type string ldap True The type of the authentication source to use to authenticate the user ['kerberos', 'ldap', 'saml'] None
email string None True The email address of the user None None
enabled boolean True True Whether the user account is enabled None None
login string None True The login name of the user None None
name string None True The full name of the user None None
role_id string None True The identifier of the role to which the user should be assigned, e.g 'global-admin' None None

Example input:

Output
Name Type Required Description
id integer True The identifier of the created user account
links []link True Hypermedia links to corresponding or related resources

Example Output:

{
  "links": [
    {
      "href": "https://insightvm:3780/api/3/users",
      "rel": "self"
    },
    {
      "href": "https://insightvm:3780/api/3/users/83",
      "rel": "self"
    }
  ],
  "id": 83
}

Update User

This action is used to update the configuration of an existing user account.

Input
Name Type Default Required Description Enum Example
access_all_asset_groups boolean False True Whether to grant the user access to all asset groups None None
access_all_sites boolean False True Whether to grant the user access to all sites None None
authentication_id integer None False The identifier of the authentication source to use to authenticate the user. The source with the specified identifier must be of the type specified by Authentication Type. If Authentication ID is omitted, then one source of the specified Authentication Type is selected None None
authentication_type string ldap True The type of the authentication source to use to authenticate the user ['normal', 'admin', 'kerberos', 'ldap', 'saml'] None
email string None True The email address of the user None None
enabled boolean True True Whether the user account is enabled None None
id integer None True The identifier of the user None None
login string None True The login name of the user None None
name string None True The full name of the user None None
role_id string None True The identifier of the role to which the user should be assigned, e.g 'global-admin' None None

Example input:

Output
Name Type Required Description
links []link True Hypermedia links to corresponding or related resources

Example Output:

{
  "links": [
    {
      "href": "https://insightvm:3780/api/3/users/83",
      "rel": "self"
    }
  ]
}

Delete User

This action is used to delete an user account.

Input
Name Type Default Required Description Enum Example
id integer None True The identifier of the user account None None

Example input:

Output
Name Type Required Description
links []link True Hypermedia links to corresponding or related resources

Example Output:

{
  "links": [
    {
      "href": "https://insightvm:3780/api/3/users/83",
      "rel": "self"
    }
  ]
}

Disable User

This action is used to disable an user account.

Input
Name Type Default Required Description Enum Example
id integer None True The identifier of the user account None None

Example input:

Output
Name Type Required Description
links []link True Hypermedia links to corresponding or related resources

Example Output:

{
  "links": [
    {
      "href": "https://insightvm:3780/api/3/users/83",
      "rel": "self"
    }
  ]
}

Enable User

This action is used to enable an user account.

Input
Name Type Default Required Description Enum Example
id integer None True The identifier of the user account None None

Example input:

Output
Name Type Required Description
links []link True Hypermedia links to corresponding or related resources

Example Output:

{
  "links": [
    {
      "href": "https://insightvm:3780/api/3/users/83",
      "rel": "self"
    }
  ]
}

Update User Role

This action is used to update the role associated with an user account.

Input
Name Type Default Required Description Enum Example
access_all_asset_groups boolean False True Whether to grant the user access to all asset groups None None
access_all_sites boolean False True Whether to grant the user access to all sites None None
role_id string None True The identifier of the role to which the user should be assigned, e.g 'global-admin' None None
user_id integer None True The identifier of the user account None None

Example input:

Output
Name Type Required Description
links []link True Hypermedia links to corresponding or related resources

Example Output:

{
  "links": [
    {
      "href": "https://insightvm:3780/api/3/users/83",
      "rel": "self"
    }
  ]
}

Update User Asset Group Access

This action is used to update the asset groups to which a user has access in bulk. It can be used to remove asset group access as well.

Input
Name Type Default Required Description Enum Example
asset_group_ids []integer None True The identifiers of the asset groups to which the user account should be granted access, ignored if the user has access to all asset groups None None
user_id integer None True The identifier of the user account None None

Example input:

Output
Name Type Required Description
links []link True Hypermedia links to corresponding or related resources

Example Output:

{
  "links": [
    {
      "href": "https://insightvm:3780/api/3/users/83/sites",
      "rel": "User Asset Groups"
    }
  ]
}

Add User Asset Group Access

This action is used to grant an user account access to an asset group by id.

Input
Name Type Default Required Description Enum Example
asset_group_id integer None True The identifier of the asset group None None
user_id integer None True The identifier of the user account None None

Example input:

Output
Name Type Required Description
links []link True Hypermedia links to corresponding or related resources

Example Output:

{
  "links": [
    {
      "href": "https://insightvm:3780/api/3/users/83/sites",
      "rel": "User Asset Groups"
    }
  ]
}

Remove User Asset Group Access

This action is used to remove asset group access from an user account.

Input
Name Type Default Required Description Enum Example
asset_group_id integer None True The identifier of the asset group None None
user_id integer None True The identifier of the user account None None

Example input:

Output
Name Type Required Description
links []link True Hypermedia links to corresponding or related resources

Example Output:

{
  "links": [
    {
      "href": "https://insightvm:3780/api/3/users/83/sites",
      "rel": "User Asset Groups"
    }
  ]
}

Update User Site Access

This action is used to update the sites to which a user has access in bulk. It can be used to remove sites as well.

Input
Name Type Default Required Description Enum Example
site_ids []integer None True The identifiers of the sites to which the user account should be granted access, ignored if the user has access to all sites None None
user_id integer None True The identifier of the user account None None

Example input:

Output
Name Type Required Description
links []link True Hypermedia links to corresponding or related resources

Example Output:

{
  "links": [
    {
      "href": "https://insightvm:3780/api/3/users/83/sites",
      "rel": "User Sites"
    }
  ]
}

Add User Site Access

This action is used to grant an user account access to a site by id.

Input
Name Type Default Required Description Enum Example
site_id integer None True The identifier of the site None None
user_id integer None True The identifier of the user account None None

Example input:

Output
Name Type Required Description
links []link True Hypermedia links to corresponding or related resources

Example Output:

{
  "links": [
    {
      "href": "https://insightvm:3780/api/3/users/83/sites",
      "rel": "User Sites"
    }
  ]
}

Remove User Site Access

This action is used to remove site access from an user account.

Input
Name Type Default Required Description Enum Example
site_id integer None True The identifier of the site None None
user_id integer None True The identifier of the user account None None

Example input:

Output
Name Type Required Description
links []link True Hypermedia links to corresponding or related resources

Example Output:

{
  "links": [
    {
      "href": "https://insightvm:3780/api/3/users/83/sites",
      "rel": "User Sites"
    }
  ]
}

Top Remediations

This action is used to generate results for the top remediations based on a defined scope.

Input
Name Type Default Required Description Enum Example
asset_limit integer None False The amount of assets to be returned with each top remediation; this can be used to reduce message size and processing time None None
limit integer 25 True Number of remediations for which tickets should be generated [10, 25, 50, 100] None
scope string none True Scope context for generated report; if set remediations will be scoped by each in scope ID, e.g Site ID, Tag ID, Asset Group ID ['none', 'assets', 'assetGroups', 'sites', 'tags', 'scan'] None
scope_ids []integer [] False Scope IDs for which tickets should be generated, by default all are included None None
vulnerability_limit integer None False The amount of vulnerabilities to be returned with each top remediation; this can be used to reduce message size and processing time None None

Example input:

Output
Name Type Required Description
remediations []remediation True List of top remediations

Example Output:

{
  "remediations": [
    {
      "solutionId": 50460,
      "nexposeId": "mozilla-firefox-upgrade-latest",
      "summary": "Upgrade to the latest version of Mozilla Firefox",
      "fix": "Install the latest version of Mozilla Firefox from the Mozilla Products (http://www.mozilla.org/products/firefox/) page.",
      "assetCount": 1,
      "vulnerabilityCount": 689,
      "riskScore": 595588,
      "assets": [
        {
          "id": 44,
          "hostName": "hostname",
          "ip": "10.0.0.1",
          "mac": "00:00:00:00:00:00",
          "os": "Windows Server 2012 R2 Standard Edition",
          "riskScore": 2116158,
          "criticalityTag": "Very High"
        }
      ],
      "vulnerabilities": [
        {
          "id": 73213,
          "title": "Obsolete Version of Mozilla Firefox",
          "description": "\n    \n<p>\n      Versions of Mozilla Firefox prior to 57.0.x are no longer supported. Unsupported\n      versions of Firefox may contain unpatched security flaws. It is recommended to \n      upgrade to the latest version.\n    </p>\n  ",
          "cvssScore": "10",
          "severity": 10,
          "riskScore": 871
        }
      ]
    }
  ]
}

Triggers

New Vulnerability Exception

This trigger is used to check for new InsightVM vulnerability exceptions.

Input
Name Type Default Required Description Enum Example
frequency integer 5 True How often the trigger should check for new vulnerability exception requests None None
status_filter []string ["Under Review"] False List of vulnerability statuses to match against. Options include: Under Review and Approved None None

Example input:

Output
Name Type Required Description
exception vulnerability_exception False InsightVM vulnerability exception

Example Output:

{
  "expires": "2019-10-31T00:00:00Z",
  "id": 31,
  "links": [
    {
      "href": "https://insightvm:3780/api/3/vulnerability_exceptions/31",
      "rel": "self"
    }
  ],
  "scope": {
    "id": 80,
    "links": [
      {
        "id": "apple-itunes-obsolete",
        "href": "https://insightvm:3780/api/3/vulnerabilities/apple-itunes-obsolete",
        "rel": "Vulnerability"
      },
      {
        "id": 80,
        "href": "https://insightvm:3780/api/3/assets/80",
        "rel": "Asset"
      }
    ],
    "type": "asset",
    "vulnerability": "apple-itunes-obsolete"
  },
  "state": "under review",
  "submit": {
    "comment": "ICON Test Exception",
    "date": "2019-10-27T14:59:31.449114Z",
    "links": [
      {
        "id": 5,
        "href": "https://insightvm:3780/api/3/users/5",
        "rel": "Submitter"
      }
    ],
    "name": "blaah",
    "reason": "acceptable use",
    "user": 5
  }
}

New Scans

This trigger is used to check for new InsightVM scans by site and scan status.

Input
Name Type Default Required Description Enum Example
frequency integer 5 True How often the trigger should check for new scans in minutes None None
most_recent_scan boolean True True Only process the most recent scan for a site since the last time the trigger was run None None
site_name_filter string .* True Regular expression to match sites where new scans should be triggered None None
status_filter []string ["Successful"] False List of scan statuses to match for trigger; options include: Aborted, Successful, Running, Stopped, Failed, Paused, Unknown None None

Example input:

Output
Name Type Required Description
scan scan False InsightVM Scan

Example Output:

{
  "scan": {
    "assets": 2,
    "duration": "PT1M30.77S",
    "endTime": "2019-06-17T19:23:50.927Z",
    "engineName": "Local scan engine",
    "id": 2163,
    "links": [
      {
        "href": "https://insightvm:3780/api/3/scans/2163",
        "rel": "self"
      }
    ],
    "scanName": "Mon 17 Jun 2019 03:22 PM",
    "scanType": "Manual",
    "startTime": "2019-06-17T19:22:20.157Z",
    "status": "finished",
    "vulnerabilities": {
      "critical": 0,
      "moderate": 0,
      "severe": 0,
      "total": 0
    },
    "siteId": 31,
    "siteName": "Test-Site"
  }
}

Custom Output Types

This plugin does not contain any custom output types.

Troubleshooting

This plugin does not contain any troubleshooting information.

Version History

  • 4.0.1 - Add the option to limit a scan to specific hosts
  • 4.0.0 - Fix output for Generate Adhoc SQL Report action
  • 3.6.0 - Add Get Asset Group Assets action
  • 3.5.2 - Fix bug in New Vulnerability Exception Activity
  • 3.5.1 - New spec and help.md format for the Extension Library
  • 3.5.0 - New Actions Get Vulnerability Details, Create Vulnerability Exception Submission, Delete Vulnerability Exception, Review Vulnerability Exception | New Trigger New Vulnerability Exception Activity | Misc. Cleanup
  • 3.4.0 - New Action Get Asset Software | Fix issue with New Scan trigger not properly caching new scan IDs
  • 3.3.1 - Fix issue in Top Remediations action that causes assets without criticality tags to not be returned in asset list
  • 3.3.0 - New Actions Get Asset, Get Asset Tags, Get Scan Assets, Generate AdHoc SQL Report, Top Remediations | New trigger New Scans
  • 3.2.0 - New Actions Create Site, Update Site, Delete Site, Update Site Included Targets, Update Site Excluded Targets, Update Site Included Asset Groups, and Update Site Excluded Asset Groups
  • 3.1.0 - New Actions Get Authentication Sources, Get Authentication Source, Get Roles, Get Role, Get Users, Get User, Create User, Update User, Update User Asset Group Access, Add User Asset Group Access, Remove User Asset Group Access, Update User Site Access, Add User Site Access, Remove User Site Access, Disable User, Enable User, Delete User, Update User Role
  • 3.0.1 - Update descriptions
  • 3.0.0 - Rename Action Get Vulnerabilities to Get Asset Vulnerabilities | Correct output of Scan action | New Actions Get Vulnerabilities by CVE, Get Scans, Update Scan Status, Generate Shared Secret, Get Scan Engines, Get Scan Engine, Create Scan Engine, Delete Scan Engine, Get Scan Engine Pools, Get Scan Engine Pool, Create Scan Engine Pool, Add Scan Engine Pool Engine, Remove Scan Engine Pool Engine, Delete Scan Engine Pool, Update Site Scan Engine
  • 2.3.0 - New Actions Create Tag, Delete Tag, Get Tag, Get Tag Sites, Get Tag Assets, Get Tag Asset Groups, Get Tags, Remove Asset Tag, Remove Asset Group Tags, Remove Tag Asset Groups, Remove Tag Sites, Remove Tag Search Criteria, Tag Site, Tag Asset, Tag Asset Group, Update Tag Search Criteria, Asset Search, Get Sites, Get Site, Get Asset Groups, Get Asset Group, Create Asset Group, Delete Asset Group, and Update Asset Group Search Criteria
  • 2.2.1 - Correct output of the Get Scan action
  • 2.2.0 - New Action Get Vulnerability Affected Assets
  • 2.1.0 - Add Download Report and List Reports action
  • 2.0.0 - Support web server mode
  • 1.0.0 - Initial plugin release

Links

References

plugin_spec_version: v2
extension: plugin
products: [insightconnect]
name: rapid7_insightvm
title: Rapid7 InsightVM
description: InsightVM is a powerful vulnerability management tool which finds, prioritizes, and remediates vulnerabilities. This plugin can get top remediations, scan results and start scans
version: 4.0.1
vendor: rapid7
support: rapid7
status: []
resources:
  source_url: https://github.com/rapid7/insightconnect-plugins/tree/master/rapid7_insightvm
  license_url: https://github.com/rapid7/insightconnect-plugins/blob/master/LICENSE
  vendor_url: https://www.rapid7.com
tags:
- insightvm
- rapid7
hub_tags:
  use_cases: [asset_inventory, remediation_management, vulnerability_management, reporting_and_analytics]
  keywords: [insightvm, rapid7]
  features: []
types:
  report_id:
    id:
      description: Identifer
      title: Report ID
      type: integer
      required: false
    name:
      title: Report Name
      description: Name of report
      type: string
      required: false
  link:
    href:
      description: A hypertext reference, which is either a URI (see RFC 3986) or
        URI template (see RFC 6570)
      title: URL
      type: string
      required: false
    rel:
      description: Link relation type following RFC 5988
      title: Rel
      type: string
      required: false
  address:
    ip:
      description: IPv4 or IPv6 address
      title: IP
      type: string
      required: false
    mac:
      description: Media Access Control (MAC) address, e.g. AF:12:BC:5A:F7:48
      title: MAC
      type: string
      required: false
  configuration:
    name:
      description: Name of the configuration value
      title: Name
      type: string
      required: false
    value:
      description: Configuration value
      title: Value
      type: string
      required: false
  database:
    description:
      description: Description of the database instance
      title: Description
      type: string
      required: false
    id:
      description: Identifier of the database
      title: ID
      type: integer
      required: false
    name:
      description: Name of the database instance
      title: Name
      type: string
      required: false
  file:
    attributes:
      description: Attributes detected on the file
      title: Attributes
      type: '[]configuration'
      required: false
    name:
      description: Name of the file
      title: Name
      type: string
      required: false
    size:
      description: Size of the regular file (in bytes). If the file is a directory,
        no value is returned
      title: Size
      type: integer
      required: false
    type:
      description: Type of the file, e.g. file or directory
      title: Type
      type: string
      required: false
    content:
      description: Contents of the file
      title: Contents
      type: bytes
      required: false
  history:
    date:
      description: Date the asset information was collected or changed
      title: Date
      type: string
      required: false
    description:
      description: Additional information describing the change
      title: Description
      type: string
      required: false
    scanId:
      description: If a scan-oriented change, the identifier of the corresponding
        scan the asset was scanned in
      title: Scan ID
      type: integer
      required: false
    type:
      description: Type, for additional information see the help section of this plugin
      title: Type
      type: string
      required: false
    user:
      description: User
      title: User
      type: string
      required: false
    version:
      description: Version
      title: Version
      type: integer
      required: false
    vulnerabilityExceptionId:
      description: Vulnerability exception ID
      title: Vulnerability Exception ID
      type: integer
      required: false
  hostName:
    name:
      description: Name
      title: Name
      type: string
      required: false
    source:
      description: Source
      title: Source
      type: string
      required: false
  id:
    id:
      description: ID
      title: ID
      type: string
      required: false
    source:
      description: Source
      title: Source
      type: string
      required: false
  cpe:
    edition:
      description: Edition-related terms applied by the vendor to the product
      title: Edition
      type: string
      required: false
    language:
      description: Defines the language supported in the user interface of the product
        being described. The format of the language tag adheres to RFC 5646
      title: Language
      type: string
      required: false
    other:
      description: Captures any other general descriptive or identifying information
        which is vendor- or product-specific and which does not logically fit in any
        other attribute value
      title: Other
      type: string
      required: false
    part:
      description: A single letter code that designates the particular platform part
        that is being identified
      title: Part
      type: string
      required: false
    product:
      description: Most common and recognizable title or name of the product
      title: Product
      type: string
      required: false
    swEdition:
      description: Characterizes how the product is tailored to a particular market
        or class of end users
      title: Software Edition
      type: string
      required: false
    targetHW:
      description: Characterize the instruction set architecture on which the product
        operates
      title: Target Hardware
      type: string
      required: false
    targetSW:
      description: Characterizes the software computing environment within which the
        product operates
      title: Target Software
      type: string
      required: false
    update:
      description: Vendor-specific alphanumeric strings characterizing the particular
        update, service pack, or point release of the product
      title: Update
      type: string
      required: false
    v2.2:
      description: The full CPE string in the CPE 2.2 format
      title: Version 2.2
      type: string
      required: false
    v2.3:
      description: The full CPE string in the CPE 2.3 format
      title: Version 2.3
      type: string
      required: false
    vendor:
      description: The person or organization that manufactured or created the product
      title: Vendor
      type: string
      required: false
    version:
      description: Vendor-specific alphanumeric strings characterizing the particular
        release version of the product
      title: Version
      type: string
      required: false
  osFingerprint:
    architecture:
      description: The architecture of the operating system
      title: Architecture
      type: string
      required: false
    configurations:
      description: Configuration key-values pairs enumerated on the operating system
      title: Configuration
      type: '[]configuration'
      required: false
    cpe:
      description: Common Platform Enumeration
      title: CPE
      type: cpe
      required: false
    description:
      description: The description of the operating system (containing vendor, family,
        product, version and architecture in a single string)
      title: Description
      type: string
      required: false
    family:
      description: Family of the operating system
      title: Family
      type: string
      required: false
    id:
      description: Identifier of the operating system
      title: ID
      type: integer
      required: false
    product:
      description: Name of the operating system
      title: Product
      type: string
      required: false
    systemName:
      description: A combination of vendor and family (with redundancies removed),
        suitable for grouping
      title: System Name
      type: string
      required: false
    type:
      description: Type of operating system
      title: Type
      type: string
      required: false
    vendor:
      description: Vendor of the operating system
      title: Vendor
      type: string
      required: false
    version:
      description: Version of the operating system
      title: Version
      type: string
      required: false
  userGroup:
    id:
      description: Identifier of the user group
      title: ID
      type: integer
      required: false
    name:
      description: Name of the user group
      title: Name
      type: string
      required: false
  user:
    fullName:
      description: Full name of the user account
      title: Full Name
      type: string
      required: false
    id:
      description: Identifier of the user account
      title: ID
      type: integer
      required: false
    name:
      description: Name of the user account
      title: Name
      type: string
      required: false
  page:
    linkType:
      description: Type of link used to traverse or detect the page
      title: Link Type
      type: string
      required: false
    path:
      description: Path to the page (URI)
      title: Path
      type: string
      required: false
    response:
      description: HTTP response code observed with retrieving the page
      title: Response
      type: integer
      required: false
  webApplication:
    id:
      description: Identifier of the web application
      title: ID
      type: integer
      required: false
    pages:
      description: Pages
      title: Pages
      type: '[]page'
      required: false
    root:
      description: Web root of the web application
      title: Root
      type: string
      required: false
    virtualHost:
      description: Virtual host of the web application
      title: Virtual Host
      type: string
      required: false
  service:
    configurations:
      description: Configuration key-values pairs enumerated on the service
      title: Configurations
      type: '[]configuration'
      required: false
    databases:
      description: Databases enumerated on the service
      title: Databases
      type: '[]database'
      required: false
    family:
      description: Family of the service
      title: Family
      type: string
      required: false
    links:
      description: Hypermedia links to corresponding or related resources
      title: Links
      type: '[]link'
      required: false
    name:
      description: Name of the service
      title: Name
      type: string
      required: false
    port:
      description: Port of the service
      title: Port
      type: integer
      required: false
    product:
      description: Product running the service
      title: Product
      type: string
      required: false
    protocol:
      description: Protocol of the service
      title: Protocol
      type: string
      required: false
    userGroups:
      description: User groups
      title: User Groups
      type: '[]userGroup'
      required: false
    users:
      description: Users
      title: Users
      type: '[]user'
      required: false
    vendor:
      description: Vendor of the service
      title: Vendor
      type: string
      required: false
    version:
      description: Version of the service
      title: Version
      type: string
      required: false
    webApplications:
      description: Web applications found on the service
      title: Web Applications
      type: '[]webApplication'
      required: false
  software:
    configurations:
      description: Configurations
      title: Configurations
      type: '[]configuration'
      required: false
    cpe:
      description: CPE
      title: CPE
      type: cpe
      required: false
    description:
      description: Description of the software
      title: Description
      type: string
      required: false
    family:
      description: Family of the software
      title: Family
      type: string
      required: false
    id:
      description: ID
      title: ID
      type: integer
      required: false
    product:
      description: Product of the software
      title: Product
      type: string
      required: false
    type:
      description: Type of the software
      title: Type
      type: string
      required: false
    vendor:
      description: Vendor of the software
      title: Vendor
      type: string
      required: false
    version:
      description: Version of the software
      title: Version
      type: string
      required: false
  vulnerabilities:
    critical:
      description: Number of critical vulnerabilities
      title: Critical
      type: integer
      required: false
    exploits:
      description: Number of distinct exploits that can exploit any of the vulnerabilities
        on the asset
      title: Exploits
      type: integer
      required: false
    malwareKits:
      description: Number of distinct malware kits that vulnerabilities on the asset
        are susceptible to
      title: Malware Kits
      type: integer
      required: false
    moderate:
      description: Number of moderate vulnerabilities
      title: Moderate
      type: integer
      required: false
    severe:
      description: Number of severe vulnerabilities
      title: Severe
      type: integer
      required: false
    total:
      description: Total number of vulnerabilities
      title: Total
      type: integer
      required: false
  vulnerabilities_count:
    critical:
      description: Number of critical vulnerabilities
      title: Critical
      type: integer
      required: false
    moderate:
      description: Number of moderate vulnerabilities
      title: Moderate
      type: integer
      required: false
    severe:
      description: Number of severe vulnerabilities
      title: Severe
      type: integer
      required: false
    total:
      description: Total
      title: Total number of vulnerabilities
      type: integer
      required: false
  vulnerability_exception:
    expires:
      title: Expires
      description: The date and time the vulnerability exception is set to expire
      type: date
      required: false
    state:
      title: State
      description: The state of the vulnerability exception
      type: string
      required: true
      enum:
      - deleted
      - expired
      - approved
      - rejected
      - under review
    id:
      title: Vulnerability Exception ID
      description: The ID uniquely identifying the vulnerability exception
      type: integer
      required: true
    scope:
      title: Exception Scope
      description: Details of the scope of the exception
      type: object
      required: true
    submit:
      title: Submission Details
      description: Details of the exception submission
      type: object
      required: true
    review:
      title: Review Details
      description: Details of the exception review
      type: object
      required: false
    links:
      description: Hypermedia links to corresponding or related resources
      title: Links
      type: '[]link'
      required: false
  exception_review:
    comment:
      title: Review Comment
      description: The comment from the reviewer detailing the review
      type: string
      required: false
    date:
      title: Review Date
      description: The date and time the review took place
      type: date
      required: false
    name:
      title: Reviewer Name
      description: The login name of the user that reviewed the vulnerability exception
      type: string
      required: false
    user:
      title: Reviewer ID
      description: The identifier of the user that reviewed the vulnerability exception
      type: integer
      required: false
    links:
      description: Hypermedia links to corresponding or related resources
      title: Links
      type: '[]link'
      required: false
  exception_submit:
    comment:
      title: Submit Comment
      description: The comment from the submit detailing the exception
      type: string
      required: false
    date:
      title: Submit Date
      description: The date and time the exception request took place
      type: date
      required: false
    name:
      title: Submitter Name
      description: The login name of the user that submitted the vulnerability exception
      type: string
      required: false
    user:
      title: Submitter ID
      description: The identifier of the user that submitted the vulnerability exception
      type: integer
      required: false
    links:
      description: Hypermedia links to corresponding or related resources
      title: Links
      type: '[]link'
      required: false
  exception_scope:
    id:
      title: Vulnerability Scope ID
      description: The identifer of the scope (asset, group, site) the vulnerability exception applies to
      type: integer
      required: true
    key:
      title: Exception Scope Key
      description: Optional key to discriminate the instance when the scope type is Instance
      type: string
      required: false
    port:
      title: Port
      description: If the scope type is Instance, the port the exception applies to
      type: integer
      required: false
    type:
      title: Exception Scope Type
      description: The type of vulnerability exception - Global, Site, Asset, Asset Group, Instance
      type: string
      required: true
      enum:
      - Global
      - Site
      - Asset
      - Asset Group
      - Instance
    vulnerability:
      title: Vulnerability
      description: The vulnerability the exception applies to
      type: string
      required: true
    links:
      description: Hypermedia links to corresponding or related resources
      title: Links
      type: '[]link'
      required: false
  asset:
    addresses:
      description: All addresses discovered on the asset
      title: Addresses
      type: '[]address'
      required: false
    assessedForPolicies:
      description: Whether the asset has been assessed for policies at least once
      title: Assessed for Policies
      type: boolean
      required: false
    assessedForVulnerabilities:
      description: Whether the asset has been assessed for vulnerabilities at least
        once
      title: Assessed for Vulnerabilities
      type: boolean
      required: false
    configurations:
      description: Configuration key-values pairs enumerated on the asset
      title: Configurations
      type: '[]configuration'
      required: false
    databases:
      description: Databases enumerated on the asset
      title: Databases
      type: '[]database'
      required: false
    files:
      description: Files discovered with searching on the asset
      title: Files
      type: '[]file'
      required: false
    history:
      description: History of changes to the asset over time
      title: History
      type: '[]history'
      required: false
    hostName:
      description: Primary host name (local or FQDN) of the asset
      title: Hostname
      type: string
      required: false
    hostNames:
      description: All hostnames or aliases discovered on the asset
      title: Hostnames
      type: '[]hostName'
      required: false
    id:
      description: Identifier of the asset
      title: ID
      type: integer
      required: false
    ids:
      description: Unique identifiers found on the asset, such as hardware or operating
        system identifiers
      title: IDs
      type: '[]id'
      required: false
    ip:
      description: Primary IPv4 or IPv6 address of the asset
      title: IP
      type: string
      required: false
    links:
      description: Hypermedia links to corresponding or related resources
      title: Links
      type: '[]link'
      required: false
    mac:
      description: Media Access Control (MAC) address, e.g. AF:12:BC:5A:F7:48
      title: MAC
      type: string
      required: false
    os:
      description: Full description of the operating system of the asset
      title: OS
      type: string
      required: false
    osFingerprint:
      description: Details of the operating system of the asset
      title: OS Fingerprint
      type: osFingerprint
      required: false
    rawRiskScore:
      description: Base risk score of the asset
      title: Raw Risk Score
      type: float
      required: false
    riskScore:
      description: Risk score (with criticality adjustments) of the asset
      title: Risk Score
      type: float
      required: false
    services:
      description: Services discovered on the asset
      title: Services
      type: '[]service'
      required: false
    software:
      description: Software discovered on the asset
      title: Software
      type: '[]software'
      required: false
    type:
      description: Type of asset e.g. unknown, guest, hypervisor, physical, mobile
      title: Type
      type: string
      required: false
    userGroups:
      description: User group accounts enumerated on the asset
      title: User Groups
      type: '[]userGroup'
      required: false
    users:
      description: User accounts enumerated on the asset
      title: Users
      type: '[]user'
      required: false
    vulnerabilities:
      description: ' Summary information for vulnerabilities on the asset'
      title: Vulnerabilities
      type: vulnerabilities
      required: false
  asset_vulnerability_result:
    checkId:
      description: Check ID, ie. ssh-openssh-x11uselocalhost-x11-forwarding-session-hijack
      title: Check ID
      type: string
      required: false
    exceptions:
      description: If the result is vulnerable with exceptions applied, the identifier(s)
        of the exceptions actively applied to the result
      title: Exceptions
      type: '[]integer'
      required: false
    key:
      description: An additional discriminating key used to uniquely identify between
        multiple instances of results on the same finding
      title: Key
      type: string
      required: false
    links:
      description: Hypermedia links to corresponding or related resources
      title: Links
      type: '[]link'
      required: false
    port:
      description: Port of the service the result was discovered on e.g. 22
      title: Port
      type: integer
      required: false
    proof:
      description: Proof of the vulnerability, ie. <p><p>OpenBSD OpenSSH 4.3 on Linux</p></p>
      title: Proof
      type: string
      required: false
    protocol:
      description: Protocol of the service the result was discovered on, ie. TCP
      title: Protocol
      type: string
      required: false
    status:
      description: Status of the vulnerability check result, ie. vulnerable-version
      title: Status
      type: string
      required: false
  asset_vulnerability:
    id:
      description: Vulnerability ID, ie. ssh-openssh-x11uselocalhost-x11-forwarding-session-hijack
      title: ID
      type: string
      required: false
    instances:
      description: Identifier of the report instance
      title: Instances
      type: integer
      required: false
    links:
      description: Hypermedia links to corresponding or related resources
      title: Links
      type: '[]link'
      required: false
    results:
      description: The vulnerability check results for the finding. Multiple instances
        may be present if one or more checks fired, or a check has multiple independent
        results
      title: Results
      type: '[]asset_vulnerability_result'
      required: false
    status:
      description: Status, ie. vulnerable
      title: Status
      type: string
      required: false
  site:
    assets:
      title: Assets
      description: Site asset count
      type: integer
      required: true
    connectionType:
      title: Connection Type
      description: Site discovery connection type (if applicable)
      type: string
      required: false
    description:
      title: Description
      description: Site description
      type: string
      required: false
    id:
      title: ID
      description: Identifier of the site
      type: integer
      required: true
    importance:
      title: Importance
      description: Site importance, used with the 'weighted' risk scoring strategy
      type: string
      required: true
    lastScanTime:
      title: Last Scan Time
      description: Site last scan time
      type: date
      required: false
    links:
      title: Links
      description: Hypermedia links to corresponding or related resources
      type: '[]link'
      required: true
    name:
      title: Name
      description: Site name
      type: string
      required: true
    riskScore:
      title: Risk Score
      description: Site risk score
      type: float
      required: true
    scanEngine:
      title: Scan Engine
      description: Site default scan engine ID
      type: integer
      required: true
    scanTemplate:
      title: Scan Template
      description: Site default scan template
      type: string
      required: true
    type:
      title: Type
      description: Site type
      type: string
      required: true
    vulnerabilities:
      title: Vulnerabilities
      description: Site vulnerability counts
      type: vulnerabilities_count
      required: true
  asset_group:
    assets:
      title: Assets
      description: Site asset count
      type: integer
      required: true
    description:
      title: Description
      description: Asset group description
      type: string
      required: false
    id:
      title: ID
      description: Site ID
      type: integer
      required: true
    links:
      title: Links
      description: Hypermedia links to corresponding or related resources
      type: '[]link'
      required: true
    name:
      title: Name
      description: Asset group name
      type: string
      required: true
    riskScore:
      title: Risk Score
      description: Site risk score
      type: float
      required: true
    searchCriteria:
      title: Search Criteria
      description: Asset group search criteria
      type: object
      required: false
    type:
      title: Type
      description: Asset group type
      type: string
      required: true
    vulnerabilities:
      title: Vulnerabilities
      description: Asset group vulnerability counts
      type: vulnerabilities_count
      required: true
  vulnerability_description:
    html:
      title: HTML
      description: Vulnerability description HTML
      type: string
    text:
      title: Text
      description: Vulnerability description raw text
      type: string
  pci:
    adjustedCVSSScore:
      title: Adjusted CVSS score
      description: PCI adjusted CVSS score
      type: integer
    adjustedSeverityScore:
      title: Adjusted severity score
      description: PCI adjusted severity score
      type: integer
    fail:
      title: Fail
      description: Whether this vulnerability results in a PCI assessment failure
      type: boolean
    specialNotes:
      title: Special Notes
      description: PCI special notes
      type: string
    status:
      title: Status
      description: PCI status
      type: string
  cvss_v2:
    accessComplexity:
      title: Access Complexity
      description: CVSSv2 access complexity metric
      type: string
    accessVector:
      title: Access Vector
      description: CVSSv2 access vector metric
      type: string
    authentication:
      title: Authentication
      description: CVSSv2 authentication metric
      type: string
    availabilityImpact:
      title: Availability Impact
      description: CVSSv2 availability impact metric
      type: string
    confidentialityImpact:
      title: Confidentiality Impact
      description: CVSSv2 confidentiality impact metric
      type: string
    exploitScore:
      title: Exploit Score
      description: CVSSv2 combined exploit metric score (Access Complexity/Access
        Vector/Authentication)
      type: float
    impactScore:
      title: Impact Score
      description: CVSSv2 combined impact metric score (Confidentiality/Integrity/Availability)
      type: float
    integrityImpact:
      title: Integrity Impact
      description: CVSSv2 integrity impact metric
      type: string
    score:
      title: Score
      description: CVSSv2 score
      type: float
    vector:
      title: Vector
      description: CVSSv2 combined vector string
      type: string
  cvss_v3:
    attackComplexity:
      title: Attack Complexity
      description: CVSSv3 attack complexity metric
      type: string
    attackVector:
      title: Attack Vector
      description: CVSSv3 attack vector metric
      type: string
    availabilityImpact:
      title: Availability Impact
      description: CVSSv3 availability impact metric
      type: string
    confidentialityImpact:
      title: Confidentiality Impact
      description: CVSSv3 confidentiality impact metric
      type: string
    exploitScore:
      title: Exploit Score
      description: CVSSv3 combined exploit metric score (Attack Complexity/Attack
        Vector/Privilege Required/Scope/User Interaction)
      type: float
    impactScore:
      title: Impact Score
      description: CVSSv3 combined impact metric score (Confidentiality/Integrity/Availability)
      type: float
    integrityImpact:
      title: Integrity Impact
      description: CVSSv3 integrity impact metric
      type: string
    privilegeRequired:
      title: Privilege Required
      description: CVSSv3 privilege required metric
      type: string
    scope:
      title: Scope
      description: CVSSv3 scope metric
      type: string
    score:
      title: Score
      description: CVSSv3 score
      type: float
    userInteraction:
      title: User Interaction
      description: CVSSv3 user interaction metric
      type: string
    vector:
      title: Vector
      description: CVSSv3 combined vector string
      type: string
  cvss:
    links:
      title: Links
      description: List of hypermedia links to corresponding resources
      type: '[]link'
    v2:
      title: V2
      description: CVSSv2 details
      type: cvss_v2
    v3:
      title: V3
      description: CVSSv3 details
      type: cvss_v3
  vulnerability:
    added:
      title: Added
      description: Date that the vulnerability was added to InsightVM
      type: date
    exploits:
      title: Exploits
      description: Exploit count
      type: integer
    description:
      title: Description
      description: Vulnerability description
      type: vulnerability_description
    links:
      title: Links
      description: List of hypermedia links to corresponding resources
      type: '[]link'
    title:
      title: Title
      description: Vulnerability title
      type: string
    malwareKits:
      title: Malware Kits
      description: Malware kit count
      type: integer
    denialOfService:
      title: Denial of Service
      description: Whether the vulnerability is a denial of service vulnerability
      type: boolean
    modified:
      title: Modified
      description: Date the vulnerability was last modified in InsightVM
      type: date
    id:
      title: ID
      description: Vulnerability ID
      type: string
    severityScore:
      title: Severity Score
      description: Vulnerability severity score
      type: integer
    pci:
      title: PCI
      description: Vulnerability PCI details
      type: pci
    published:
      title: Published
      description: Date the vulnerability was published
      type: date
    severity:
      title: Severity
      description: Vulnerability severity string (Moderate/Severe/Critical)
      type: string
    riskScore:
      title: Risk Score
      description: Vulnerability risk score using the configured risk scoring strategy
        (RealRisk by default)
      type: float
    cvss:
      title: CVSS
      description: Vulnerability CVSS details
      type: cvss
    categories:
      title: Categories
      description: List of vulnerabilities categories with which this vulnerability
        is affiliated
      type: '[]string'
    cves:
      title: CVEs
      description: List of CVE identifiers associated with this vulnerability
      type: '[]string'
  tag:
    color:
      title: Color
      description: Tag color
      type: string
      required: false
    created:
      title: Created
      description: Tag creation date
      type: date
      require: false
    id:
      title: ID
      description: Tag ID
      type: integer
      required: true
    links:
      title: Links
      description: Hypermedia links to corresponding or related resources
      type: '[]link'
      required: false
    name:
      title: Name
      description: Tag name
      type: string
      required: true
    riskModifier:
      title: Risk Modifier
      description: Tag risk score modifier
      type: string
      required: false
    searchCriteria:
      title: Search Criteria
      description: Tag search criteria
      type: object
      required: false
    source:
      title: Source
      description: Tag source
      type: string
      required: false
    type:
      title: Type
      description: Tag type
      type: string
      required: true
  tag_asset:
    id:
      title: ID
      description: Asset ID
      type: integer
      required: true
    sources:
      title: Sources
      description: Tag association sources
      type: '[]string'
      required: true
  scan:
    status:
      title: Status
      description: Scan status (aborted, unknown, running, finished, stopped, error,
        paused, dispatched, integrating)
      type: string
    scanType:
      title: Scan Type
      description: Type of scan (automated, manual, scheduled)
      type: string
    assets:
      title: Assets
      description: Count of assets identified during the scan
      type: integer
    links:
      title: Links
      description: List of hypermedia links to corresponding resources
      type: '[]link'
    siteName:
      title: Site Name
      description: Name of the site scanned
      type: string
    vulnerabilities:
      title: Vulnerabilities
      description: Counts of vulnerabilities identified during the scan
      type: vulnerabilities_count
    startedBy:
      title: Started By
      description: User that started the scan
      type: string
    engineId:
      title: Engine ID
      description: ID for the scan engine/scan engine pool used for the scan
      type: integer
    siteId:
      title: Site ID
      description: ID of the site scanned
      type: integer
    startTime:
      title: Start Time
      description: Start time for the scan
      type: date
    duration:
      title: Duration
      description: Duration of the scan
      type: date
    engineName:
      title: Engine Name
      description: Name of the scan engine/scan engine pool used for the scan
      type: string
    message:
      title: Message
      description: Scan status message
      type: string
    endTime:
      title: End Time
      description: End time of the scan
      type: date
    id:
      title: ID
      description: ID of the scan
      type: integer
    scanName:
      title: Scan Name
      description: Name of the scan
      type: string
  scan_engine:
    address:
      title: Address
      description: Scan engine address (IP/hostname)
      type: string
      required: true
    contentVersion:
      title: Content Version
      description: Scan engine content version
      type: string
      required: false
    enginePools:
      title: Engine Pools
      description: Engine pool IDs with which the scan engine is associated
      type: '[]integer'
      required: true
    id:
      title: ID
      description: Scan engine identifier
      type: integer
      required: true
    lastRefreshedDate:
      title: Last Refreshed Date
      description: Date and time when the engine last communicated with the console
      type: date
      required: false
    lastUpdatedDate:
      title: Last Updated Date
      description: Date and time when the engine was last updated
      type: date
      required: false
    links:
      title: Links
      description: List of hypermedia links to corresponding resources
      type: '[]link'
      required: true
    name:
      title: Name
      description: Scan engine name
      type: string
      required: true
    port:
      title: Port
      description: Scan engine communication port
      type: integer
      required: true
    productVersion:
      title: Product Version
      description: Scan engine product version
      type: string
      required: false
    sites:
      title: Sites
      description: Sites with which the scan engine is associated
      type: '[]integer'
      required: false
  scan_engine_pool:
    name:
      title: Name
      description: Scan engine pool name
      type: string
      required: true
    id:
      title: ID
      description: Scan engine pool identifier
      type: integer
      required: true
    engines:
      title: Engines
      description: List of scan engine IDs associated with the scan engine pool
      type: '[]integer'
      required: true
    links:
      title: Links
      description: List of hypermedia links to corresponding resources
      type: '[]link'
      required: true
  authentication_source:
    external:
      title: External
      description: Whether the authentication source is external (true) or internal
        (false)
      type: boolean
      required: true
    id:
      title: ID
      description: Authentication source identifier
      type: integer
      required: true
    links:
      title: Links
      description: List of hypermedia links to corresponding or related resources
      type: '[]link'
      required: true
    name:
      title: Name
      description: Authentication source name
      type: string
      required: true
    type:
      title: Type
      description: Authentication source type
      type: string
      required: true
      enum:
      - normal
      - kerberos
      - ldap
      - saml
      - admin
  role:
    description:
      title: Description
      description: The description of the role
      type: string
      required: true
    id:
      titler: ID
      description: ID of the role, e.g 'global-admin'
      type: string
      required: true
    links:
      title: Links
      description: List of hypermedia links to corresponding or related resources
      type: '[]link'
      required: true
    name:
      title: Name
      description: Name of the role
      type: string
      required: true
    privileges:
      title: Privileges
      description: List of privileges assigned to the role
      type: '[]string'
      required: true
  user_account_role:
    allAssetGroups:
      title: All Asset Groups
      description: Whether the user has access to all asset groups
      type: boolean
      required: false
    allSites:
      title: All Sites
      description: Whether the user has access to all sites
      type: boolean
      required: false
    id:
      title: ID
      description: The identifier of the role the user is assigned to
      type: string
      required: false
    privileges:
      title: Privileges
      desceiption: The privileges granted to the user by their role
      type: '[]string'
      required: false
    superuser:
      title: Superuser
      description: Whether the user is a superuser
      type: boolean
      required: false
  user_account_locale:
    default:
      title: Default
      description: Default locale
      type: string
      required: true
    reports:
      title: Reports
      description: Reports locale
      type: string
      required: true
  user_account:
    authentication:
      title: Authentication
      description: The authentication source used to authenticate the user
      type: authentication_source
      required: false
    email:
      title: Email
      description: The email address of the user
      type: string
      required: false
    enabled:
      title: Enabled
      description: Whether the user account is enabled
      type: boolean
      required: false
    id:
      title: ID
      description: The identifier of the user
      type: integer
      required: false
    links:
      title: Links
      description: List of hypermedia links to corresponding or related resources
      type: '[]link'
      required: false
    locale:
      title: Locale
      description: The locale and language preferences for the user
      type: user_account_locale
      required: false
    locked:
      title: Locked
      description: Whether the user account is locked (exceeded maximum password retry
        attempts)
      type: boolean
      required: true
    login:
      title: Login
      description: The login name of the user
      type: string
      required: true
    name:
      title: Name
      description: The full name of the user
      type: string
      required: true
    role:
      title: Role
      description: The privileges and role the user is assigned
      type: user_account_role
      required: false
  remediation_asset:
    id:
      description: Identifier of the asset
      title: ID
      type: integer
      required: true
    hostName:
      description: Primary host name (local or FQDN) of the asset
      title: Hostname
      type: string
      required: false
    ip:
      description: Primary IPv4 or IPv6 address of the asset
      title: IP
      type: string
      required: true
    mac:
      description: Media Access Control (MAC) address, e.g. AF:12:BC:5A:F7:48
      title: MAC
      type: string
      required: false
    os:
      description: Full description of the operating system of the asset
      title: OS
      type: string
      required: false
    riskScore:
      description: Risk score (with criticality adjustments) of the asset
      title: Risk Score
      type: float
      required: false
    criticalityTag:
      description: The criticality tag assigned to the asset
      title: Criticality Tag
      type: string
      required: false
  remediation_vulnerability:
    id:
      title: ID
      description: Identifier of the vulnerability
      type: integer
      required: true
    title:
      title: Title
      description: The title of the vulnerability
      type: string
      required: true
    description:
      title: Description
      description: The description of the vulnerability
      type: string
      required: true
    cvssScore:
      title: CVSS Score
      description: The CVSS score of the vulnerability
      type: string
      required: true
    severity:
      title: Severity
      description: The severity of the vulnerability
      type: integer
      required: true
    riskScore:
      title: Risk Score
      description: The risk score of the vulnerability
      type: integer
      required: true
  remediation:
    solutionId:
      title: Solution ID
      description: The identifier of the solution
      type: integer
      required: true
    nexposeId:
      title: Rapid7 Solution ID
      description: The identifier of the solution within InsightVM/Nexpose
      type: string
      required: true
    summary:
      title: Summary
      description: Remediation summary
      type: string
      required: true
    fix:
      title: Fix
      description: The steps that are part of the fix this solution prescribes
      type: string
      required: false
    assetCount:
      title: Asset Count
      description: The number of assets that require the solution to be applied
      type: integer
      required: true
    vulnerabilityCount:
      title: Vulnerability Count
      description: The number of vulnerabilities that would be remediated
      type: integer
      required: true
    riskScore:
      title: Risk Score
      description: The risk score that is reduced by performing the solution
      type: integer
      required: true
    assets:
      title: Assets
      description: The assets that require the solution to be applied
      type: '[]remediation_asset'
      required: true
    vulnerabilities:
      title: Vulnerabilities
      description: The vulnerabilities that would be remediated
      type: '[]remediation_vulnerability'
      required: true
connection:
  url:
    title: URL
    description: URL to your InsightVM console, without trailing slashes, e.g. https://insightvm.example.com:3780
    type: string
    required: true
  credentials:
    title: Credentials
    description: Username and password
    type: credential_username_password
    required: true
actions:
  scan:
    title: Scan
    description: Start a scan on a site
    input:
      site_id:
        title: Site ID
        description: ID of the site to scan
        type: string
        example: 1
        required: true
      hosts:
        title: Hosts
        description: The hosts that should be included in the scan
        type: "[]string"
        example: ["192.0.2.3", "192.0.2.10-192.0.2.20", "ADSRV.local"]
        required: false
    output:
      id:
        description: Identifier of the resource created
        title: Scan ID
        type: integer
        required: false
      links:
        description: Hypermedia links to corresponding or related resources
        title: Links
        type: '[]link'
        required: false
  get_scan:
    title: Get Scan
    description: Get the status of a scan
    input:
      scan_id:
        title: Scan ID
        description: ID of the scan to obtain
        type: string
        required: true
    output:
      status:
        description: Scan status (aborted, unknown, running, finished, stopped, error,
          paused, dispatched or integrating)
        title: Status
        type: string
        required: false
      scanType:
        description: Scan type (manual, automated, scheduled)
        title: Scan Type
        type: string
        required: false
      assets:
        description: Number of assets within the scan
        title: Assets
        type: integer
        required: false
      links:
        description: Hypermedia links to corresponding or related resources
        title: Links
        type: '[]link'
        required: false
      vulnerabilities:
        description: Counts of vulnerabilities found within the scan
        title: Vulnerabilities
        type: vulnerabilities_count
        required: false
      startTime:
        description: Start time of the scan in ISO8601 format
        title: Start Time
        type: string
        required: false
      duration:
        description: Duration of the scan in ISO8601 format
        title: Duration
        type: string
        required: false
      engineName:
        description: Name of the engine used for the scan
        title: Engine Name
        type: string
        required: false
      endTime:
        description: End time of the scan in ISO8601 format
        title: End Time
        type: string
        required: false
      id:
        description: ID of the scan
        title: ID
        type: integer
        required: false
      scanName:
        description: User-driven scan name for the scan
        title: Scan Name
        type: string
        required: false
  get_site_assets:
    title: Get Site Assets
    description: Gets assets for a site
    input:
      site_id:
        title: Site ID
        description: ID of the site to get assets for
        type: string
        required: true
    output:
      assets:
        title: Assets
        description: Assets
        type: '[]asset'
        required: false
  get_scan_assets:
    title: Get Scan Assets
    description: Gets assets for a scan
    input:
      scan_id:
        title: Scan ID
        description: ID of the scan to get assets for
        type: integer
        required: true
    output:
      assets:
        title: Assets
        description: Assets
        type: '[]asset'
        required: false
  get_asset_vulnerabilities:
    title: Get Asset Vulnerabilities
    description: Get vulnerabilities found on an asset. Can only be used if the asset
      has first been scanned
    input:
      asset_id:
        title: Asset ID
        description: ID of the asset for which to find vulnerabilities
        type: string
        required: true
    output:
      vulnerabilities:
        title: Vulnerabilities
        description: Vulnerabilities found on the asset
        type: '[]asset_vulnerability'
        required: false
  get_asset_software:
    title: Get Asset Software
    description: Get software found on an asset. Can only be used if the asset has first been scanned
    input:
      asset_id:
        title: Asset ID
        description: ID of the asset for which to find software
        type: string
        required: true
    output:
      software:
        title: Software
        description: Software found on the asset
        type: '[]software'
        required: false
  download_report:
    title: Download Report
    description: Returns the contents of a generated report
    input:
      id:
        title: Report ID
        description: Identifier of the report to download e.g. 265
        type: integer
        required: true
      instance:
        title: Instance
        description: The identifier of the report instance, 'latest' or ID e.g. 100
        type: string
        required: true
    output:
      report:
        title: Report
        description: Base64 encoded report
        type: bytes
        required: false
  list_reports:
    title: List Reports
    description: List reports and return their identifiers
    input:
      name:
        description: Name of report, otherwise all reports by criteria
        type: string
        required: false
      sort:
        description: Sort order, ascending or descending
        type: string
        enum:
        - Ascending
        - Descending
        required: true
    output:
      found:
        description: Whether optional user supplied report name was found
        type: boolean
        required: false
      list:
        title: List of Reports
        description: List of report identifiers
        type: '[]report_id'
        required: false
  get_vulnerability_affected_assets:
    title: Get Vulnerability Affected Assets
    description: Get the assets affected by the vulnerability
    input:
      vulnerability_id:
        title: Vulnerability ID
        description: The identifier of the vulnerability e.g. jre-vuln-cve-2013-2471
        type: string
        required: true
    output:
      links:
        title: Links
        description: Hypermedia links to corresponding or related resources
        type: '[]link'
        required: true
      resources:
        title: Resources
        description: The identifiers of the associated resources
        type: '[]integer'
        required: true
  create_tag:
    title: Create Tag
    description: Create a new tag
    input:
      name:
        title: Name
        description: Tag name
        type: string
        required: true
      type:
        title: Type
        description: Tag type
        type: string
        required: true
        enum:
        - owner
        - location
        - custom
      color:
        title: Color
        description: Tag color (only available for custom tags)
        type: string
        required: false
        default: default
        enum:
        - default
        - blue
        - green
        - orange
        - purple
        - red
      searchCriteria:
        title: Search Criteria
        description: Tag search Criteria - options documentation https://help.rapid7.com/insightvm/en-us/api/#section/Responses/SearchCriteria
        type: object
        required: false
    output:
      id:
        title: ID
        description: ID of the created tag
        type: integer
        required: true
  delete_tag:
    title: Delete Tag
    description: Delete an existing tag
    input:
      id:
        title: ID
        description: Tag ID
        type: integer
        required: true
    output:
      links:
        title: Links
        description: Hypermedia links to corresponding or related resources
        type: '[]link'
        required: true
  get_tags:
    title: Get Tags
    description: Get a listing of all tags and return their details
    input:
      name:
        title: Name
        description: Tag name regular expression by which to filter
        type: string
        required: false
        default: ''
      type:
        title: Type
        description: Type of tag by which to filter, all types are returned if none
          is specified
        type: string
        required: false
        default: ''
        enum:
        - owner
        - location
        - custom
        - criticality
        - ''
    output:
      tags:
        title: Tags
        description: List of tags
        type: '[]tag'
        required: true
  get_tag:
    title: Get Tag
    description: Get tag details by tag ID
    input:
      id:
        title: ID
        description: Tag ID, e.g. 1
        type: integer
        required: true
    output:
      tag:
        title: Tag
        description: Tag Details
        type: tag
        required: true
  get_tag_sites:
    title: Get Tag Sites
    description: Get site IDs associated with a tag
    input:
      id:
        title: ID
        description: Tag ID for which to retrieve site associations
        type: integer
        required: true
    output:
      site_ids:
        title: Site IDs
        description: Site IDs associated with the tag
        type: '[]integer'
        required: true
  get_tag_assets:
    title: Get Tag Assets
    description: Get asset IDs associated with a tag
    input:
      id:
        title: ID
        description: Tag ID to add to site
        type: integer
        required: true
    output:
      assets:
        title: Assets
        description: Asset IDs and tag association sources for the tag
        type: '[]tag_asset'
        required: true
  get_tag_asset_groups:
    title: Get Tag Asset Groups
    description: Get asset groups associated with a tag
    input:
      id:
        title: ID
        description: Tag ID for which to retrieve asset group associations
        type: integer
        required: true
    output:
      asset_group_ids:
        title: Asset Group IDs
        description: Asset group IDs associated with the tag
        type: '[]integer'
        required: true
  remove_asset_tag:
    title: Remove Asset Tag
    description: Remove a tag from an asset
    input:
      asset_id:
        title: Asset ID
        description: Asset ID from which to remove the tag
        type: integer
        required: true
      tag_id:
        title: Tag ID
        description: Tag ID to remove from the asset
        type: integer
        required: true
    output:
      links:
        title: Links
        description: Hypermedia links to corresponding or related resources
        type: '[]link'
        required: true
  remove_asset_group_tags:
    title: Remove Asset Group Tags
    description: Remove all tags from an asset group
    input:
      id:
        title: ID
        description: Asset group ID from which to remove all tags
        type: integer
        required: true
    output:
      links:
        title: Links
        description: Hypermedia links to corresponding or related resources
        type: '[]link'
        required: true
  remove_tag_asset_groups:
    title: Remove Tag Asset Groups
    description: Remove all asset group associations from a tag
    input:
      id:
        title: ID
        description: Tag ID from which to remove all asset group associations
        type: integer
        required: true
    output:
      links:
        title: Links
        description: Hypermedia links to corresponding or related resources
        type: '[]link'
        required: true
  remove_tag_sites:
    title: Remove Tag Sites
    description: Remove all site associations from a tag
    input:
      id:
        title: ID
        description: Tag ID from which to remove all site associations
        type: integer
        required: true
    output:
      links:
        title: Links
        description: Hypermedia links to corresponding or related resources
        type: '[]link'
        required: true
  remove_tag_search_criteria:
    title: Remove Tag Search Criteria
    description: Remove all search criteria from a tag
    input:
      id:
        title: ID
        description: Tag ID from which to remove all search criteria
        type: integer
        required: true
    output:
      links:
        title: Links
        description: Hypermedia links to corresponding or related resources
        type: '[]link'
        required: true
  tag_site:
    title: Tag Site
    description: Add a tag to a site
    input:
      site_id:
        title: Site ID
        description: Site ID to tag
        type: integer
        required: true
      tag_id:
        title: Tag ID
        description: Tag ID to add to site
        type: integer
        required: true
    output:
      links:
        title: Links
        description: Hypermedia links to corresponding or related resources
        type: '[]link'
        required: true
  tag_asset:
    title: Tag Asset
    description: Add a tag to an asset
    input:
      asset_id:
        title: Asset ID
        description: Asset ID to tag
        type: integer
        required: true
      tag_id:
        title: Tag ID
        description: Tag ID to add to site
        type: integer
        required: true
    output:
      links:
        title: Links
        description: Hypermedia links to corresponding or related resources
        type: '[]link'
        required: true
  tag_asset_group:
    title: Tag Asset Group
    description: Add a tag to an asset group
    input:
      asset_group_id:
        title: Asset Group ID
        description: Asset group ID to tag
        type: integer
        required: true
      tag_id:
        title: Tag ID
        description: Tag ID to add to site
        type: integer
        required: true
    output:
      links:
        title: Links
        description: Hypermedia links to corresponding or related resources
        type: '[]link'
        required: true
  update_tag_search_criteria:
    title: Update Tag Search Criteria
    description: Update the search criteria for an existing tag
    input:
      id:
        title: ID
        description: Tag ID
        type: integer
        required: true
      searchCriteria:
        title: Search Criteria
        description: 'Tag search criteria - options documentation: https://help.rapid7.com/insightvm/en-us/api/#section/Responses/SearchCriteria'
        type: object
        required: true
    output:
      links:
        title: Links
        description: Hypermedia links to corresponding or related resources
        type: '[]link'
        required: true
  asset_search:
    title: Asset Search
    description: Search for assets using filtered asset search
    input:
      searchCriteria:
        title: Search Criteria
        description: 'Tag search criteria - options documentation: https://help.rapid7.com/insightvm/en-us/api/#section/Responses/SearchCriteria'
        type: object
        required: true
    output:
      assets:
        title: Assets
        description: List of asset details returned by the search
        type: '[]asset'
        required: true
  get_asset:
    title: Get Asset
    description: Gets an asset by ID
    input:
      id:
        title: ID
        description: Get an asset by ID
        type: integer
        required: true
    output:
      asset:
        title: Asset
        description: Asset details
        type: asset
        required: true
  get_asset_tags:
    title: Get Asset Tags
    description: Get a listing of all tags for an asset
    input:
      asset_id:
        title: Asset ID
        description: Identifier of asset
        type: integer
        required: true
    output:
      tags:
        title: Tags
        description: List of tags
        type: '[]tag'
        required: true
  get_sites:
    title: Get Sites
    description: Get a list of sites
    input:
      name:
        title: Name
        description: Site name regular expression by which to filter
        type: string
        default: ''
        required: false
    output:
      sites:
        title: Sites
        description: List of sites
        type: '[]site'
        required: true
  get_site:
    title: Get Site
    description: Get a site by ID
    input:
      id:
        title: ID
        description: Site ID
        type: integer
        required: true
    output:
      site:
        title: Site
        description: Site details
        type: site
        required: true
  create_site:
    title: Create Site
    description: Create a new site
    input:
      name:
        title: Name
        description: The site name. Name must be unique
        type: string
        required: true
      description:
        title: Description
        description: The site's description
        type: string
        required: false
      engine_id:
        title: Engine ID
        description: The identifier of a scan engine. Default scan engine is selected
          when not specified
        type: integer
        required: false
      importance:
        title: Importance
        description: The site importance
        type: string
        required: false
        enum:
        - very_low
        - low
        - normal
        - high
        - very_high
        default: normal
      scan_template_id:
        title: Scan Template ID
        description: The identifier of a scan template
        type: string
        required: false
      included_addresses:
        title: Included Addresses
        description: List of addresses to include in scan scope
        type: '[]string'
        default: []
        required: false
      excluded_addresses:
        title: Excluded Addresses
        description: List of addresses to exclude in scan scope
        type: '[]string'
        default: []
        required: false
      included_asset_groups:
        title: Included Asset Groups
        description: Assets associated with these asset group IDs will be included
          in the site
        type: '[]integer'
        default: []
        required: false
      excluded_asset_groups:
        title: Excluded Asset Groups
        description: Assets associated with these asset group IDs will be excluded
          in the site
        type: '[]integer'
        default: []
        required: false
    output:
      id:
        title: ID
        description: The identifier of the created site
        type: integer
        required: true
      links:
        title: Links
        description: Hypermedia links to corresponding or related resources
        type: '[]link'
        required: true
  update_site:
    title: Update Site
    description: Update an existing site
    input:
      id:
        title: Site ID
        description: The identifier of the site
        type: integer
        required: true
      name:
        title: Name
        description: The site name. Name must be unique
        type: string
        required: true
      description:
        title: Description
        description: The site's description
        type: string
        required: true
      engine_id:
        title: Engine ID
        description: The identifier of a scan engine. Default scan engine is selected
          when not specified
        type: integer
        required: true
      importance:
        title: Importance
        description: The site importance
        type: string
        required: true
        enum:
        - very_low
        - low
        - normal
        - high
        - very_high
        default: normal
      scan_template_id:
        title: Scan Template ID
        description: The identifier of a scan template
        type: string
        required: true
    output:
      id:
        title: ID
        description: The identifier of the updated site
        type: integer
        required: true
      links:
        title: Links
        description: Hypermedia links to corresponding or related resources
        type: '[]link'
        required: true
  update_site_included_targets:
    title: Update Site Included Targets
    description: Update an existing site scope of included IP address and hostname
      targets
    input:
      id:
        title: Site ID
        description: The identifier of the site
        type: integer
        required: true
      included_targets:
        title: Included Targets
        description: List of addresses that represent either a hostname, IPv4 address,
          IPv4 address range, IPv6 address, or CIDR notation
        type: '[]string'
        required: false
      overwrite:
        title: Overwrite
        description: Whether to overwrite the included targets to the current site
          or append to the previous list of included targets
        type: boolean
        required: true
        default: true
    output:
      id:
        title: ID
        description: The identifier of the updated site
        type: integer
        required: true
      links:
        title: Links
        description: Hypermedia links to corresponding or related resources
        type: '[]link'
        required: true
  update_site_excluded_targets:
    title: Update Site Excluded Targets
    description: Update an existing site scope of excluded IP address and hostname
      targets
    input:
      id:
        title: Site ID
        description: The identifier of the site
        type: integer
        required: true
      excluded_targets:
        title: Excluded Targets
        description: List of addresses that represent either a hostname, IPv4 address,
          IPv4 address range, IPv6 address, or CIDR notation
        type: '[]string'
        required: false
      overwrite:
        title: Overwrite
        description: Whether to overwrite the excluded targets to the current site
          or append to the previous list of excluded targets
        type: boolean
        required: true
        default: true
    output:
      id:
        title: ID
        description: The identifier of the updated site
        type: integer
        required: true
      links:
        title: Links
        description: Hypermedia links to corresponding or related resources
        type: '[]link'
        required: true
  update_site_included_asset_groups:
    title: Update Site Included Asset Groups
    description: Update an existing site scope of included asset groups
    input:
      id:
        title: Site ID
        description: The identifier of the site
        type: integer
        required: true
      included_asset_groups:
        title: Included Asset Group IDs
        description: Assets associated with these asset group IDs will be included
          in the site
        type: '[]integer'
        required: false
      overwrite:
        title: Overwrite
        description: Whether to overwrite the included asset group IDs to the current
          site or append to the previous list of asset group IDs
        type: boolean
        required: true
        default: true
    output:
      id:
        title: ID
        description: The identifier of the updated site
        type: integer
        required: true
      links:
        title: Links
        description: Hypermedia links to corresponding or related resources
        type: '[]link'
        required: true
  update_site_excluded_asset_groups:
    title: Update Site Excluded Asset Groups
    description: Update an existing site scope of excluded asset groups
    input:
      id:
        title: Site ID
        description: The identifier of the site
        type: integer
        required: true
      excluded_asset_groups:
        title: Excluded Asset Group IDs
        description: Assets associated with these asset group IDs will be excluded
          from the site
        type: '[]integer'
        required: false
      overwrite:
        title: Overwrite
        description: Whether to overwrite the excluded asset group IDs to the current
          site or append to the previous list of asset group IDs
        type: boolean
        required: true
        default: true
    output:
      id:
        title: ID
        description: The identifier of the updated site
        type: integer
        required: true
      links:
        title: Links
        description: Hypermedia links to corresponding or related resources
        type: '[]link'
        required: true
  delete_site:
    title: Delete Site
    description: Delete an existing site
    input:
      id:
        title: ID
        description: Site ID
        type: integer
        required: true
    output:
      links:
        title: Links
        description: Hypermedia links to corresponding or related resources
        type: '[]link'
        required: true
  get_asset_groups:
    title: Get Asset Groups
    description: Get a list of asset groups
    input:
      name:
        title: Name
        description: Asset group name regular expression by which to filter
        type: string
        default: ''
        required: false
    output:
      asset_groups:
        title: Asset Groups
        description: List of asset groups
        type: '[]asset_group'
        required: true
  get_asset_group:
    title: Get Asset Group
    description: Get an asset group by ID
    input:
      id:
        title: ID
        description: Asset group ID
        type: integer
        required: true
    output:
      asset_group:
        title: Asset Group
        description: Asset group
        type: asset_group
        required: true
  create_asset_group:
    title: Create Asset Group
    description: Create an asset group
    input:
      name:
        title: Name
        description: Asset group name
        type: string
        required: true
      description:
        title: Description
        description: Asset group description
        type: string
        required: false
      searchCriteria:
        title: Search Criteria
        description: 'Asset group search criteria - options documentation: https://help.rapid7.com/insightvm/en-us/api/#section/Responses/SearchCriteria'
        type: object
        required: false
      type:
        title: Type
        description: Asset group type
        type: string
        required: true
        enum:
        - dynamic
        - static
    output:
      id:
        title: ID
        description: ID of the created tag
        type: integer
        required: true
  delete_asset_group:
    title: Delete Asset Group
    description: Delete an existing asset group
    input:
      id:
        title: ID
        description: Asset group ID
        type: integer
        required: true
    output:
      links:
        title: Links
        description: Hypermedia links to corresponding or related resources
        type: '[]link'
        required: true
  update_asset_group_search_criteria:
    title: Update Asset Group Search Criteria
    description: Update the search criteria for an existing asset group
    input:
      id:
        title: ID
        description: Asset group ID
        type: integer
        required: true
      searchCriteria:
        title: Search Criteria
        description: 'Asset group search criteria - options documentation: https://help.rapid7.com/insightvm/en-us/api/#section/Responses/SearchCriteria'
        type: object
        required: true
    output:
      links:
        title: Links
        description: Hypermedia links to corresponding or related resources
        type: '[]link'
        required: true
  get_vulnerabilities_by_cve:
    title: Get Vulnerabilities by CVE
    description: Get vulnerability details associated with a CVE
    input:
      cve_id:
        title: CVE ID
        description: Common Vulnerabilities and Exposures ID, e.g. CVE-2018-12345
        type: string
        required: true
    output:
      vulnerabilities:
        title: Vulnerabilities
        description: Vulnerability details
        type: '[]vulnerability'
        required: true
  get_scans:
    title: Get Scans
    description: Get scans with optional site filter
    input:
      id:
        title: ID
        description: Site ID
        type: integer
        required: false
      active:
        title: Active
        description: Return running scans or past scans
        default: false
        type: boolean
        required: false
    output:
      scans:
        title: Scans
        description: List of scan details
        type: '[]scan'
        required: true
  update_scan_status:
    title: Update Scan Status
    description: Update the status of a scan
    input:
      id:
        title: ID
        description: Scan ID
        type: integer
        required: true
      status:
        title: Status
        description: Status to which the scan should be set (stop, resume, pause)
        type: string
        required: true
        default: stop
        enum:
        - stop
        - resume
        - pause
    output:
      links:
        title: Links
        description: Hypermedia links to corresponding or related resources
        type: '[]link'
        required: true
  generate_shared_secret:
    title: Generate Shared Secret
    description: Generate a shared secret to pair a scan engine to a security console
    input:
      time_to_live:
        title: Time to Live
        description: Time to live in seconds for the shared secret
        default: 3600
        type: integer
        required: true
    output:
      shared_secret:
        title: Shared Secret
        description: Scan engine pairing shared secret
        type: string
        required: true
  get_scan_engines:
    title: Get Scan Engines
    description: List scan engines paired with the security console
    input:
      name:
        title: Name
        description: Optional engine name by which to filter, accepts regular expression
          patterns
        type: string
        required: false
      address:
        title: Address
        description: Optional address (IP/hostname) by which to filter, accepts regular
          expression patterns
        type: string
        required: false
    output:
      scan_engines:
        title: Scan Engines
        description: List of scan engines details
        type: '[]scan_engine'
        required: true
  get_scan_engine:
    title: Get Scan Engine
    description: Get a scan engine by ID
    input:
      id:
        title: ID
        description: Scan engine identifier
        type: integer
        required: true
    output:
      scan_engine:
        title: Scan Engine
        description: Scan engine details
        type: scan_engine
        required: true
  create_scan_engine:
    title: Create Scan Engine
    description: Create a new scan engine with console engine connectivity
    input:
      name:
        title: Name
        description: Scan engine name
        type: string
        required: true
      address:
        title: Address
        description: Scan engine address (IP/hostname)
        type: string
        required: true
      port:
        title: Port
        description: Scan engine connectivity port
        default: 40814
        type: integer
        required: true
      sites:
        title: Sites
        description: List of site IDs with which to associate the engine
        type: '[]integer'
        default: []
        required: false
    output:
      id:
        title: ID
        description: Scan engine ID
        type: integer
        required: true
      links:
        title: Links
        description: Hypermedia links to corresponding or related resources
        type: '[]link'
        required: true
  delete_scan_engine:
    title: Delete Scan Engine
    description: Delete an existing scan engine from the security console
    input:
      id:
        title: ID
        description: Scan engine identifier
        type: integer
        required: true
    output:
      links:
        title: Links
        description: Hypermedia links to corresponding or related resources
        type: '[]link'
        required: true
  get_scan_engine_pools:
    title: Get Scan Engine Pools
    description: Retrieve a list of configured scan engine pools
    input:
      name:
        title: Name
        description: Scan engine pool name by which to filter, accepts regular expression
          patterns
        type: string
        required: false
    output:
      scan_engine_pools:
        title: Scan Engine Pools
        description: List of scan engine pool details
        type: '[]scan_engine_pool'
        required: true
  get_scan_engine_pool:
    title: Get Scan Engine Pool
    description: Retrieve scan engine pool details by ID
    input:
      id:
        title: ID
        description: Scan engine pool identifier
        type: integer
        required: true
    output:
      scan_engine_pool:
        title: Scan Engine Pool
        description: Scan engine pool details
        type: scan_engine_pool
        required: true
  create_scan_engine_pool:
    title: Create Scan Engine Pool
    description: Create a new scan engine pool
    input:
      name:
        title: Name
        description: Scan engine pool name
        type: string
        required: true
      engines:
        title: Engines
        description: List of scan engine IDs to associate with the scan engine pool
        type: '[]integer'
        required: false
    output:
      id:
        title: ID
        description: Scan engine pool ID
        type: integer
        required: true
      links:
        title: Links
        description: Hypermedia links to corresponding or related resources
        type: '[]link'
        required: true
  add_scan_engine_pool_engine:
    title: Add Scan Engine Pool Engine
    description: Add a scan engine to a scan engine pool (AWS pre-authorized engine
      AMI engines cannot be pooled)
    input:
      pool_id:
        title: Pool ID
        description: Scan engine pool ID
        type: integer
        required: true
      engine_id:
        title: Engine ID
        description: Scan engine ID
        type: integer
        required: true
    output:
      links:
        title: Links
        description: Hypermedia links to corresponding or related resources
        type: '[]link'
        required: true
  remove_scan_engine_pool_engine:
    title: Remove Scan Engine Pool Engine
    description: Remove a scan engine from a scan engine pool
    input:
      pool_id:
        title: Pool ID
        description: Scan engine pool ID
        type: integer
        required: true
      engine_id:
        title: Engine ID
        description: Scan engine ID
        type: integer
        required: true
    output:
      links:
        title: Links
        description: Hypermedia links to corresponding or related resources
        type: '[]link'
        required: true
  delete_scan_engine_pool:
    title: Delete Scan Engine Pool
    description: Delete an existing scan engine pool from the security console
    input:
      id:
        title: ID
        description: Scan engine pool identifier
        type: integer
        required: true
    output:
      links:
        title: Links
        description: Hypermedia links to corresponding or related resources
        type: '[]link'
        required: true
  update_site_scan_engine:
    title: Update Site Scan Engine
    description: Update the scan engine/scan engine pool associated with a site
    input:
      site_id:
        title: Site ID
        description: Identifier of the site to update
        type: integer
        required: true
      engine_id:
        title: Engine ID
        description: Identifier of the scan engine/scan engine pool to associate with
          the site
        type: integer
        required: true
    output:
      links:
        title: Links
        description: Hypermedia links to corresponding or related resources
        type: '[]link'
        required: true
  get_authentication_sources:
    title: Get Authentication Sources
    description: List authentication sources available for InsightVM users
    input:
      name:
        title: Name
        description: Authentication source name by which to filter, accepts regular
          expression patterns
        type: string
        required: false
      type:
        title: Type
        description: Authentication source type by which to filter
        type: string
        required: false
        default: ''
        enum:
        - ''
        - admin
        - kerberos
        - ldap
        - normal
        - saml
    output:
      authentication_sources:
        title: Authentication Sources
        description: List of authentication sources
        type: '[]authentication_source'
        required: true
  get_authentication_source:
    title: Get Authentication Source
    description: Get the details for an authentication source
    input:
      id:
        title: ID
        description: Authentication source ID
        type: integer
        required: true
    output:
      authentication_source:
        title: Authentication Source
        description: User authentication source
        type: authentication_source
        required: true
  get_roles:
    title: Get Roles
    description: List role details
    input:
      name:
        title: Name
        description: Role name by which to filter, accepts regular expression patterns
        type: string
        required: false
    output:
      roles:
        title: Roles
        description: List of roles
        type: '[]role'
        required: true
  get_role:
    title: Get Role
    description: Get role details by ID
    input:
      id:
        title: ID
        description: Role ID, e.g 'global-admin'
        type: string
        required: true
    output:
      role:
        title: Role
        description: Role details
        type: role
        required: true
  get_users:
    title: Get Users
    description: List user accounts
    input:
      name:
        title: Name
        description: User account name by which to filter, accepts regular expression
          patterns
        type: string
        required: false
      login:
        title: Login
        description: User account login name by which to filter, accepts regular expression
          patterns
        type: string
        required: false
    output:
      users:
        title: Users
        description: List of user account details
        type: '[]user_account'
        required: true
  get_user:
    title: Get User
    description: Get user account details by ID
    input:
      id:
        title: ID
        description: User account ID
        type: integer
        required: true
    output:
      user:
        title: User
        description: User account details
        type: user_account
        required: true
  create_user:
    title: Create User
    description: Create a new user account (limited to external authentication sources)
    input:
      authentication_id:
        title: Authentication ID
        description: The identifier of the authentication source to use to authenticate
          the user. The source with the specified identifier must be of the type specified
          by Authentication Type. If Authentication ID is omitted, then one source
          of the specified Authentication Type is selected
        type: integer
        required: false
      authentication_type:
        title: Authentication Type
        description: The type of the authentication source to use to authenticate
          the user
        type: string
        required: true
        default: ldap
        enum:
        - kerberos
        - ldap
        - saml
      email:
        title: Email
        description: The email address of the user
        type: string
        required: true
      enabled:
        title: Enabled
        description: Whether the user account is enabled
        type: boolean
        required: true
        default: true
      login:
        title: Login
        description: The login name of the user
        type: string
        required: true
      name:
        title: Name
        description: The full name of the user
        type: string
        required: true
      access_all_asset_groups:
        title: Access All Asset Groups
        description: Whether to grant the user access to all asset groups
        type: boolean
        required: true
        default: false
      access_all_sites:
        title: Access All Sites
        description: Whether to grant the user access to all sites
        type: boolean
        required: true
        default: false
      role_id:
        title: Role ID
        description: The identifier of the role to which the user should be assigned,
          e.g 'global-admin'
        type: string
        required: true
    output:
      links:
        title: Links
        description: Hypermedia links to corresponding or related resources
        type: '[]link'
        required: true
      id:
        title: ID
        description: The identifier of the created user account
        type: integer
        required: true
  update_user:
    title: Update User
    description: Update the configuration of an existing user account
    input:
      id:
        title: ID
        description: The identifier of the user
        type: integer
        required: true
      authentication_id:
        title: Authentication ID
        description: The identifier of the authentication source to use to authenticate
          the user. The source with the specified identifier must be of the type specified
          by Authentication Type. If Authentication ID is omitted, then one source
          of the specified Authentication Type is selected
        type: integer
        required: false
      authentication_type:
        title: Authentication Type
        description: The type of the authentication source to use to authenticate
          the user
        type: string
        required: true
        default: ldap
        enum:
        - normal
        - admin
        - kerberos
        - ldap
        - saml
      email:
        title: Email
        description: The email address of the user
        type: string
        required: true
      enabled:
        title: Enabled
        description: Whether the user account is enabled
        type: boolean
        required: true
        default: true
      login:
        title: Login
        description: The login name of the user
        type: string
        required: true
      name:
        title: Name
        description: The full name of the user
        type: string
        required: true
      access_all_asset_groups:
        title: Access All Asset Groups
        description: Whether to grant the user access to all asset groups
        type: boolean
        required: true
        default: false
      access_all_sites:
        title: Access All Sites
        description: Whether to grant the user access to all sites
        type: boolean
        required: true
        default: false
      role_id:
        title: Role ID
        description: The identifier of the role to which the user should be assigned,
          e.g 'global-admin'
        type: string
        required: true
    output:
      links:
        title: Links
        description: Hypermedia links to corresponding or related resources
        type: '[]link'
        required: true
  delete_user:
    title: Delete User
    description: Delete an user account
    input:
      id:
        title: ID
        description: The identifier of the user account
        type: integer
        required: true
    output:
      links:
        title: Links
        description: Hypermedia links to corresponding or related resources
        type: '[]link'
        required: true
  disable_user:
    title: Disable User
    description: Disable an user account
    input:
      id:
        title: ID
        description: The identifier of the user account
        type: integer
        required: true
    output:
      links:
        title: Links
        description: Hypermedia links to corresponding or related resources
        type: '[]link'
        required: true
  enable_user:
    title: Enable User
    description: Enable an user account
    input:
      id:
        title: ID
        description: The identifier of the user account
        type: integer
        required: true
    output:
      links:
        title: Links
        description: Hypermedia links to corresponding or related resources
        type: '[]link'
        required: true
  update_user_role:
    title: Update User Role
    description: Update the role associated with an user account
    input:
      user_id:
        title: User ID
        description: The identifier of the user account
        type: integer
        required: true
      access_all_asset_groups:
        title: Access All Asset Groups
        description: Whether to grant the user access to all asset groups
        type: boolean
        required: true
        default: false
      access_all_sites:
        title: Access All Sites
        description: Whether to grant the user access to all sites
        type: boolean
        required: true
        default: false
      role_id:
        title: Role ID
        description: The identifier of the role to which the user should be assigned,
          e.g 'global-admin'
        type: string
        required: true
    output:
      links:
        title: Links
        description: Hypermedia links to corresponding or related resources
        type: '[]link'
        required: true
  update_user_asset_group_access:
    title: Update User Asset Group Access
    description: Update the asset groups to which a user has access in bulk. It can
      be used to remove asset group access as well
    input:
      user_id:
        title: User ID
        description: The identifier of the user account
        type: integer
        required: true
      asset_group_ids:
        title: Asset Group IDs
        description: The identifiers of the asset groups to which the user account
          should be granted access, ignored if the user has access to all asset groups
        type: '[]integer'
        required: true
    output:
      links:
        title: Links
        description: Hypermedia links to corresponding or related resources
        type: '[]link'
        required: true
  add_user_asset_group_access:
    title: Add User Asset Group Access
    description: Grant an user account access to an asset group by ID
    input:
      user_id:
        title: User ID
        description: The identifier of the user account
        type: integer
        required: true
      asset_group_id:
        title: Asset Group ID
        description: The identifier of the asset group
        type: integer
        required: true
    output:
      links:
        title: Links
        description: Hypermedia links to corresponding or related resources
        type: '[]link'
        required: true
  remove_user_asset_group_access:
    title: Remove User Asset Group Access
    description: Remove asset group access from an user account
    input:
      user_id:
        title: User ID
        description: The identifier of the user account
        type: integer
        required: true
      asset_group_id:
        title: Asset Group ID
        description: The identifier of the asset group
        type: integer
        required: true
    output:
      links:
        title: Links
        description: Hypermedia links to corresponding or related resources
        type: '[]link'
        required: true
  update_user_site_access:
    title: Update User Site Access
    description: Update the sites to which a user has access in bulk. It can be used
      to remove sites as well
    input:
      user_id:
        title: User ID
        description: The identifier of the user account
        type: integer
        required: true
      site_ids:
        title: Site IDs
        description: The identifiers of the sites to which the user account should
          be granted access, ignored if the user has access to all sites
        type: '[]integer'
        required: true
    output:
      links:
        title: Links
        description: Hypermedia links to corresponding or related resources
        type: '[]link'
        required: true
  add_user_site_access:
    title: Add User Site Access
    description: Grant an user account access to a site by ID
    input:
      user_id:
        title: User ID
        description: The identifier of the user account
        type: integer
        required: true
      site_id:
        title: Site ID
        description: The identifier of the site
        type: integer
        required: true
    output:
      links:
        title: Links
        description: Hypermedia links to corresponding or related resources
        type: '[]link'
        required: true
  remove_user_site_access:
    title: Remove User Site Access
    description: Remove site access from an user account
    input:
      user_id:
        title: User ID
        description: The identifier of the user account
        type: integer
        required: true
      site_id:
        title: Site ID
        description: The identifier of the site
        type: integer
        required: true
    output:
      links:
        title: Links
        description: Hypermedia links to corresponding or related resources
        type: '[]link'
        required: true
  top_remediations:
    title: Top Remediations
    description: Generate results for the top remediations based on a defined scope
    input:
      limit:
        title: Limit
        description: Number of remediations for which tickets should be generated
        type: integer
        required: true
        default: 25
        enum:
          - 10
          - 25
          - 50
          - 100
      scope:
        title: Scope
        description: Scope context for generated report; if set remediations will be scoped by each in scope ID, e.g Site ID, Tag ID, Asset Group ID
        type: string
        required: true
        default: none
        enum:
          - none
          - assets
          - assetGroups
          - sites
          - tags
          - scan
      scope_ids:
        title: Scope IDs
        description: Scope IDs for which tickets should be generated, by default all are included
        type: '[]integer'
        required: false
        default: []
      asset_limit:
        title: Asset Limit
        description: The amount of assets to be returned with each top remediation; this can be used to reduce message size and processing time
        type: integer
        required: false
      vulnerability_limit:
        title: Vulnerability Limit
        description: The amount of vulnerabilities to be returned with each top remediation; this can be used to reduce message size and processing time
        type: integer
        required: false
    output:
      remediations:
        title: Remediations
        description: List of top remediations
        type: '[]remediation'
        required: true
  generate_adhoc_sql_report:
    title: Generate AdHoc SQL Report
    description: Create, generate, download, and cleanup a SQL report based on the provided query
    input:
      query:
        title: Query
        type: string
        description: Reporting Data Model SQL query
        required: true
      scope:
        title: Scope
        description: Scope context for generated report; if set, remediations will be scoped by each in scope ID, e.g Site ID, Tag ID, Asset Group ID; scan scope only supports single scan ID as input
        type: string
        required: true
        default: none
        enum:
          - none
          - assets
          - assetGroups
          - sites
          - tags
          - scan
      scope_ids:
        title: Scope IDs
        description: Scope IDs for which tickets should be generated, by default all are included
        type: '[]integer'
        required: false
        default: []
      filters:
        title: Report Filters
        description: Filters in JSON format to be applied to the contents of the report; review InsightVM API documentation for filter options
        type: string
        required: false
        default: '{}'
    output:
      report:
        type: file
        title: Base64 Encoded Report
        description: Base64 encoded file making up the report
        required: true
  review_exception:
    title: Review Vulnerability Exception
    description: Approve or Reject a Vulnerability Exception
    input:
      exception:
        title: Exception ID
        description: The vulnerability exception ID to approve or reject
        type: integer
        required: true
      review:
        title: Review Outcome
        description: Approval or rejection of the exception
        type: string
        required: true
        enum:
        - Approved
        - Rejected
      comment:
        title: Review Comment
        description: Comment to include in the review
        type: string
        required: false
    output:
      links:
        title: Links
        description: Hypermedia links to corresponding or related resources
        type: '[]link'
        required: true
  delete_exception:
    title: Delete Vulnerability Exception
    description: Delete an existing vulnerability exception
    input:
      exception_id:
        title: Exception ID
        description: Vulnerability exception ID to delete
        type: integer
        required: true
    output:
      links:
        title: Links
        description: Hypermedia links to corresponding or related resources
        type: '[]link'
        required: true
  create_exception:
    title: Create Vulnerability Exception Submission
    description: Create a vulnerability exception submission
    input:
      type:
        title: Exception Type
        description: The type of vulnerability exception to create
        type: string
        required: true
        enum:
        - Global
        - Site
        - Asset
        - Asset Group
        - Instance
      vulnerability:
        title: Vulnerability
        description: The vulnerability this exception applies to
        type: string
        required: true
      scope:
        title: Scope ID
        description: The ID of the scope the vulnerability exception applies to.  May be empty if type is Global
        type: integer
        required: false
      expiration:
        title: Expiration
        description: The date the vulnerability exception expires
        type: date
        required: false
      comment:
        title: Comment
        description: Comment to include in the vulnerability exception submission
        type: string
        required: true
        default: Exception created with InsightConnect
      reason:
        title: Reason
        description: Reason for the exception
        type: string
        required: true
        enum:
        - False Positive
        - Compensating Control
        - Acceptable Use
        - Acceptable Risk
        - Other
      key:
        title: Vulnerability Key
        description: The key to identify a specific instance if the type is Instance
        type: string
        required: false
      port:
        title: Vulnerability Port
        description: The port the vulnerability appears on if the type is Instance
        type: integer
        required: false
    output:
      id:
        title: Created Exception ID
        description: The vulnerability exception that was created
        type: integer
        required: true
      links:
        title: Links
        description: Hypermedia links to corresponding or related resources
        type: '[]link'
        required: true
  get_vulnerability:
    title: Get Vulnerability Details
    description: Get the details of a specific vulnerability by id
    input:
      id:
        title: Vulnerability ID
        description: The identifier of the vulnerability to retrieve from InsightVM
        type: string
        required: true
    output:
      vulnerability:
        title: Vulnerability Details
        description: The details of the vulnerability requested
        type: vulnerability
        required: true
  get_asset_group_assets:
    title: Get Asset Group Assets
    description: Get asset group assets
    input:
      id:
        title: Asset Group ID
        description: Asset group ID
        type: integer
        required: true
    output:
      links:
        title: Links
        description: Hypermedia links to corresponding or related resources
        type: '[]link'
        required: true
      resources:
        title: Resources
        description: The identifiers of the associated resources
        type: '[]integer'
        required: false
triggers:
  new_scans:
    title: New Scans
    description: Check for new InsightVM scans by site and scan status
    input:
      frequency:
        title: Frequency
        description: How often the trigger should check for new scans in minutes
        type: integer
        required: true
        default: 5
      site_name_filter:
        title: Site Name Filter
        description: Regular expression to match sites where new scans should be triggered
        type: string
        required: true
        default: .*
      most_recent_scan:
        title: Most Recent Scan Only
        description: Only process the most recent scan for a site since the last time the trigger was run
        type: boolean
        required: true
        default: true
      status_filter:
        title: Status Filter
        description: 'List of scan statuses to match for trigger; options include: Aborted, Successful, Running, Stopped, Failed, Paused, Unknown'
        type: '[]string'
        required: false
        default: ['Successful']
    output:
      scan:
        title: Scan
        description: InsightVM Scan
        type: scan
        required: false
  new_exception_request:
    title: New Vulnerability Exception
    description: Check for new InsightVM vulnerability exceptions
    input:
      frequency:
        title: Frequency
        description: How often the trigger should check for new vulnerability exception requests
        type: integer
        required: true
        default: 5
      status_filter:
        title: Status Filter
        description: 'List of vulnerability statuses to match against. Options include: Under Review and Approved'
        type: '[]string'
        required: false
        default: ['Under Review']
    output:
      exception:
        title: Vulnerability Exception
        description: InsightVM vulnerability exception
        type: vulnerability_exception
        required: false
Other plugins
McAfee Advanced Threat Defense
Rapid7   |   v1.5.0
Plugin
Get
Ivanti Security Controls
Rapid7   |   v1.3.0
Plugin
Get
Base64
Rapid7   |   v1.1.5
Plugin
Get
Fortinet FortiGate
Rapid7   |   v4.0.2
Plugin
Get
Jira
Rapid7   |   v6.0.0
Plugin
Get