Launch scan

post

https://cloud.tenable.com/scans/{scan_id}/launch

Launches a scan. For more information, see Launch a Scan.

Note: There is a limit of 25 active scans per container. You can use use the Get scan count endpoint to retrieve the total number of active scans in your container. For more information, see Concurrency Limiting.

Requires the Scan Operator [24] user role and Can Execute [32] scan permissions. See Roles and Permissions.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Path Params

scan_id

string

required

The unique identifier for the scan you want to launch. This identifier can be either the scans.schedule_uuid or the scans.id attribute in the response message from the GET /scans endpoint. Tenable recommends that you use scans.schedule_uuid.

Body Params

alt_targets

array of strings

If you include this parameter, Tenable Vulnerability Management scans these targets instead of the default. Value can be an array where each index is a target, or an array with a single index of comma-separated targets.

alt_targets

rollover

boolean

Indicates whether or not to launch a rollover scan instead of full scan. A rollover scan only runs against the targets that Tenable Vulnerability Management did not scan due to a previous scan timeout.

Headers

string

enum

Defaults to application/json

Generated from available response content types

Allowed:

Responses

403

Returned if Tenable Vulnerability Management cannot launch the scan because the scan is disabled.

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 if Tenable Vulnerability Management successfully launches the scan.

404Returned if Tenable Vulnerability Management cannot find the specified scan.

429Returned if you attempt to send too many requests in a specific period of time or if you attempt to launch more than 25 scans. For more information, see Rate Limiting and Concurrency Limiting.