Work with your InsightVM security console: assets, sites, scans, reports, tags, vulnerabilities, exceptions, policies and users.
Explore 271 workflow actions for Rapid7 InsightVM, including account permissions and operation limits.
155 read actions116 write actions
WORKFLOW ACTIONS
What you can configure.
Choose an action in the workflow builder, connect an account, and map its inputs. These actions are available in the catalog; your account access and a successful test determine whether they work for your setup.
Add asset group tag
Write
Adds a tag to an asset group.
Permissions and limits
Account permissions
A security console user with the needed privileges
A repeated request may repeat the external action. Review the previous result before retrying a write.
Add asset group user
Write
Grants a user with sufficient privileges access to the asset group.
Permissions and limits
Account permissions
A security console user with the needed privileges
A repeated request may repeat the external action. Review the previous result before retrying a write.
Add asset tag
Write
Assigns the specified tag to the asset.
Permissions and limits
Account permissions
A security console user with the needed privileges
A repeated request may repeat the external action. Review the previous result before retrying a write.
Add asset to asset group
Write
Adds an asset to a static asset group.
Permissions and limits
Account permissions
A security console user with the needed privileges
A repeated request may repeat the external action. Review the previous result before retrying a write.
Add excluded targets
Write
Adds one or more addresses to the site's list of excluded scan targets.
Permissions and limits
Account permissions
A security console user with the needed privileges
A repeated request may repeat the external action. Review the previous result before retrying a write.
Add included targets
Write
Adds one or more addresses to the site's list of included scan targets.
Permissions and limits
Account permissions
A security console user with the needed privileges
A repeated request may repeat the external action. Review the previous result before retrying a write.
Add scan engine pool scan engine
Write
Add an engine to the engine pool.
Permissions and limits
Account permissions
A security console user with the needed privileges
A repeated request may repeat the external action. Review the previous result before retrying a write.
Add site tag
Write
Adds a tag to the site.
Permissions and limits
Account permissions
A security console user with the needed privileges
A repeated request may repeat the external action. Review the previous result before retrying a write.
Add site user
Write
Grants a non-administrator user access to the specified site.
Permissions and limits
Account permissions
A security console user with the needed privileges
A repeated request may repeat the external action. Review the previous result before retrying a write.
Add user asset group
Write
Grants the user access to the asset group.
Permissions and limits
Account permissions
A security console user with the needed privileges
A repeated request may repeat the external action. Review the previous result before retrying a write.
Add user site
Write
Grants the user access to the site.
Permissions and limits
Account permissions
A security console user with the needed privileges
A repeated request may repeat the external action. Review the previous result before retrying a write.
Create asset
Write
Creates or updates an asset with the specified details.
Permissions and limits
Account permissions
A security console user with the needed privileges
A repeated request may repeat the external action. Review the previous result before retrying a write.
Create asset group
Write
Creates a new asset group.
Permissions and limits
Account permissions
A security console user with the needed privileges
A repeated request may repeat the external action. Review the previous result before retrying a write.
Create policy override
Write
Submit a policy override.
Permissions and limits
Account permissions
A security console user with the needed privileges
A repeated request may repeat the external action. Review the previous result before retrying a write.
Create report
Write
Configures a new report for generation.
Permissions and limits
Account permissions
A security console user with the needed privileges
A repeated request may repeat the external action. Review the previous result before retrying a write.
Create scan engine
Write
Creates a new scan engine.
Permissions and limits
Account permissions
A security console user with the needed privileges
A repeated request may repeat the external action. Review the previous result before retrying a write.
Create scan engine pool
Write
Creates a new engine pool.
Permissions and limits
Account permissions
A security console user with the needed privileges
A repeated request may repeat the external action. Review the previous result before retrying a write.
Create scan template
Write
Creates a new scan template.
Permissions and limits
Account permissions
A security console user with the needed privileges
A repeated request may repeat the external action. Review the previous result before retrying a write.
Create site
Write
Creates a new site with the specified configuration.
Permissions and limits
Account permissions
A security console user with the needed privileges
A repeated request may repeat the external action. Review the previous result before retrying a write.
Create site scan schedule
Write
Creates a new scan schedule for the specified site.
Permissions and limits
Account permissions
A security console user with the needed privileges
A repeated request may repeat the external action. Review the previous result before retrying a write.
Create site syslog alert
Write
Creates a new Syslog alert for the specified site.
Permissions and limits
Account permissions
A security console user with the needed privileges
A repeated request may repeat the external action. Review the previous result before retrying a write.
Create sonar query
Read
Creates a sonar query.
Permissions and limits
Account permissions
A security console user with the needed privileges
Create tag
Write
Creates a new tag.
Permissions and limits
Account permissions
A security console user with the needed privileges
A repeated request may repeat the external action. Review the previous result before retrying a write.
Create vulnerability exception
Write
Creates a vulnerability exception.
Permissions and limits
Account permissions
A security console user with the needed privileges
A repeated request may repeat the external action. Review the previous result before retrying a write.
Create vulnerability validation
Write
Creates a vulnerability validation for a vulnerability on an asset.
Permissions and limits
Account permissions
A security console user with the needed privileges
A repeated request may repeat the external action. Review the previous result before retrying a write.
Delete all site alerts
Write
Deletes all alerts from the site.
Permissions and limits
Account permissions
A security console user with the needed privileges
A repeated request may repeat the external action. Review the previous result before retrying a write.
Delete all site scan schedules
Write
Deletes all scan schedules from the site.
Permissions and limits
Account permissions
A security console user with the needed privileges
A repeated request may repeat the external action. Review the previous result before retrying a write.
Delete all site syslog alerts
Write
Deletes all Syslog alerts from the site.
Permissions and limits
Account permissions
A security console user with the needed privileges
A repeated request may repeat the external action. Review the previous result before retrying a write.
Delete asset
Write
Deletes the specified asset.
Permissions and limits
Account permissions
A security console user with the needed privileges
A repeated request may repeat the external action. Review the previous result before retrying a write.
Delete asset group
Write
Deletes the asset group.
Permissions and limits
Account permissions
A security console user with the needed privileges
A repeated request may repeat the external action. Review the previous result before retrying a write.
Delete policy override
Write
Removes a policy override created for a policy rule.
Permissions and limits
Account permissions
A security console user with the needed privileges
A repeated request may repeat the external action. Review the previous result before retrying a write.
Delete report
Write
Deletes the configuration of a report.
Permissions and limits
Account permissions
A security console user with the needed privileges
A repeated request may repeat the external action. Review the previous result before retrying a write.
Delete report instance
Write
Deletes an instance of a generated report.
Permissions and limits
Account permissions
A security console user with the needed privileges
A repeated request may repeat the external action. Review the previous result before retrying a write.
Delete scan engine
Write
Deletes the specified scan engine.
Permissions and limits
Account permissions
A security console user with the needed privileges
A repeated request may repeat the external action. Review the previous result before retrying a write.
Delete scan template
Write
Deletes a scan template.
Permissions and limits
Account permissions
A security console user with the needed privileges
A repeated request may repeat the external action. Review the previous result before retrying a write.
Delete site
Write
Deletes the site with the specified identifier.
Permissions and limits
Account permissions
A security console user with the needed privileges
A repeated request may repeat the external action. Review the previous result before retrying a write.
Delete site scan schedule
Write
Deletes the specified scan schedule from the site.
Permissions and limits
Account permissions
A security console user with the needed privileges
A repeated request may repeat the external action. Review the previous result before retrying a write.
Delete site syslog alert
Write
Deletes the specified Syslog alert from the site.
Permissions and limits
Account permissions
A security console user with the needed privileges
A repeated request may repeat the external action. Review the previous result before retrying a write.
Delete sonar query
Write
Removes a sonar query.
Permissions and limits
Account permissions
A security console user with the needed privileges
A repeated request may repeat the external action. Review the previous result before retrying a write.
Delete tag
Write
Deletes the tag.
Permissions and limits
Account permissions
A security console user with the needed privileges
A repeated request may repeat the external action. Review the previous result before retrying a write.
Delete user
Write
Deletes a user account.
Permissions and limits
Account permissions
A security console user with the needed privileges
A repeated request may repeat the external action. Review the previous result before retrying a write.
Delete vulnerability validation
Write
Removes a vulnerability validation for a vulnerability from an asset.
Permissions and limits
Account permissions
A security console user with the needed privileges
A repeated request may repeat the external action. Review the previous result before retrying a write.
Find assets
Read
Returns all assets for which you have access that match the given search criteria.
Permissions and limits
Account permissions
A security console user with the needed privileges
Generate report
Write
Generates a configured report and returns the instance identifier of the report.
Permissions and limits
Account permissions
A security console user with the needed privileges
A repeated request may repeat the external action. Review the previous result before retrying a write.
Get affected assets
Read
Get the assets affected by the vulnerability.
Permissions and limits
Account permissions
A security console user with the needed privileges
Get agents
Read
Returns the details for all agents.
Permissions and limits
Account permissions
A security console user with the needed privileges
Get asset
Read
Returns the specified asset.
Permissions and limits
Account permissions
A security console user with the needed privileges
Get asset databases
Read
Returns the databases enumerated on an asset.
Permissions and limits
Account permissions
A security console user with the needed privileges
Get asset files
Read
Returns the files discovered on an asset.
Permissions and limits
Account permissions
A security console user with the needed privileges
Get asset group
Read
Returns an asset group.
Permissions and limits
Account permissions
A security console user with the needed privileges
Get asset group assets
Read
Returns hypermedia links for the assets that belong to an asset group.
Permissions and limits
Account permissions
A security console user with the needed privileges
Get asset group search criteria
Read
Returns the search criteria of a dynamic asset group.For a reference of valid search criteria input see the Asset Search resource.
Permissions and limits
Account permissions
A security console user with the needed privileges
Get asset group tags
Read
Returns the tags assigned to an asset group.
Permissions and limits
Account permissions
A security console user with the needed privileges
Get asset group users
Read
Returns hypermedia links for the users with access to this asset group.
Permissions and limits
Account permissions
A security console user with the needed privileges
Get asset groups
Read
Returns all asset groups.
Permissions and limits
Account permissions
A security console user with the needed privileges
Get asset policy children
Read
Retrieves a paged resource of either policy rules, or groups, that are defined directly underneath the specified policy with rule compliance results for the specified asset.
Permissions and limits
Account permissions
A security console user with the needed privileges
Get asset policy group children
Read
Retrieves a paged resource of either policy rules, or groups, that are defined directly underneath the specified policy group with rule compliance results for the specified asset.
Permissions and limits
Account permissions
A security console user with the needed privileges
Get asset policy overrides
Read
Retrieves policy overrides defined on policy rules for the specified asset.
Permissions and limits
Account permissions
A security console user with the needed privileges
Get asset policy rules summary
Read
Retrieves the list of policy rules with compliance results for the specified asset and policy.
Permissions and limits
Account permissions
A security console user with the needed privileges
Get asset service
Read
Returns the service running a port and protocol on the asset.
Permissions and limits
Account permissions
A security console user with the needed privileges
Get asset service configurations
Read
Returns the configuration (properties) of a port and protocol on an asset.
Permissions and limits
Account permissions
A security console user with the needed privileges
Get asset service databases
Read
Returns the databases running on a port and protocol on an asset.
Permissions and limits
Account permissions
A security console user with the needed privileges
Get asset service user groups
Read
Returns the user groups enumerated on a port and protocol on an asset.
Permissions and limits
Account permissions
A security console user with the needed privileges
Get asset service users
Read
Returns the users enumerated on a port and protocol on an asset.
Permissions and limits
Account permissions
A security console user with the needed privileges
Get asset service vulnerabilities
Read
Retrieves the vulnerabilities present on a service running on an asset.
Permissions and limits
Account permissions
A security console user with the needed privileges
Get asset service web applications
Read
Returns the web applications running on a port and protocol on an asset.
Permissions and limits
Account permissions
A security console user with the needed privileges
Get asset services
Read
Returns the services discovered on an asset.
Permissions and limits
Account permissions
A security console user with the needed privileges
Get asset software
Read
Returns the software on an asset.
Permissions and limits
Account permissions
A security console user with the needed privileges
Get asset tags
Read
Returns tags assigned to an asset.
Permissions and limits
Account permissions
A security console user with the needed privileges
Get asset user groups
Read
Returns user groups enumerated on an asset.
Permissions and limits
Account permissions
A security console user with the needed privileges
Get asset users
Read
Returns users enumerated on an asset.
Permissions and limits
Account permissions
A security console user with the needed privileges
Get asset vulnerabilities
Read
Retrieves all vulnerability findings on an asset.
Permissions and limits
Account permissions
A security console user with the needed privileges
Get asset vulnerability
Read
Retrieves the details for a vulnerability finding on an asset.
Permissions and limits
Account permissions
A security console user with the needed privileges
Get asset vulnerability solutions
Read
Returns the highest-superceding rollup solutions for a vulnerability on an asset.
Permissions and limits
Account permissions
A security console user with the needed privileges
Get assets
Read
Returns all assets for which you have access.
Permissions and limits
Account permissions
A security console user with the needed privileges
Get assigned engine pools
Read
Retrieves the list of engine pools the scan engine is currently assigned to.
Permissions and limits
Account permissions
A security console user with the needed privileges
Get authentication sources
Read
Returns all available sources of authentication for users.
Permissions and limits
Account permissions
A security console user with the needed privileges
Get descendant policy rules
Read
Retrieves the list of policy rules defined directly, or indirectly, underneath the specified policy group.
Permissions and limits
Account permissions
A security console user with the needed privileges
Get disabled policy rules
Read
Retrieves a paged resource of disabled policy rules for the specified policy.
Permissions and limits
Account permissions
A security console user with the needed privileges
Get discovery connection
Read
Returns a discovery connection.
Permissions and limits
Account permissions
A security console user with the needed privileges
Get discovery connections
Read
Returns all discovery connections.
Permissions and limits
Account permissions
A security console user with the needed privileges
Get engine pool
Read
Retrieves the details for an engine pool.
Permissions and limits
Account permissions
A security console user with the needed privileges
Get excluded asset groups
Read
Retrieves the excluded asset groups in a static site.
Permissions and limits
Account permissions
A security console user with the needed privileges
Get excluded targets
Read
Retrieves the excluded targets in a static site.
Permissions and limits
Account permissions
A security console user with the needed privileges
Get exploit
Read
Returns the details for an exploit.
Permissions and limits
Account permissions
A security console user with the needed privileges
Get exploit vulnerabilities
Read
Returns the vulnerabilities exploitable to a exploit.
Permissions and limits
Account permissions
A security console user with the needed privileges
Get exploits
Read
Returns all known exploits.
Permissions and limits
Account permissions
A security console user with the needed privileges
Get included asset groups
Read
Retrieves the included asset groups in a static site.
Permissions and limits
Account permissions
A security console user with the needed privileges
Get included targets
Read
Retrieves the included targets in a static site.
Permissions and limits
Account permissions
A security console user with the needed privileges
Get info
Read
Returns system details, including host and version information.
Permissions and limits
Account permissions
A security console user with the needed privileges
Get license
Read
Returns the enabled features and limits of the current license.
Permissions and limits
Account permissions
A security console user with the needed privileges
Get malware kit
Read
Returns the details for a malware kit.
Permissions and limits
Account permissions
A security console user with the needed privileges
Get malware kit vulnerabilities
Read
Returns the vulnerabilities that are susceptible to being attacked by a malware kit.
Permissions and limits
Account permissions
A security console user with the needed privileges
Get malware kits
Read
Returns all known malware kits.
Permissions and limits
Account permissions
A security console user with the needed privileges
Get operating system
Read
Returns the details for an operating system.
Permissions and limits
Account permissions
A security console user with the needed privileges
Get operating systems
Read
Returns all operating systems discovered across all assets.
Permissions and limits
Account permissions
A security console user with the needed privileges
Get policies
Read
Retrieves a paged resource of policies.
Permissions and limits
Account permissions
A security console user with the needed privileges
Get policies for asset
Read
Retrieves the list of policies with compliance results for the specified asset.
Permissions and limits
Account permissions
A security console user with the needed privileges
Get policy
Read
Retrieves the specified policy.
Permissions and limits
Account permissions
A security console user with the needed privileges
Get policy asset result
Read
Retrieves an asset resource with rule compliance results for the specified asset and policy.
Permissions and limits
Account permissions
A security console user with the needed privileges
Get policy asset results
Read
Retrieves asset resources with rule compliance results for the specified policy.
Permissions and limits
Account permissions
A security console user with the needed privileges
Get policy children
Read
Retrieves a paged resource of either policy rules, or groups, that are defined directly underneath the specified policy.
Permissions and limits
Account permissions
A security console user with the needed privileges
Get policy group
Read
Retrieves the specified policy group.
Permissions and limits
Account permissions
A security console user with the needed privileges
Get policy group asset result
Read
Retrieves an asset resource with rule compliance status against all rules under the specified policy group.
Permissions and limits
Account permissions
A security console user with the needed privileges
Get policy group asset results
Read
Retrieves asset resources with rule compliance status against all rules under the specified policy group.
Permissions and limits
Account permissions
A security console user with the needed privileges
Get policy group children
Read
Retrieves a paged resource of either policy rules, or groups, that are defined directly underneath the specified policy group.
Permissions and limits
Account permissions
A security console user with the needed privileges
Get policy group rules with asset assessment
Read
Retrieves the list of policy rules defined directly, or indirectly, underneath the specified policy group and the compliance results for the specified asset.
Permissions and limits
Account permissions
A security console user with the needed privileges
Get policy groups
Read
Retrieves a paged resource of policy groups for the specified policy.
Permissions and limits
Account permissions
A security console user with the needed privileges
Get policy override
Read
Retrieve the specified policy override.
Permissions and limits
Account permissions
A security console user with the needed privileges
Get policy overrides
Read
Retrieves policy overrides defined on policy rules.
Permissions and limits
Account permissions
A security console user with the needed privileges
Get policy rule
Read
Retrieves the specified policy rule.
Permissions and limits
Account permissions
A security console user with the needed privileges
Get policy rule asset result
Read
Retrieves an asset resource with rule compliance results for the specified policy policy rule.
Permissions and limits
Account permissions
A security console user with the needed privileges
Get policy rule asset results
Read
Retrieves asset resources with rule compliance results for the specified policy policy rule.
Permissions and limits
Account permissions
A security console user with the needed privileges
Get policy rule controls
Read
Retrieves all NIST SP 800-53 controls mappings for each CCE within the specified policy rule.
Permissions and limits
Account permissions
A security console user with the needed privileges
Get policy rules
Read
Retrieves a paged resource of policy rules for the specified policy.
Permissions and limits
Account permissions
A security console user with the needed privileges
Get policy summary
Read
Retrieves a compliance summary of all policies.
Permissions and limits
Account permissions
A security console user with the needed privileges
Get prerequisite solutions
Read
Returns the solutions that must be executed in order for a solution to resolve a vulnerability.
Permissions and limits
Account permissions
A security console user with the needed privileges
Get privileges
Read
Returns all privileges that may be granted to a role.
Permissions and limits
Account permissions
A security console user with the needed privileges
Get properties
Read
Returns system details, including host and version information.
Permissions and limits
Account permissions
A security console user with the needed privileges
Get report
Read
Returns the configuration details of a report.
Permissions and limits
Account permissions
A security console user with the needed privileges
Get report formats
Read
Returns all available report formats.
Permissions and limits
Account permissions
A security console user with the needed privileges
Get report instance
Read
Returns the details for a generation of the report.
Permissions and limits
Account permissions
A security console user with the needed privileges
Get report instances
Read
Returns all historical details for generation of the report over time.
Permissions and limits
Account permissions
A security console user with the needed privileges
Get report template
Read
Returns the details of a report template.
Permissions and limits
Account permissions
A security console user with the needed privileges
Get report templates
Read
Returns all available report templates.
Permissions and limits
Account permissions
A security console user with the needed privileges
Get reports
Read
Returns all defined report configurations.
Permissions and limits
Account permissions
A security console user with the needed privileges
Get roles
Read
Returns all roles for which users may be assigned.
Permissions and limits
Account permissions
A security console user with the needed privileges
Get scan
Read
Returns the specified scan.
Permissions and limits
Account permissions
A security console user with the needed privileges
Get scan engine
Read
Retrieves the details for a scan engine.
Permissions and limits
Account permissions
A security console user with the needed privileges
Get scan engine pool scan engines
Read
Get the engines in the engine pool.
Permissions and limits
Account permissions
A security console user with the needed privileges
Get scan engine pool sites
Read
Returns links to the sites associated with this engine pool.
Permissions and limits
Account permissions
A security console user with the needed privileges
Get scan engine pools
Read
Returns engine pools available to use for scanning.
Permissions and limits
Account permissions
A security console user with the needed privileges
Get scan engine scans
Read
Returns the scans that have been run on a scan engine.
Permissions and limits
Account permissions
A security console user with the needed privileges
Get scan engine sites
Read
Retrieves the list of sites the specified scan engine is assigned to.
Permissions and limits
Account permissions
A security console user with the needed privileges
Get scan engines
Read
Returns scan engines available to use for scanning.
Permissions and limits
Account permissions
A security console user with the needed privileges
Get scan template
Read
Returns a scan template.
Permissions and limits
Account permissions
A security console user with the needed privileges
Get scan templates
Read
Returns all scan templates.
Permissions and limits
Account permissions
A security console user with the needed privileges
Get scans
Read
Returns all scans.
Permissions and limits
Account permissions
A security console user with the needed privileges
Get settings
Read
Returns the current administration settings.
Permissions and limits
Account permissions
A security console user with the needed privileges
Get site
Read
Retrieves the site with the specified identifier.
Permissions and limits
Account permissions
A security console user with the needed privileges
Get site alerts
Read
Retrieve all alerts defined in the site.
Permissions and limits
Account permissions
A security console user with the needed privileges
Get site assets
Read
Retrieves a paged resource of assets linked with the specified site.
Permissions and limits
Account permissions
A security console user with the needed privileges
Get site discovery connection
Read
Retrieves the discovery connection assigned to the site.
Permissions and limits
Account permissions
A security console user with the needed privileges
Get site discovery search criteria
Read
Retrieve the search criteria of the dynamic site.
Permissions and limits
Account permissions
A security console user with the needed privileges
Get site organization
Read
Retrieves the site organization information.
Permissions and limits
Account permissions
A security console user with the needed privileges
Get site scan engine
Read
Retrieves the resource of the scan engine assigned to the site.
Permissions and limits
Account permissions
A security console user with the needed privileges
Get site scan schedule
Read
Retrieves the specified scan schedule.
Permissions and limits
Account permissions
A security console user with the needed privileges
Get site scan schedules
Read
Returns all scan schedules for the site.
Permissions and limits
Account permissions
A security console user with the needed privileges
Get site scan template
Read
Retrieves the resource of the scan template assigned to the site.
Permissions and limits
Account permissions
A security console user with the needed privileges
Get site scans
Read
Returns the scans for the specified site.
Permissions and limits
Account permissions
A security console user with the needed privileges
Get site syslog alert
Read
Retrieves the specified Syslog alert.
Permissions and limits
Account permissions
A security console user with the needed privileges
Get site syslog alerts
Read
Retrieves all Syslog alerts defined in the site.
Permissions and limits
Account permissions
A security console user with the needed privileges
Get site tags
Read
Retrieves the list of tags added to the sites.
Permissions and limits
Account permissions
A security console user with the needed privileges
Get site users
Read
Retrieve the list of non-administrator users that have access to the site.
Permissions and limits
Account permissions
A security console user with the needed privileges
Get sites
Read
Retrieves a paged resource of accessible sites.
Permissions and limits
Account permissions
A security console user with the needed privileges
Get software
Read
Returns the details for software.
Permissions and limits
Account permissions
A security console user with the needed privileges
Get softwares
Read
Returns all software enumerated on any asset.
Permissions and limits
Account permissions
A security console user with the needed privileges
Get solution
Read
Returns the details for a solution that can remediate one or more vulnerabilities.
Permissions and limits
Account permissions
A security console user with the needed privileges
Get solutions
Read
Returns the details for all solutions.
Permissions and limits
Account permissions
A security console user with the needed privileges
Get sonar queries
Read
Returns all sonar queries.
Permissions and limits
Account permissions
A security console user with the needed privileges
Get sonar query
Read
Returns a sonar query.
Permissions and limits
Account permissions
A security console user with the needed privileges
Get sonar query assets
Read
Returns the assets that are discovered by a Sonar query.
Permissions and limits
Account permissions
A security console user with the needed privileges
Get superseded solutions
Read
Returns the solutions that are superseded by this solution.
Permissions and limits
Account permissions
A security console user with the needed privileges
Get superseding solutions
Read
Returns the solutions that supersede this solution.
Permissions and limits
Account permissions
A security console user with the needed privileges
Get tag
Read
Returns a tag.
Permissions and limits
Account permissions
A security console user with the needed privileges
Get tag asset groups
Read
Returns the asset groups associated with the tag.
Permissions and limits
Account permissions
A security console user with the needed privileges
Get tag search criteria
Read
Returns the search criteria associated with the tag.
Permissions and limits
Account permissions
A security console user with the needed privileges
Get tagged assets
Read
Returns the assets tagged with a tag.
Permissions and limits
Account permissions
A security console user with the needed privileges
Get tagged sites
Read
Returns the sites associated with the tag.
Permissions and limits
Account permissions
A security console user with the needed privileges
Get tags
Read
Returns all tags.
Permissions and limits
Account permissions
A security console user with the needed privileges
Get user
Read
Returns the details for a user.
Permissions and limits
Account permissions
A security console user with the needed privileges
Get user asset groups
Read
Returns the asset groups to which the user has access.
Permissions and limits
Account permissions
A security console user with the needed privileges
Get user privileges
Read
Returns the privileges granted to the user by their role.
Permissions and limits
Account permissions
A security console user with the needed privileges
Get user sites
Read
Returns the sites to which the user has access.
Permissions and limits
Account permissions
A security console user with the needed privileges
Get users
Read
Returns all defined users.
Permissions and limits
Account permissions
A security console user with the needed privileges
Get users with privilege
Read
Returns hypermedia links for all users granted the specified privilege by their role.
Permissions and limits
Account permissions
A security console user with the needed privileges
Get vulnerabilities
Read
Returns all vulnerabilities that can be assessed during a scan.
Permissions and limits
Account permissions
A security console user with the needed privileges
Get vulnerability
Read
Returns the details for a vulnerability.
Permissions and limits
Account permissions
A security console user with the needed privileges
Get vulnerability categories
Read
Returns all vulnerabilities categories that can be assigned to a vulnerability.
Permissions and limits
Account permissions
A security console user with the needed privileges
Get vulnerability category
Read
Returns the details for a vulnerability category.
Permissions and limits
Account permissions
A security console user with the needed privileges
Get vulnerability category vulnerabilities
Read
Returns hypermedia links to the vulnerabilities that are in a vulnerability category.
Permissions and limits
Account permissions
A security console user with the needed privileges
Get vulnerability check types
Read
Returns the vulnerability check types.
Permissions and limits
Account permissions
A security console user with the needed privileges
Get vulnerability checks
Read
Returns vulnerability checks.
Permissions and limits
Account permissions
A security console user with the needed privileges
Get vulnerability checks for vulnerability
Read
Returns the vulnerability checks that assess for a specific vulnerability during a scan.
Permissions and limits
Account permissions
A security console user with the needed privileges
Get vulnerability exception
Read
Returns an exception made on a vulnerability.
Permissions and limits
Account permissions
A security console user with the needed privileges
Get vulnerability exceptions
Read
Returns all exceptions defined on vulnerabilities.
Permissions and limits
Account permissions
A security console user with the needed privileges
Get vulnerability exploits
Read
Returns the exploits that can be used to exploit a vulnerability.
Permissions and limits
Account permissions
A security console user with the needed privileges
Get vulnerability malware kits
Read
Returns the malware kits that are known to be used to exploit the vulnerability.
Permissions and limits
Account permissions
A security console user with the needed privileges
Get vulnerability reference
Read
Returns an external vulnerability reference.
Permissions and limits
Account permissions
A security console user with the needed privileges
Get vulnerability reference vulnerabilities
Read
Returns the vulnerabilities that are referenced by an external reference.
Permissions and limits
Account permissions
A security console user with the needed privileges
Get vulnerability references
Read
Returns the external references that may be associated to a vulnerability.
Permissions and limits
Account permissions
A security console user with the needed privileges
Get vulnerability references 1
Read
Returns the external references that may be associated to a vulnerability.
Permissions and limits
Account permissions
A security console user with the needed privileges
Get vulnerability solutions
Read
Returns all solutions (across all platforms) that may be used to remediate this vulnerability.
Permissions and limits
Account permissions
A security console user with the needed privileges
Get vulnerability validation
Read
Returns a vulnerability validation for a vulnerability on an asset.
Permissions and limits
Account permissions
A security console user with the needed privileges
Get vulnerability validations
Read
Returns all vulnerability validations for a vulnerability on an asset.
Permissions and limits
Account permissions
A security console user with the needed privileges
Reconnect discovery connection
Write
Attempts to reconnect the discovery connection.
Permissions and limits
Account permissions
A security console user with the needed privileges
A repeated request may repeat the external action. Review the previous result before retrying a write.
Remove all asset group tags
Write
Removes all tag associations from the asset group.
Permissions and limits
Account permissions
A security console user with the needed privileges
A repeated request may repeat the external action. Review the previous result before retrying a write.
Remove all assets from asset group
Write
Removes the assets from the given static asset group.
Permissions and limits
Account permissions
A security console user with the needed privileges
A repeated request may repeat the external action. Review the previous result before retrying a write.
Remove all excluded asset groups
Write
Removes all excluded asset groups from the specified static site.
Permissions and limits
Account permissions
A security console user with the needed privileges
A repeated request may repeat the external action. Review the previous result before retrying a write.
Remove all included asset groups
Write
Removes all included asset groups from the specified static site.
Permissions and limits
Account permissions
A security console user with the needed privileges
A repeated request may repeat the external action. Review the previous result before retrying a write.
Remove all user asset groups
Write
Revokes access to all asset groups from the user.
Permissions and limits
Account permissions
A security console user with the needed privileges
A repeated request may repeat the external action. Review the previous result before retrying a write.
Remove all user sites
Write
Revokes access to all sites from the user.
Permissions and limits
Account permissions
A security console user with the needed privileges
A repeated request may repeat the external action. Review the previous result before retrying a write.
Remove asset from asset group
Write
Removes an asset from an asset group.
Permissions and limits
Account permissions
A security console user with the needed privileges
A repeated request may repeat the external action. Review the previous result before retrying a write.
Remove asset from site
Write
Removes an asset from a site.
Permissions and limits
Account permissions
A security console user with the needed privileges
A repeated request may repeat the external action. Review the previous result before retrying a write.
Remove asset group tag
Write
Removes a tag from an asset group.
Permissions and limits
Account permissions
A security console user with the needed privileges
A repeated request may repeat the external action. Review the previous result before retrying a write.
Remove asset group user
Write
Removes a user's access from an asset group.
Permissions and limits
Account permissions
A security console user with the needed privileges
A repeated request may repeat the external action. Review the previous result before retrying a write.
Remove asset tag
Write
Removes the specified tag from the asset's tags.
Permissions and limits
Account permissions
A security console user with the needed privileges
A repeated request may repeat the external action. Review the previous result before retrying a write.
Remove excluded asset group
Write
Removes the specified asset group from the excluded asset groups configured in the static site.
Permissions and limits
Account permissions
A security console user with the needed privileges
A repeated request may repeat the external action. Review the previous result before retrying a write.
Remove excluded targets
Write
Removes one or more addresses from the site's list of excluded scan targets.
Permissions and limits
Account permissions
A security console user with the needed privileges
A repeated request may repeat the external action. Review the previous result before retrying a write.
Remove included asset group
Write
Removes the specified asset group from the included asset groups configured in the static site.
Permissions and limits
Account permissions
A security console user with the needed privileges
A repeated request may repeat the external action. Review the previous result before retrying a write.
Remove included targets
Write
Removes one or more addresses from the site's list of included scan targets.
Permissions and limits
Account permissions
A security console user with the needed privileges
A repeated request may repeat the external action. Review the previous result before retrying a write.
Remove scan engine pool
Write
Deletes the specified engine pool.
Permissions and limits
Account permissions
A security console user with the needed privileges
A repeated request may repeat the external action. Review the previous result before retrying a write.
Remove scan engine pool scan engine
Write
Remove the specified engine from the engine pool.
Permissions and limits
Account permissions
A security console user with the needed privileges
A repeated request may repeat the external action. Review the previous result before retrying a write.
Remove site assets
Write
Removes all assets from the specified site.
Permissions and limits
Account permissions
A security console user with the needed privileges
A repeated request may repeat the external action. Review the previous result before retrying a write.
Remove site tag
Write
Removes the specified tag from the site's tags.
Permissions and limits
Account permissions
A security console user with the needed privileges
A repeated request may repeat the external action. Review the previous result before retrying a write.
Remove site user
Write
Removes the specified user from the site's access list.
Permissions and limits
Account permissions
A security console user with the needed privileges
A repeated request may repeat the external action. Review the previous result before retrying a write.
Remove tag search criteria
Write
Removes the search criteria associated with the tag.
Permissions and limits
Account permissions
A security console user with the needed privileges
A repeated request may repeat the external action. Review the previous result before retrying a write.
Remove tagged sites
Write
Removes the associations between the tag and the sites.
Permissions and limits
Account permissions
A security console user with the needed privileges
A repeated request may repeat the external action. Review the previous result before retrying a write.
Remove user asset group
Write
Grants the user access to the asset group.
Permissions and limits
Account permissions
A security console user with the needed privileges
A repeated request may repeat the external action. Review the previous result before retrying a write.
Remove user site
Write
Grants the user access to the site.
Permissions and limits
Account permissions
A security console user with the needed privileges
A repeated request may repeat the external action. Review the previous result before retrying a write.
Remove vulnerability exception
Write
Removes an exception made on a vulnerability.
Permissions and limits
Account permissions
A security console user with the needed privileges
A repeated request may repeat the external action. Review the previous result before retrying a write.
Set asset group search criteria
Write
Updates the search criteria of a dynamic asset group.
Permissions and limits
Account permissions
A security console user with the needed privileges
A repeated request may repeat the external action. Review the previous result before retrying a write.
Set asset group tags
Write
Updates the tags of an asset group.
Permissions and limits
Account permissions
A security console user with the needed privileges
A repeated request may repeat the external action. Review the previous result before retrying a write.
Set asset group users
Write
Grants users with sufficient privileges access to an asset group.
Permissions and limits
Account permissions
A security console user with the needed privileges
A repeated request may repeat the external action. Review the previous result before retrying a write.
Set policy override expiration
Write
Set the expiration date for a policy override.
Permissions and limits
Account permissions
A security console user with the needed privileges
A repeated request may repeat the external action. Review the previous result before retrying a write.
Set policy override status
Write
Update the status of the specified policy override.
Permissions and limits
Account permissions
A security console user with the needed privileges
A repeated request may repeat the external action. Review the previous result before retrying a write.
Set scan engine pool scan engines
Write
Set the engines in the engine pool.
Permissions and limits
Account permissions
A security console user with the needed privileges
A repeated request may repeat the external action. Review the previous result before retrying a write.
Set scan status
Write
Updates the scan status.
Permissions and limits
Account permissions
A security console user with the needed privileges
A repeated request may repeat the external action. Review the previous result before retrying a write.
Set site discovery connection
Write
Updates the discovery connection assigned to the site.
Permissions and limits
Account permissions
A security console user with the needed privileges
A repeated request may repeat the external action. Review the previous result before retrying a write.
Set site discovery search criteria
Write
Update the search criteria of the dynamic site.
Permissions and limits
Account permissions
A security console user with the needed privileges
A repeated request may repeat the external action. Review the previous result before retrying a write.
Set site scan engine
Write
Updates the assigned scan engine to the site.
Permissions and limits
Account permissions
A security console user with the needed privileges
A repeated request may repeat the external action. Review the previous result before retrying a write.
Set site scan schedules
Write
Updates all scan schedules for the specified site in a single request using the array of resources defined in the request body.
Permissions and limits
Account permissions
A security console user with the needed privileges
A repeated request may repeat the external action. Review the previous result before retrying a write.
Set site scan template
Write
Updates the assigned scan template to the site.
Permissions and limits
Account permissions
A security console user with the needed privileges
A repeated request may repeat the external action. Review the previous result before retrying a write.
Set site syslog alerts
Write
Updates all Syslog alerts for the specified site in a single request using the array of resources defined in the request body.
Permissions and limits
Account permissions
A security console user with the needed privileges
A repeated request may repeat the external action. Review the previous result before retrying a write.
Set site tags
Write
Updates the site's list of tags.
Permissions and limits
Account permissions
A security console user with the needed privileges
A repeated request may repeat the external action. Review the previous result before retrying a write.
Set site users
Write
Updates the site's access list.
Permissions and limits
Account permissions
A security console user with the needed privileges
A repeated request may repeat the external action. Review the previous result before retrying a write.
Set tagged asset groups
Write
Sets the asset groups associated with the tag.
Permissions and limits
Account permissions
A security console user with the needed privileges
A repeated request may repeat the external action. Review the previous result before retrying a write.
Set tagged sites
Write
Sets the sites associated with the tag.
Permissions and limits
Account permissions
A security console user with the needed privileges
A repeated request may repeat the external action. Review the previous result before retrying a write.
Set user asset groups
Write
Updates the asset groups to which the user has access.
Permissions and limits
Account permissions
A security console user with the needed privileges
A repeated request may repeat the external action. Review the previous result before retrying a write.
Set user sites
Write
Updates the sites to which the user has access.
Permissions and limits
Account permissions
A security console user with the needed privileges
A repeated request may repeat the external action. Review the previous result before retrying a write.
Sonar query search
Read
Executes a Sonar query to discover assets with the given search criteria.
Permissions and limits
Account permissions
A security console user with the needed privileges
Start scan
Write
Starts a scan for the specified site.
Permissions and limits
Account permissions
A security console user with the needed privileges
A repeated request may repeat the external action. Review the previous result before retrying a write.
Tag asset
Write
Adds an asset to the tag.
Permissions and limits
Account permissions
A security console user with the needed privileges
A repeated request may repeat the external action. Review the previous result before retrying a write.
Tag asset group
Write
Adds an asset group to this tag.
Permissions and limits
Account permissions
A security console user with the needed privileges
A repeated request may repeat the external action. Review the previous result before retrying a write.
Tag site
Write
Adds a site to this tag.
Permissions and limits
Account permissions
A security console user with the needed privileges
A repeated request may repeat the external action. Review the previous result before retrying a write.
Unlock user
Write
Unlocks a locked user account that has too many failed authentication attempts.
Permissions and limits
Account permissions
A security console user with the needed privileges
A repeated request may repeat the external action. Review the previous result before retrying a write.
Untag all asset groups
Write
Removes the associations between the tag and all asset groups.
Permissions and limits
Account permissions
A security console user with the needed privileges
A repeated request may repeat the external action. Review the previous result before retrying a write.
Untag asset
Write
Removes an asset from the tag.
Permissions and limits
Account permissions
A security console user with the needed privileges
A repeated request may repeat the external action. Review the previous result before retrying a write.
Untag asset group
Write
Removes an asset group from this tag.
Permissions and limits
Account permissions
A security console user with the needed privileges
A repeated request may repeat the external action. Review the previous result before retrying a write.
Untag site
Write
Removes a site from this tag.
Permissions and limits
Account permissions
A security console user with the needed privileges
A repeated request may repeat the external action. Review the previous result before retrying a write.
Update asset group
Write
Updates the details of an asset group.
Permissions and limits
Account permissions
A security console user with the needed privileges
A repeated request may repeat the external action. Review the previous result before retrying a write.
Update asset group assets
Write
Updates all the assets that belong to a static asset group.
Permissions and limits
Account permissions
A security console user with the needed privileges
A repeated request may repeat the external action. Review the previous result before retrying a write.
Update excluded asset groups
Write
Updates the excluded asset groups in a static site.
Permissions and limits
Account permissions
A security console user with the needed privileges
A repeated request may repeat the external action. Review the previous result before retrying a write.
Update excluded targets
Write
Updates the excluded targets in a static site.
Permissions and limits
Account permissions
A security console user with the needed privileges
A repeated request may repeat the external action. Review the previous result before retrying a write.
Update included asset groups
Write
Updates the included asset groups in a static site.
Permissions and limits
Account permissions
A security console user with the needed privileges
A repeated request may repeat the external action. Review the previous result before retrying a write.
Update included targets
Write
Updates the included targets in a static site.
Permissions and limits
Account permissions
A security console user with the needed privileges
A repeated request may repeat the external action. Review the previous result before retrying a write.
Update report
Write
Updates the configuration details of a report.
Permissions and limits
Account permissions
A security console user with the needed privileges
A repeated request may repeat the external action. Review the previous result before retrying a write.
Update scan engine
Write
Updates the specified scan engine.
Permissions and limits
Account permissions
A security console user with the needed privileges
A repeated request may repeat the external action. Review the previous result before retrying a write.
Update scan engine pool
Write
Updates the specified engine pool.
Permissions and limits
Account permissions
A security console user with the needed privileges
A repeated request may repeat the external action. Review the previous result before retrying a write.
Update scan template
Write
Updates a scan template.
Permissions and limits
Account permissions
A security console user with the needed privileges
A repeated request may repeat the external action. Review the previous result before retrying a write.
Update site
Write
Updates the configuration of the site with the specified identifier.
Permissions and limits
Account permissions
A security console user with the needed privileges
A repeated request may repeat the external action. Review the previous result before retrying a write.
Update site organization
Write
Updates the site organization information.
Permissions and limits
Account permissions
A security console user with the needed privileges
A repeated request may repeat the external action. Review the previous result before retrying a write.
Update site scan schedule
Write
Updates the specified scan schedule.
Permissions and limits
Account permissions
A security console user with the needed privileges
A repeated request may repeat the external action. Review the previous result before retrying a write.
Update site syslog alert
Write
Updates the specified Syslog alert.
Permissions and limits
Account permissions
A security console user with the needed privileges
A repeated request may repeat the external action. Review the previous result before retrying a write.
Update sonar query
Write
Updates a sonar query.
Permissions and limits
Account permissions
A security console user with the needed privileges
A repeated request may repeat the external action. Review the previous result before retrying a write.
Update tag
Write
Updates the details of a tag.
Permissions and limits
Account permissions
A security console user with the needed privileges
A repeated request may repeat the external action. Review the previous result before retrying a write.
Update tag search criteria
Write
Updates the search criteria associated with the tag.
Permissions and limits
Account permissions
A security console user with the needed privileges
A repeated request may repeat the external action. Review the previous result before retrying a write.
Update user
Write
Updates the details of a user.
Permissions and limits
Account permissions
A security console user with the needed privileges
A repeated request may repeat the external action. Review the previous result before retrying a write.
Update vulnerability exception expiration
Write
Set the expiration date for a vulnerability exception.
Permissions and limits
Account permissions
A security console user with the needed privileges
A repeated request may repeat the external action. Review the previous result before retrying a write.
Update vulnerability exception status
Write
Update the status of the vulnerability exception.
Permissions and limits
Account permissions
A security console user with the needed privileges
A repeated request may repeat the external action. Review the previous result before retrying a write.
Vulnerability check
Read
Returns the vulnerability check.
Permissions and limits
Account permissions
A security console user with the needed privileges
SETUP
Start with a controlled test.
01Connect the intended account
Use the account and permissions required for your process. Review the connection check before configuring a workflow action.
02Review inputs and access
Select a listed operation and map its required inputs. Use test records and add a human approval before writes that need review.
03Confirm the result
Inspect step outputs and confirm the result in Rapid7 InsightVM. A saved workflow is not a completed provider action.
Security & Identity ยท CONNECTION
