Stop scan

Stops a scan.

You can only stop a scan that has a status of pending, running, or resuming. To stop a scan with a status of stopping or publishing, use the Force stop scan endpoint. For more information about scan statuses, see Scan Status.

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

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Path Params
string
required

The identifier for the scan you want to stop. This identifier can be either the scans.schedule_uuid or the scans.id attribute in the GET /scans endpoint's response message.

Headers
string
enum
Defaults to application/json

Generated from available response content types

Allowed:
Responses

404

Returned if Tenable Vulnerability Management cannot find the specified scan.

409

Returned if the scan does not have a pending,running, or resuming status. For more information about scan statuses, see Scan Status.

Language
Credentials
Header
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json
text/html