Bulk Export API

Introduction

Using Bulk Export API, you can bulk export your asset and vulnerability data using a GraphQL API. The data is returned in Parquet  format and can be downloaded for use in your business intelligence tools.

To bulk export API data to Parquet files, complete the following:

1. Choose the endpoint for your region.
2. Initiate the generation of export files.
3. Query the ID returned.
4. Download the parquet files.

Authorization

Authorization is performed by passing your API user key via a single HTTP header: X-Api-Key. The user key must be passed to all requests. This can be generated from the Insight Platform  key management page. For information on generating and managing API keys, see Managing Platform API Keys .

Endpoints

Initiating the export

Complete these steps to create and retrieve the export files in Parquet.

Step 1: Mutation to initiate export

The mutations initiate the generation of the export files for Policy and Vulnerability data, respectively:

Vulnerability:

mutation CreateVulnerabilityExport { 
    createVulnerabilityExport(input:{}) {
        id
    }
}

Step 2: Export query

To retrieve the URLs to download the Parquet files, you must query the ID returned when initiating the export. The results will return a URL where you can download the Parquet files.

query GetExport {
    export(id: "YzY1ODk5YzQtNjkwNi00MDRjLTk3NDQtNjRhOGNkNWFkNDIx"){
        id
        status
        dataset
        timestamp
        result {
             prefix
             urls
       }
    }
}

Parquet files

These schemas provide an overview of the fields returned in the files at the URLs provided:

Vulnerability Export

asset

asset_vulnerability

Downloading the Parquet files

• Each time URLs are generated to download the files, the URLs are valid for 15 minutes. The files can be downloaded as many times as needed within the 15 minute time frame.
• These files are retained for 30 days only. Attempting to query the exports after 30 days will return an error message.