Start a bulk export job

Bulk export files from your project on the Seven Bridges Platform into your volume. One call can contain up to 100 items.

Files selected for export must not be public files or aliases. Aliases are objects stored in your cloud storage bucket which have been made available on the Platform. The volume you are exporting to must be configured for read-write access. To do this, set the access_mode parameter to RW when creating or modifying a volume.

Essentially, the call writes to your cloud storage bucket via the volume. If this call is successful, the original project files will become aliases to the newly exported objects on the volume. Source files will be deleted from the Platform and, if no more copies of the files exist, they will no longer count towards your total storage price on the Platform. In summary, once you export files from the Platform to a volume, they are no longer part of the storage on the Platform and cannot be exported again.

Learn more about using the Volumes API for for Amazon S3.

📘

If you are using Seven Bridges Platform EU, please use the following endpoint: https://eu-api.sbgenomics.com/v2/bulk/storage/exports/create

📘

When exporting a file from the Platform to an attached volume, export is possible only to a volume that is in the same location (cloud provider and region) as the project from which the file is being exported.

Example request body

{
    "items": [
        {
              "source": {
                "file": "5abce8051c948ec3c0ce2b7c"
              },
              "destination": {
                "volume": "rfranklin/output",
                "location": "output.vcf"
              },
              "overwrite": true,
              "properties": {
              "sse_algorithm": "AES256"
            }
        },
        {
              "source": {
                "file": "5abce8191c948ec3c0ce2b7f"
              },
              "destination": {
                "volume": "rfranklin/output",
                "location": "output_2.vcf"
              },
              "overwrite": false,
              "properties": {
                "sse_algorithm": "AES256"
            }
        }
         
    ]
}

Response

See a list of Seven Bridges Platform-specific response codes that may be contained in the body of the response.

Response body

Key

Data type

Description

id

string

ID of this export job.

state

string

The state of this export job. Possible values are:

  • PENDING: the export is queued;
  • RUNNING: the export is running;
  • COMPLETED: the export has completed successfully;
  • FAILED: the export has failed.

source

object

Export source, as passed when this job was started by the call to start an export job.

destination

object

Export destination, as passed when this job was start an export job.

result

object

File object that was exported.

error

object

In case of error in the export job, standard API error is returned here.

Language