Create scan

post

https://cloud.tenable.com/scans

Creates a scan configuration. For more information and request body examples, see Create a Scan.

Note: Tenable Vulnerability Management limits the active number of scans to 10,000 scans. Tenable recommends you re-use scheduled scans instead of creating new scans. Alternatively, you can delete unused scans. An HTTP 403 error is returned if you attempt to create a scan after you have already reached the scan limit of 10,000.

Requires the Scan Operator [24] user role or the VM.VM_SCAN.VM_SCAN.CREATE custom role privilege. See Roles.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Body Params

Creates a scan using the Advanced Network Scan template, which provides full control over all scan settings. Supports credentials, compliance audits, and plugin selection.

uuid

string

required

Specifies the UUID for the Tenable-provided scan template to use. Use the List templates endpoint to find the template UUID.

Caution: The defaults listed for a template via the Get template details endpoint apply to the user interface only. When you create a scan via the API you must include the settings in the request even if the setting is listed as a default in the editor. For example, even if host_tagging is set to yes by default in the editor, you still need to include "host_tagging": "yes" in the settings object for the scan.

settings

object

required

Compliance output settings controlling result format and timeouts. Available in Advanced scan templates.

credentials

object

An object that specifies credential parameters that enable a scanner to authenticate a connection to a target host. For more information about using managed credentials with the Tenable Vulnerability Management API, see Manage Credentials.

plugins

object

A list of plugins to add to the non-remediation scans. Use the List plugin families endpoint to get a list of plugin families to choose from. Then, use the List plugins in family endpoint to find plugins within the family to add to the scan.

Note: This form displays limited parameters. The example below illustrates how to add two plugins within the Web Servers plugin family to a scan.

audits

object

Specifies compliance audit files to include in the scan. Supports both Tenable-provided (feed) audits and user-uploaded (custom) audits. For more information, see Configure Compliance Audits and Compliance in the Tenable Vulnerability Management User Guide.

Headers

string

enum

Defaults to application/json

Generated from available response content types

Allowed:

Responses

400

Returned if your request specified invalid parameters or if your request was improperly formatted.

403

Returned if you attempt to create a scan after you have already reached the scan limit of 10,000. Tenable recommends you re-use scheduled scans instead of creating new scans.

Language

Credentials

Header

Loading…

Response

Click Try It! to start a request and see the response here! Or choose an example:

application/json

text/html

200Returned the scan configuration was created successfully.

401Returned if the API keys specified in your request are invalid.

429Returned if you attempt to send too many requests in a specific period of time. For more information, see Rate Limiting.

500Returned if an internal error occurred.