Check scan export status

Returns the file status of the specified exported scan. When an export has been requested, it is necessary to poll this endpoint until a ready status is returned, at which point the file is complete and can be downloaded using the Download scan export endpoint.

Requires the Scan Operator [24] user role and the Can View [16] scan permission. Alternatively, requires the or VM.VM_SCAN.VM_SCAN.EXPORT custom role privilege. 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 for the scan. This identifier can be either the scans.schedule_uuid or the scans.id attribute in the response message from the List scans endpoint. Tenable recommends that you use scans.schedule_uuid.

string
required

The ID of the file to poll (included in response from Export scan endpoint.

Headers
string
enum
Defaults to application/json

Generated from available response content types

Allowed:
Responses

403

Returned if you do not have permission to retrieve the scan export status. For more information, see Roles and Permissions.

404

Returned if the specified scan or file was not found.

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