DocumentationAPI ExplorerRecipesConnectChangelogRSSSubscribe
API Explorer

Get scan progress

get
https://cloud.tenable.com/scans//progress

Returns the progress for the specified scan.

Note: If you submit a request without query parameters, Tenable Vulnerability Management returns the progress from the latest run of the specified scan. If you submit a request using the history_id or history_uuid query parameters to specify a historical run of the scan, Tenable Vulnerability Management returns the progress for the specified historical run.

Requires the Scan Operator [24] user role and Can View [16] 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 unique identifier of the scan you want to retrieve the progress for.

For the identifier, you can use either the scans.schedule_uuid or the scans.id attribute from the GET /scans endpoint. However, Tenable recommends that you use scans.schedule_uuid.

Query Params
int32

The unique identifier of the historical run of the scan that you want to retrieve the progress for.

This identifier corresponds to the history.id attribute from the GET /scans/{scan_id}/history endpoint. You can use either this parameter or the history_uuid query parameter to specify a historical run of the scan.

uuid

The UUID of the historical run of the scan that you want to retrieve the progress for.

This identifier corresponds to the history.scan_uuid attribute from the GET /scans/{scan_id}/history endpoint. You can use either this parameter or the history_id query parameter to specify a historical run of the scan.

Headers
string
enum
Defaults to application/json

Generated from available response content types

Allowed:
Responses

Updated about 2 months ago

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

Updated about 2 months ago