openapi: 3.0.0
info:
version: 1.0.0
title: Downloads About Inventory Exports API
description: 'The Downloads API enables customers to access and download installation and update files for available Tenable products. You can use the API endpoints to list product pages, list downloads available for a specific product, and to download a file. The endpoints can also be used to determine and download the latest version of a file to facilitate the automation of an installation.
**Note:** The Tenable Downloads API uses a different server URL than the Tenable Vulnerability Management API:
`https://www.tenable.com/downloads/api/v2/pages`.
### Authentication
Like the Downloads website, certain files require authentication to download. When files have a `"requires_auth": true` attribute on the product list page, the Downloads API uses bearer token authentication and requires a valid token in the Authorization header to download the file:
```
Authorization: Bearer AbCdEf123456
```
To access or reset your authentication token, navigate to the [Authentication Token](https://www.tenable.com/downloads/api-docs) page.
Examples of product downloads that **do not** require authentication include Nessus and Nessus Agents.'
servers:
- url: https://www.tenable.com/downloads/api/v2
security:
- Bearer: []
tags:
- name: Inventory Exports
description: The Tenable Inventory Exports API enables users to export inventory assets and findings in JSON or CSV format. For more information about exporting assets and findings from Tenable Exposure Management, see [Assets](https://docs.tenable.com/exposure-management/Content/exposure-management/inventory/assets.htm) and [Findings](https://docs.tenable.com/exposure-management/Content/exposure-management/inventory/findings.htm) in the _Tenable Exposure Management User Guide_.
x-displayName: Inventory Exports
paths:
/api/v1/t1/inventory/export/assets:
post:
summary: Export assets
description: 'Exports assets in your organization that match the specified search criteria.
**Caution:** This endpoint is available for use but is currently in beta. The response structure is subject to change as we continue to enhance the data model. <div class="perms-callout">Requires the Basic [16] user role or the `ASSET_INVENTORY.CYBER_ASSET_MANAGEMENT.READ` and `AD.TOGGLE_AD.USE` custom role privileges. See [Roles](doc:roles).</div>'
operationId: inventory-export-assets
tags:
- Inventory Exports
parameters:
- description: "Specifies which asset properties to include in the export. Provide multiple properties as a comma-separated list. \n\nBy default, if no properties are provided, the export includes the following properties: `asset_name`, `asset_id`, `asset_class`, `aes`, and `asset_criticality_rating_(acr)`\n\nUse the [List assets properties](ref:inventory-asset-properties-list) endpoint to retrieve a list of valid properties for this parameter. For example, you might include `created_at`, `sources`, and `fqdns`."
explode: true
in: query
name: properties
required: false
schema:
example: prop1,prop2,prop3
pattern: ^[a-zA-Z0-9_]+(,[a-zA-Z0-9_]+)*$
type: string
style: form
- description: When set to `true`, returns the human-readable names of properties instead of internal key names.
explode: true
in: query
name: use_readable_name
required: false
schema:
default: true
type: boolean
style: form
- description: 'Maximum size, in bytes, for each export chunk when exporting large datasets.
If omitted, the default is `20971520` bytes (20 MB). The maximum value is `104857600` (100 MB) and the minimum value is `5242880` (5 MB).'
explode: true
in: query
name: max_chunk_file_size
required: false
schema:
type: integer
default: 20971520
minimum: 5242880
maximum: 104857600
style: form
- description: 'The property and direction to sort the results by, in the format `property:direction`. For example: `asset_name:asc` or `acr:desc`'
example: acr:desc
explode: true
in: query
name: sort
required: false
schema:
pattern: ^[a-zA-Z0-9_]+:(asc|desc)$
type: string
default: application:asc
style: form
- description: 'Specifies the file format for the export.
Defaults to `JSON` if not provided. Valid values are `CSV` and `JSON`.'
example: CSV
explode: true
in: query
name: file_format
required: false
schema:
$ref: '#/components/schemas/Inventory_Exports_Dataset-File-Format'
style: form
- description: "When set to `true`, the exported file is compressed using GZIP. \n\nThe compressed file retains its original format (CSV or JSON) but is smaller in size, which helps reduce download time and storage requirements. You must decompress the file with a standard GZIP tool before processing. This option is particularly useful for large exports or limited-bandwidth environments."
example: true
explode: true
in: query
name: compress
required: false
schema:
default: false
type: boolean
style: form
requestBody:
required: false
content:
application/json:
schema:
type: object
nullable: true
properties:
filters:
description: "A set of asset properties used to filter the export results. \n\nUse the [List asset properties](ref:inventory-asset-properties-list) endpoint to view available asset properties that can be used as filters."
type: array
nullable: true
items:
$ref: '#/components/schemas/Inventory_Exports_Assets-Property-Filter'
query:
type: object
description: Filter the export results by query. A query consists of the search mode and query text.
properties:
mode:
description: 'The mode to use for the query. You can choose either `simple` or `advanced`.
* `simple`—A simple query enables you to search for assets by asset name or asset ID.
* `advanced`—An advanced query enables you to build a specific query to search for assets.'
type: string
default: simple
enum:
- simple
- advanced
text:
description: "For simple searches, either an asset name or an asset ID. For advanced searches, a query string. Advanced users can use the query builder in the user interface to create a query string.\n\nFor example, some common advanced queries are:\n\n* Cloud assets with critical severity findings—`Assets HAS sources = \"CLOUD\" WITH Weakness HAS severity = \"Critical\"` \n* Cloud assets with critical severity findings and AES score above 700—`Assets HAS sources = \"CLOUD\" AND aes >= 700 WITH Weakness HAS severity = \"Critical\"` \n* Cloud assets exposing secrets and AES score above 700—`Assets HAS sources = \"CLOUD\" AND aes >= 700 WITH Weakness HAS detection_name contains \"exposing secrets\"` \n* Account assets with critical weaknesses—`Assets as Account with weakness has severity_level >= 3` \n* Assets discovered but not scanned for weaknesses—`Assets as Device has is_licensed = false and last_observed_at > \"1988-01-01\"`"
type: string
example: Assets
required:
- mode
- text
responses:
'200':
description: Returned if the asset export request was successfully queued.
content:
application/json:
schema:
type: object
properties:
export_id:
type: string
description: The unique identifier (UUID) of the asset export.
format: uuid
examples:
response:
value:
export_id: 7f58afba-3d63-4c6d-9693-9554497ea0f9
'400':
description: Returned if your request specified invalid parameters or if your request was improperly formatted.
content:
application/json:
schema:
$ref: '#/components/schemas/Inventory_Exports_ErrorResponseStatus'
examples:
response:
value:
message: Export column 'prop1' is not supported.
status: 400
'401':
description: Returned if the API keys specified in your request are invalid.
content:
application/json:
schema:
$ref: '#/components/schemas/Inventory_Exports_ErrorResponse'
examples:
response:
value:
error: Unauthorized
message: Invalid credentials.
'403':
description: Returned if you do not have permission to export assets.
'429':
description: Returned if you attempt to send too many requests in a specific period of time. For more information, see [Rate Limiting](doc:rate-limiting).
content:
text/html:
examples:
response:
value: "<html>\n\n<head>\n <title>429 Too Many Requests</title>\n</head>\n\n<body bgcolor=\"white\">\n <center>\n <h1>429 Too Many Requests</h1>\n </center>\n <hr>\n <center>nginx</center>\n</body>\n\n</html>"
'500':
description: Returned if an internal error occurred.
content:
application/json:
schema:
$ref: '#/components/schemas/Inventory_Exports_ErrorResponse'
examples:
response:
value:
statusCode: 500
error: Internal Server Error
message: An internal server error occurred. Please wait a moment and try your request again.
security:
- Inventory_Exports_cloud: []
/api/v1/t1/inventory/export/findings:
post:
summary: Export findings
description: 'Exports findings in your organization that match the specified search criteria.
**Caution:** This endpoint is available for use but is currently in beta. The response structure is subject to change as we continue to enhance the data model. <div class="perms-callout">Requires the Basic [16] user role or the `ASSET_INVENTORY.CYBER_ASSET_MANAGEMENT.READ` and `AD.TOGGLE_AD.USE` custom role privileges. See [Roles](doc:roles).</div>'
operationId: inventory-export-findings
tags:
- Inventory Exports
parameters:
- description: "Specifies which findings properties to include in the export. Provide multiple properties as a comma-separated list. \n\nBy default, if no properties are provided, the export includes the following properties: `asset_id`, `finding_id`, `finding_name`, `severity`, and `state`\n\nUse the [List findings properties](ref:inventory-finding-properties-list) endpoint to retrieve a list of valid properties for this parameter. For example, you might include `asset_name`, `solution`, and `vpr_score` as properties."
explode: true
in: query
name: properties
required: false
schema:
example: prop1,prop2,prop3
pattern: ^[a-zA-Z0-9_]+(,[a-zA-Z0-9_]+)*$
type: string
style: form
- description: When set to `true`, returns the human-readable names of properties instead of internal key names.
explode: true
in: query
name: use_readable_name
required: false
schema:
default: true
type: boolean
style: form
- description: 'Maximum size, in bytes, for each export chunk when exporting large datasets.
If omitted, the default is `20971520` bytes (20 MB). The maximum value is `104857600` (100 MB) and the minimum value is `5242880` (5 MB).'
explode: true
in: query
name: max_chunk_file_size
required: false
schema:
type: integer
default: 20971520
minimum: 5242880
maximum: 104857600
style: form
- description: 'The property and direction to sort the results by, in the format `property:direction`. For example: `finding_name:asc` or `severity:desc`'
example: severity:desc
explode: true
in: query
name: sort
required: false
schema:
pattern: ^[a-zA-Z0-9_]+:(asc|desc)$
type: string
default: application:asc
style: form
- description: 'Specifies the file format for the export.
Defaults to `JSON` if not provided. Valid values are `CSV` and `JSON`.'
example: JSON
explode: true
in: query
name: file_format
required: false
schema:
$ref: '#/components/schemas/Inventory_Exports_Dataset-File-Format'
style: form
- description: "When set to `true`, the exported file is compressed using GZIP. \n\nThe compressed file retains its original format (CSV or JSON) but is smaller in size, which helps reduce download time and storage requirements. You must decompress the file with a standard GZIP tool before processing. This option is particularly useful for large exports or limited-bandwidth environments."
example: true
explode: true
in: query
name: compress
required: false
schema:
default: false
type: boolean
style: form
requestBody:
required: false
content:
application/json:
schema:
type: object
nullable: true
properties:
filters:
description: "A set of asset properties used to filter the export results. \n\nUse the [List finding properties](ref:inventory-finding-properties-list) endpoint to view available finding properties that can be used as filters."
type: array
nullable: true
items:
$ref: '#/components/schemas/Inventory_Exports_Findings-Property-Filter'
query:
type: object
description: Filter the export results by query. A query consists of the search mode and query text.
properties:
mode:
description: 'The mode to use for the query. You can choose either `simple` or `advanced`.
* `simple`—A simple query enables you to search for findings by finding name or finding ID.
* `advanced`—An advanced query enables you to build a specific query to search for findings.'
type: string
default: simple
enum:
- simple
- advanced
text:
description: "For simple searches, either a finding name or a finding ID. For advanced searches, a query string. Advanced users can use the query builder in the user interface to create a query string.\n\nFor example, some common advanced queries are:\n\n* Findings with a CVSSv3 base score equal to 10—`Findings HAS finding_cvss3_base_score = 10` \n* Findings last seen after a particular date—`Findings HAS last_observed_at > \"2025-11-12\"` "
type: string
example: Findings
required:
- mode
- text
responses:
'200':
description: Returned if the findings export request was successfully queued.
content:
application/json:
schema:
type: object
properties:
export_id:
type: string
description: The unique identifier (UUID) of the findings export.
format: uuid
examples:
response:
value:
export_id: f0b3947f-99dc-4966-b2f6-b9034f0afcad
'400':
description: Returned if your request specified invalid parameters or if your request was improperly formatted.
content:
application/json:
schema:
$ref: '#/components/schemas/Inventory_Exports_ErrorResponseStatus'
examples:
response:
value:
message: Requested EXAMPLE not found
status: 400
'401':
description: Returned if the API keys specified in your request are invalid.
content:
application/json:
schema:
$ref: '#/components/schemas/Inventory_Exports_ErrorResponse'
examples:
response:
value:
error: Unauthorized
message: Invalid credentials.
'403':
description: Returned if you do not have permission to export findings.
'429':
description: Returned if you attempt to send too many requests in a specific period of time. For more information, see [Rate Limiting](doc:rate-limiting).
content:
text/html:
examples:
response:
value: "<html>\n\n<head>\n <title>429 Too Many Requests</title>\n</head>\n\n<body bgcolor=\"white\">\n <center>\n <h1>429 Too Many Requests</h1>\n </center>\n <hr>\n <center>nginx</center>\n</body>\n\n</html>"
'500':
description: Returned if an internal error occurred.
content:
application/json:
schema:
$ref: '#/components/schemas/Inventory_Exports_ErrorResponse'
examples:
response:
value:
statusCode: 500
error: Internal Server Error
message: An internal server error occurred. Please wait a moment and try your request again.
security:
- Inventory_Exports_cloud: []
/api/v1/t1/inventory/export/assets/status:
get:
summary: List asset export jobs
description: Returns a list of up to 1,000 asset export jobs submitted in the last 3 days, sorted by the most recent refresh time. <div class="perms-callout">Requires the Basic [16] user role or the `ASSET_INVENTORY.CYBER_ASSET_MANAGEMENT.READ` and `AD.TOGGLE_AD.USE` custom role privileges. See [Roles](doc:roles).</div>
operationId: inventory-export-assets-jobs
tags:
- Inventory Exports
parameters:
- $ref: '#/components/parameters/Inventory_Exports_status-query-param'
- $ref: '#/components/parameters/Inventory_Exports_limit-query-param'
responses:
'200':
description: Returned if the list of asset export jobs was retrieved successfully.
content:
application/json:
schema:
type: object
properties:
exports:
type: array
items:
$ref: '#/components/schemas/Inventory_Exports_Response-Export-Job'
'400':
description: Returned if your request specified invalid parameters or if your request was improperly formatted.
content:
application/json:
schema:
$ref: '#/components/schemas/Inventory_Exports_ErrorResponseStatus-400'
'401':
description: Returned if the API keys specified in your request are invalid.
content:
application/json:
schema:
$ref: '#/components/schemas/Inventory_Exports_ErrorResponse'
examples:
response:
value:
statusCode: 401
error: Unauthorized
message: Invalid credentials.
'403':
description: Returned if you do not have permission to view asset export jobs.
'429':
description: Returned if you attempt to send too many requests in a specific period of time. For more information, see [Rate Limiting](doc:rate-limiting).
content:
text/html:
examples:
response:
value: "<html>\n\n<head>\n <title>429 Too Many Requests</title>\n</head>\n\n<body bgcolor=\"white\">\n <center>\n <h1>429 Too Many Requests</h1>\n </center>\n <hr>\n <center>nginx</center>\n</body>\n\n</html>"
'500':
description: Returned if an internal error occurred.
content:
application/json:
schema:
$ref: '#/components/schemas/Inventory_Exports_ErrorResponse'
examples:
response:
value:
statusCode: 500
error: Internal Server Error
message: An internal server error occurred. Please wait a moment and try your request again.
security:
- Inventory_Exports_cloud: []
/api/v1/t1/inventory/export/findings/status:
get:
summary: List finding export jobs
description: Returns a list of up to 1,000 findings export jobs submitted in the last 3 days, sorted by the most recent refresh time. <div class="perms-callout">Requires the Basic [16] user role or the `ASSET_INVENTORY.CYBER_ASSET_MANAGEMENT.READ` and `AD.TOGGLE_AD.USE` custom role privileges. See [Roles](doc:roles).</div>
operationId: inventory-export-findings-jobs
tags:
- Inventory Exports
parameters:
- $ref: '#/components/parameters/Inventory_Exports_status-query-param'
- $ref: '#/components/parameters/Inventory_Exports_limit-query-param'
responses:
'200':
description: Returned if the list of findings export jobs was retrieved successfully.
content:
application/json:
schema:
type: object
properties:
exports:
type: array
items:
$ref: '#/components/schemas/Inventory_Exports_Response-Export-Job'
'400':
description: Returned if your request specified invalid parameters or if your request was improperly formatted.
content:
application/json:
schema:
$ref: '#/components/schemas/Inventory_Exports_ErrorResponseStatus-400'
examples:
response:
value:
error: Bad Request
message: 'Invalid status: completed. Supported values: QUEUED, PROCESSING, FINISHED, ERROR'
'401':
description: Returned if the API keys specified in your request are invalid.
content:
application/json:
schema:
$ref: '#/components/schemas/Inventory_Exports_ErrorResponse'
examples:
response:
value:
statusCode: 401
error: Unauthorized
message: Invalid credentials.
'403':
description: Returned if you do not have permission to view findings export jobs.
'429':
description: Returned if you attempt to send too many requests in a specific period of time. For more information, see [Rate Limiting](doc:rate-limiting).
content:
text/html:
examples:
response:
value: "<html>\n\n<head>\n <title>429 Too Many Requests</title>\n</head>\n\n<body bgcolor=\"white\">\n <center>\n <h1>429 Too Many Requests</h1>\n </center>\n <hr>\n <center>nginx</center>\n</body>\n\n</html>"
'500':
description: Returned if an internal error occurred.
content:
application/json:
schema:
$ref: '#/components/schemas/Inventory_Exports_ErrorResponse'
examples:
response:
value:
statusCode: 500
error: Internal Server Error
message: An internal server error occurred. Please wait a moment and try your request again.
security:
- Inventory_Exports_cloud: []
/api/v1/t1/inventory/export/{export_id}/status:
get:
summary: Get export status
description: 'Returns the current status of an export request.
**Caution:** This endpoint is available for use but is currently in beta. The response structure is subject to change as we continue to enhance the data model. <div class="perms-callout">Requires the Basic [16] user role or the `ASSET_INVENTORY.CYBER_ASSET_MANAGEMENT.READ` and `AD.TOGGLE_AD.USE` custom role privileges. See [Roles](doc:roles).</div>'
operationId: inventory-export-status
tags:
- Inventory Exports
parameters:
- description: The unique identifier (UUID) of the export request whose status you want to retrieve.
explode: false
in: path
name: export_id
required: true
schema:
type: string
style: simple
responses:
'200':
description: Returned if the status of the specified export request was retrieved successfully.
content:
application/json:
schema:
$ref: '#/components/schemas/Inventory_Exports_Response-Export-Status'
examples:
response:
value:
export_id: f69b502b-f9eb-4e17-aaa8-2f68df54fc7d
status: FINISHED
submitted_at: '2025-07-23T22:15:25.849Z'
last_refreshed_at: '2025-07-23T22:15:27.305Z'
chunks_available:
- 1
- 2
- 3
- 4
- 5
- 6
- 7
- 8
'400':
description: Returned if your request specified invalid parameters or if your request was improperly formatted.
content:
application/json:
schema:
$ref: '#/components/schemas/Inventory_Exports_ErrorResponseStatus'
examples:
response:
value:
message: Export column 'prop1' is not supported.
status: 400
'401':
description: Returned if the API keys specified in your request are invalid.
content:
application/json:
schema:
$ref: '#/components/schemas/Inventory_Exports_ErrorResponse'
examples:
response:
value:
error: Unauthorized
message: Invalid credentials.
'403':
description: Returned if you do not have permission to view the export status.
'404':
description: Returned if the specified export request was not found.
content:
application/json:
schema:
$ref: '#/components/schemas/Inventory_Exports_ErrorResponseStatus'
examples:
response:
value:
message: the request with id 1697e68f-7e14-41ad-9146-f2e08bd59296 was not found
status: 404
'429':
description: Returned if you attempt to send too many requests in a specific period of time. For more information, see [Rate Limiting](doc:rate-limiting).
content:
text/html:
examples:
response:
value: "<html>\n\n<head>\n <title>429 Too Many Requests</title>\n</head>\n\n<body bgcolor=\"white\">\n <center>\n <h1>429 Too Many Requests</h1>\n </center>\n <hr>\n <center>nginx</center>\n</body>\n\n</html>"
'500':
description: Returned if an internal error occurred.
content:
application/json:
schema:
$ref: '#/components/schemas/Inventory_Exports_ErrorResponse'
examples:
response:
value:
statusCode: 500
error: Internal Server Error
message: An internal server error occurred. Please wait a moment and try your request again.
security:
- Inventory_Exports_cloud: []
/api/v1/t1/inventory/export/{export_id}/download/{chunk_id}:
get:
summary: Download export
description: 'Downloads a specific export chunk in JSON or CSV format.
**Caution:** This endpoint is available for use but is currently in beta. The response structure is subject to change as we continue to enhance the data model. <div class="perms-callout">Requires the Basic [16] user role or the `ASSET_INVENTORY.CYBER_ASSET_MANAGEMENT.READ` and `AD.TOGGLE_AD.USE` custom role privileges. See [Roles](doc:roles).</div>'
operationId: inventory-export-download
tags:
- Inventory Exports
parameters:
- description: The unique identifier (UUID) of the export request for which you want to download a chunk.
explode: false
in: path
name: export_id
required: true
schema:
type: string
style: simple
- description: 'The specific chunk number to retrieve from the export request.
**Note:** For exports in CSV format, each chunk includes a header row.'
explode: false
in: path
name: chunk_id
required: true
schema:
type: string
style: simple
responses:
'200':
description: Returned if the assets export chunk was retrieved successfully.
content:
application/octet-stream:
schema:
oneOf:
- title: Assets Export Chunk (JSON)
description: 'The response model for asset export chunks in JSON format.
**Note:** The schema below reflects the default response structure. The actual structure can vary depending on the properties specified in the asset export request.'
type: array
items:
$ref: '#/components/schemas/Inventory_Exports_Response-Assets-Chunk-JSON'
- title: Assets Export Chunk (CSV)
description: 'For the CSV response model of asset export chunks, see the example CSV responses.
**Note:** The structure of the response can vary based on the properties specified in the asset export request.'
type: string
- title: Findings Export Chunk (JSON)
description: 'The response model for findings export chunks in JSON format.
**Note:** The schema below reflects the default response structure. The actual structure can vary depending on the properties specified in the asset export request.'
type: array
items:
$ref: '#/components/schemas/Inventory_Exports_Response-Findings-Chunk-JSON'
- title: Findings Export Chunk (CSV)
description: 'For the CSV response model of findings export chunks, see the example CSV responses.
**Note:** The structure of the response can vary based on the properties specified in the findings export request.'
type: string
examples:
Assets Export Chunk (JSON):
value:
- aes: 947
asset_class: DEVICE
asset_criticality_rating_(acr): 9
asset_id: 1424e7ea-0ed1-40d0-b7c7-044ddfb654d6
asset_name: dc1
# --- truncated at 32 KB (54 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/tenable/refs/heads/main/openapi/tenable-inventory-exports-api-openapi.yml