TOC & Recently Viewed

Recently Viewed Topics

Query for Vulnerability Export Status and Chunk ID Information

User Permissions: Administrator (64)

Note: When generating the vulnerabilities export, Tenable.io processes the chunks in parallel, so the chunks may not complete in order.

To query for the status of the export and chunk identification information, use the API endpoint described below.

HTTP Request

Note: To authenticate your request, be sure to include API keys in the HTTP header of the request. For more information, see Authorization.

Request Path Syntax

GET https://cloud.tenable.com/vulns/export/{export_uuid}/status

Request Path Parameters

Attribute Type Description Required?
export_uuid string The unique identifier of an export request. This value corresponds to the value returned in the /vulns/export response message. required

Request Path Example

GET https://cloud.tenable.com/vulns/export/a483adf8-24e3-4c7f-818a-6867b02310dd/status

Request Body Syntax

None.

HTTP Response

Response Codes

Status Description
200 Returned if Tenable.io successfully retrieves the export status. For more information, see "Response Body Syntax."
403 Returned if you do not have permission to view the export status.
404 Returned if an export with the specified UUID is not found.
429

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

Response Body Syntax

{ "status": {string}, "chunks_available": [{integer},{integer}...], "chunks_failed": [{integer},{integer}...], "chunks_cancelled": [{integer},{integer}...] }

Response Body Attributes

Attribute Type Description
status string

The status of the export request.

Possible values include:

  • QUEUEDTenable.io has queued the export request until it completes other requests currently in process.
  • PROCESSINGTenable.io has started processing the export request.
  • FINISHEDTenable.io has completed processing the export request. The list of chunks is complete.
  • ERRORTenable.io encountered an error while processing the export request.

    Tip: If you encounter an ERROR status, Tenable recommends that you retry the request. If the status persists on retry, contact Support.

chunks_available array A comma-separated list of completed chunks available for download.
chunks_failed array

A comma-separated list of chunks for which the export process failed.

If a chunk fails processing, submit the export request again. If the chunk continues to fail, contact Support.

chunks_cancelled array A comma-separated list of chunks for which the export process was cancelled. If a chunk fails processing, Tenable.io automatically cancels all subsequent chunks queued for export in the same request.

Response Body Example

{ "status": "FINISHED", "chunks_available": [ 1, 2 ], "chunks_failed": [], "chunks_cancelled": [] }

Reference Guide

https://cloud.tenable.com/api#/resources/exports/vulns-export-status

Examples

 

Copyright © 2019 Tenable, Inc. All rights reserved. Tenable, Tenable.io, Tenable Network Security, Nessus, SecurityCenter, SecurityCenter Continuous View and Log Correlation Engine are registered trademarks of Tenable, Inc.. Tenable.sc, Lumin, Assure, and the Cyber Exposure Company are trademarks of Tenable, Inc. All other products or services are trademarks of their respective owners.