cancel
Showing results for 
Show  only  | Search instead for 
Did you mean: 

This documentation is for the new preview UI. It’s still being refined and is subject to change. For documentation for the old UI, see Knowledge Base.

Article link copied to clipboard
Updated
Published
13 min read
Note on third‑party tools

We aim to provide accurate and helpful details about third‑party tools, but we can’t guarantee that this information is always complete or up to date. If you notice any discrepancies, feel free to share them in the feedback section below. For the most reliable information, please always refer to the third‑party tool’s official documentation.

Assess vulnerabilities; manage assets, users, agents, and more.

Connections

Access Key / Secret Key

Connection to Tenable

To generate API keys in Tenable Vulnerability Management:

  1. Login to your Tenable account and navigate to My Account by selecting the user icon in the top right menu.
  2. Navigate to API Keys and select generate to generate an Access Key and a Secret Key.
  3. Enter these values into the connection configuration of your integration.
    1. Save these values as they will not be shown again.
Input Comments Default
Access Key
Secret Key

Actions

Add Agent to Group

Adds an agent to the agent group.

Input Comments Default
Connection
Group ID The ID of the agent group.
Agent ID The ID of the agent to add.
Debug Request Enabling this flag will log out the current request. false

Add or Remove Asset Tags

Adds or removes tags from the specified assets, and returns the UUID of the asynchronous asset update job.

Input Comments Default
Connection
Action Specifies whether to add or remove tags.
Assets An array of asset UUIDs.
Tags An array of tag value UUIDs.
Debug Request Enabling this flag will log out the current request. false

Create Agent Group

Creates an agent group.

Input Comments Default
Connection
Name The name of the agent group.
Debug Request Enabling this flag will log out the current request. false

Create User

Creates a new user.

Input Comments Default
Connection
Username A valid username must be in the format, name@domain, where domain corresponds to a domain approved for your Tenable Vulnerability Management instance.
Password Passwords must be at least 12 characters long and contain at least one uppercase letter, one lowercase letter, one number, and one special character symbol.
Permissions The user permissions as described in Permissions. See https://developer.tenable.com/reference/users-create for more information.
Name The name of the user (for example, first and last name).
Email The email address of the user. A valid email address must be in the format, name@domain, where domain corresponds to a domain approved for your Tenable Vulnerability Management instance. Administrators can create users with an email address that has a domain outside of the approved domains.
Debug Request Enabling this flag will log out the current request. false

Delete Agent Group

Deletes an agent group.

Input Comments Default
Connection
Group ID The ID or UUID of the agent group to delete.
Debug Request Enabling this flag will log out the current request. false

Delete Asset

Deletes the specified asset.

Input Comments Default
Connection
Asset UUID The UUID of the asset.
Debug Request Enabling this flag will log out the current request. false

Delete Scanner

Deletes and unlinks a scanner from Tenable Vulnerability Management.

Input Comments Default
Connection
Scanner ID The ID of the scanner.
Debug Request Enabling this flag will log out the current request. false

Delete User

Deletes a user.

Input Comments Default
Connection
User ID The UUID (uuid) or unique ID (id) of the user.
Debug Request Enabling this flag will log out the current request. false

Download Vulnerabilities

Downloads exported vulnerabilities as a JSON file.

Input Comments Default
Connection
Export UUID The UUID of the vulnerability export request.
Chunk ID The ID of the chunk you want to export.
Debug Request Enabling this flag will log out the current request. false

Export Assets

Exports all assets that match the request criteria.

Input Comments Default
Connection
Chunk Size Specifies the number of assets per exported chunk. The range is 100-10000.
Include Open Ports Specifies whether or not to include open port findings from info-level plugins. false
Filters Specifies filters for exported assets. See https://developer.tenable.com/reference/exports-assets-request-export for more information.
Debug Request Enabling this flag will log out the current request. false

Export Vulnerabilities

Exports vulnerabilities that match the request criteria.

Input Comments Default
Connection
Number of Assets Specifies the number of assets used to chunk the vulnerabilities.
Include Unlicensed Specifies whether or not to include unlicensed assets. false
Filters Specifies filters for exported vulnerabilities. See https://developer.tenable.com/reference/exports-vulns-request-export for more information.
Debug Request Enabling this flag will log out the current request. false

Get Agent

Returns the specified agent details for the specified scanner.

Input Comments Default
Connection
Agent ID The ID of the agent to query.
Debug Request Enabling this flag will log out the current request. false

Get Agent Group

Gets details for the agent group.

Input Comments Default
Connection
Group ID The ID or UUID of the agent group to query.
Fetch All If true, all results will be returned (Offset and Limit will be ignored). If false, limit and offset will be used. true
Filter Apply a filter in the format ::. For example, field1:match:sometext would match any records where the value of field1 contains sometext. You can use multiple query filters.
Filter Type If the filter type is 'and', the record is only returned if all filters match. If the filter type is 'or', the record is returned if any of the filters match.
Wildcard Filter Text Wildcard search is a mechanism where multiple fields of a record are filtered against one specific filter string. If any one of the Wildcard Fields values matches against the filter string, then the record matches the wildcard filter. For a record to be returned, it must pass the wildcard filter (if there is one) AND the set of standard filters.
Wildcard Fields A comma-delimited subset of Wildcard Fields to search when applying the wildcard filter. If Wildcard Filter Text is provided, but Wildcard Fields is not, then all 'wildcard_fields' values are searched against the wildcard filter text.
Limit The number of records to retrieve. If this parameter is omitted, Tenable Vulnerability Management uses the default value of 50.
Offset The starting record to retrieve. If this parameter is omitted, Tenable Vulnerability Management uses the default value of 0.
Sort The field you want to use to sort the results by along with the sort order. The field is specified first, followed by a colon, and the order is specified second (asc or desc).
Debug Request Enabling this flag will log out the current request. false

Get Asset

Returns details of the specified asset.

Input Comments Default
Connection
Asset UUID The UUID of the asset.
Debug Request Enabling this flag will log out the current request. false

Get Asset Vulnerability Details

Retrieves the details for a vulnerability recorded on a specified asset.

Input Comments Default
Connection
Asset ID The UUID of the asset.
Plugin ID The ID of the plugin.
Date Range The number of days of data prior to and including today that should be returned.
Query Param Filters Filters to apply in JSON format. See https://developer.tenable.com/reference/workbenches-asset-vulnerability-info for more information.
Debug Request Enabling this flag will log out the current request. false

Get Plugin Details

Retrieves the details for a plugin.

Input Comments Default
Connection
Plugin ID The ID of the plugin.
Date Range The number of days of data prior to and including today that should be returned.
Query Param Filters Filters to apply in JSON format. See https://developer.tenable.com/reference/workbenches-vulnerability-info for more information.
Debug Request Enabling this flag will log out the current request. false

Get Scanner

Returns details for the specified scanner.

Input Comments Default
Connection
Scanner ID The ID of the scanner.
Debug Request Enabling this flag will log out the current request. false

Get User

Returns details for a specific user.

Input Comments Default
Connection
User ID The UUID (uuid) or unique ID (id) of the user.
Debug Request Enabling this flag will log out the current request. false

Import Assets

Imports asset data in JSON format.

Input Comments Default
Connection
Asset Objects An array of asset objects to import. Each asset object requires a value for at least one of the following properties: fqdn, ipv4, netbios_name, mac_address. See https://developer.tenable.com/reference/assets-import for more information.
Source A user-defined name for the source of the import.
Debug Request Enabling this flag will log out the current request. false

Import Vulnerabilities

Imports a list of vulnerabilities in JSON format.

Input Comments Default
Connection
Vendor The company that owns the product that is the source of the vulnerability data.
Product The name of the product from the vendor.
Data Type The type of scan that identified the vulnerabilities.
Source A unique string value used to track the set of assets and vulnerabilities.
Assets An array of asset objects with vulnerabilities information. See https://developer.tenable.com/reference/vulnerabilities-import-v2 for more information.
Coverage The coverage object. See https://developer.tenable.com/reference/vulnerabilities-import-v2 for more information.
Debug Request Enabling this flag will log out the current request. false

List Agent Groups

Retrieves a list of agent groups.

Input Comments Default
Connection
Debug Request Enabling this flag will log out the current request. false

List Agents

Returns a list of agents for the specified scanner.

Input Comments Default
Connection
Fetch All If true, all results will be returned (Offset and Limit will be ignored). If false, limit and offset will be used. true
Filter Apply a filter in the format ::. For example, field1:match:sometext would match any records where the value of field1 contains sometext. You can use multiple query filters.
Filter Type If the filter type is 'and', the record is only returned if all filters match. If the filter type is 'or', the record is returned if any of the filters match.
Wildcard Filter Text Wildcard search is a mechanism where multiple fields of a record are filtered against one specific filter string. If any one of the Wildcard Fields values matches against the filter string, then the record matches the wildcard filter. For a record to be returned, it must pass the wildcard filter (if there is one) AND the set of standard filters.
Wildcard Fields A comma-delimited subset of Wildcard Fields to search when applying the wildcard filter. If Wildcard Filter Text is provided, but Wildcard Fields is not, then all 'wildcard_fields' values are searched against the wildcard filter text.
Limit The number of records to retrieve. If this parameter is omitted, Tenable Vulnerability Management uses the default value of 50.
Offset The starting record to retrieve. If this parameter is omitted, Tenable Vulnerability Management uses the default value of 0.
Sort The field you want to use to sort the results by along with the sort order. The field is specified first, followed by a colon, and the order is specified second (asc or desc).
Debug Request Enabling this flag will log out the current request. false

List Agents By Group

Returns a list of agents for the specified agent group.

Input Comments Default
Connection
Agent Group ID The ID of the agent group to query for agents.
Fetch All If true, all results will be returned (Offset and Limit will be ignored). If false, limit and offset will be used. true
Filter Apply a filter in the format ::. For example, field1:match:sometext would match any records where the value of field1 contains sometext. You can use multiple query filters.
Filter Type If the filter type is 'and', the record is only returned if all filters match. If the filter type is 'or', the record is returned if any of the filters match.
Wildcard Filter Text Wildcard search is a mechanism where multiple fields of a record are filtered against one specific filter string. If any one of the Wildcard Fields values matches against the filter string, then the record matches the wildcard filter. For a record to be returned, it must pass the wildcard filter (if there is one) AND the set of standard filters.
Wildcard Fields A comma-delimited subset of Wildcard Fields to search when applying the wildcard filter. If Wildcard Filter Text is provided, but Wildcard Fields is not, then all 'wildcard_fields' values are searched against the wildcard filter text.
Limit The number of records to retrieve. If this parameter is omitted, Tenable Vulnerability Management uses the default value of 50.
Offset The starting record to retrieve. If this parameter is omitted, Tenable Vulnerability Management uses the default value of 0.
Sort The field you want to use to sort the results by along with the sort order. The field is specified first, followed by a colon, and the order is specified second (asc or desc).
Debug Request Enabling this flag will log out the current request. false

List Assets

Lists up to 5,000 assets.

Input Comments Default
Connection
Debug Request Enabling this flag will log out the current request. false

List Assets with Vulnerabilities

Returns a list of assets with vulnerabilities.

Input Comments Default
Connection
Date Range The number of days of data prior to and including today that should be returned.
Query Param Filters Filters to apply in JSON format. See https://developer.tenable.com/reference/workbenches-assets-vulnerabilities for more information.
Debug Request Enabling this flag will log out the current request. false

List Asset Tags

Returns a list of assigned tags for the specified asset UUID.

Input Comments Default
Connection
Asset UUID The UUID of the asset.
Debug Request Enabling this flag will log out the current request. false

List Asset Vulnerabilities

Retrieves a list of the vulnerabilities recorded for a specified asset.

Input Comments Default
Connection
Asset ID The UUID of the asset.
Date Range The number of days of data prior to and including today that should be returned.
Query Param Filters Filters to apply in JSON format. See https://developer.tenable.com/reference/workbenches-asset-vulnerabilities for more information.
Debug Request Enabling this flag will log out the current request. false

List Scanners

Returns the scanner list.

Input Comments Default
Connection
Debug Request Enabling this flag will log out the current request. false

List Users

Returns a list of users.

Input Comments Default
Connection
Debug Request Enabling this flag will log out the current request. false

List Vulnerabilities

Returns a list of recorded vulnerabilities.

Input Comments Default
Connection
Date Range The number of days of data prior to and including today that should be returned.
Query Param Filters Filters to apply in JSON format. See https://developer.tenable.com/reference/workbenches-vulnerabilities for more information.
Debug Request Enabling this flag will log out the current request. false

Move Assets

Moves assets from the specified network to another network.

Input Comments Default
Connection
Source Network UUID The UUID of the network currently associated with the assets.
Destination Network UUID The UUID of the network to associate with the specified assets.
Targets The IPv4 addresses of the assets to move. The addresses can be represented as a comma-separated list, a range, or CIDR.
Debug Request Enabling this flag will log out the current request. false

Raw Request

Send raw HTTP request to Tenable.

Input Comments Default
Connection
URL Input the path only (/networks), The base URL is already included (https://cloud.tenable.com). For example, to connect to https://cloud.tenable.com/networks, only /networks is entered in this field.
Method The HTTP method to use.
Data The HTTP body payload to send to the URL.
Form Data The Form Data to be sent as a multipart form upload.
File Data File Data to be sent as a multipart form upload.
File Data File Names File names to apply to the file data inputs. Keys must match the file data keys above.
Query Parameter A list of query parameters to send with the request. This is the portion at the end of the URL similar to ?key1=value1&key2=value2.
Header A list of headers to send with the request.
Response Type The type of data you expect in the response. You can request json, text, or binary data. json
Timeout The maximum time that a client will await a response to its request
Debug Request Enabling this flag will log out the current request. false
Retry Delay (ms) The delay in milliseconds between retries. This is used when 'Use Exponential Backoff' is disabled. 0
Retry On All Errors If true, retries on all erroneous responses regardless of type. This is helpful when retrying after HTTP 429 or other 3xx or 4xx errors. Otherwise, only retries on HTTP 5xx and network errors. false
Max Retry Count The maximum number of retries to attempt. Specify 0 for no retries. 0
Use Exponential Backoff Specifies whether to use a pre-defined exponential backoff strategy for retries. When enabled, 'Retry Delay (ms)' is ignored. false

Remove Agent from Group

Removes an agent from the specified agent group.

Input Comments Default
Connection
Group ID The ID of the agent group.
Agent ID The ID of the agent to remove.
Debug Request Enabling this flag will log out the current request. false

Rename Agent

Renames an agent.

Input Comments Default
Connection
Agent ID The ID of the agent to rename.
Name The new name for the agent.
Debug Request Enabling this flag will log out the current request. false

Unlink Agent

Unlinks an agent.

Input Comments Default
Connection
Agent ID The ID of the agent to unlink.
Debug Request Enabling this flag will log out the current request. false

Update Agent Group

Changes the name of the agent group.

Input Comments Default
Connection
Group ID The ID or UUID of the agent group to update.
Name The name of the agent group.
Debug Request Enabling this flag will log out the current request. false

Update Scanner

Updates the specified scanner.

Input Comments Default
Connection
Scanner ID The ID of the scanner.
Name The new name for the scanner.
Force Plugin Update Pass 1 to force a plugin update.
Force UI Update Pass 1 to force a UI update.
Finish Update Pass 1 to reboot the scanner and run the latest software update (only valid if automatic updates are disabled).
Registration Code Sets the registration code for the scanner.
AWS Update Interval Specifies how often, in minutes, the scanner checks in with Tenable Vulnerability Management (Amazon Web Services scanners only).
Debug Request Enabling this flag will log out the current request. false

Update User

Updates an existing user account.

Input Comments Default
Connection
User ID The UUID (uuid) or unique ID (id) of the user.
Permissions The user permissions as described in Permissions. See https://developer.tenable.com/reference/users-create for more information.
Name The name of the user (for example, first and last name).
Email The email address of the user. A valid email address must be in the format, name@domain, where domain corresponds to a domain approved for your Tenable Vulnerability Management instance. Administrators can create users with an email address that has a domain outside of the approved domains.
Enabled Specifies whether the user's account is enabled (true) or disabled (false).
Debug Request Enabling this flag will log out the current request. false