Start an import job

post

https://api.sbgenomics.com/v2/storage/imports

This call lets you queue a job to import a file or folder from a volume into a project on the Platform. Essentially, you are importing an item from your cloud storage provider (Amazon Web Services or Google Cloud Storage) via the volume onto the Platform.

If successful, an alias will be created on the Platform. Aliases appear on the Platform and can be copied, executed, and modified as such. They refer back to the respective item on the given volume.

If you want to import multiple files, the recommended way is to do it in bulk considering the API rate limit (learn more).

Learn more about using the Volumes API for Amazon S3 and for Google Cloud Storage.

Body Params

source

object

required

This object should describe the source from which the item should be imported.

destination

object

required

This object should describe the Platform destination for the imported file or folder.

overwrite

boolean

Whether to overwrite the item if another one with the same name already exists at the destination.

autorename

boolean

Whether to automatically rename the item (by prefixing its name with an underscore and number) if another one with the same name already exists at the destination.

preserve_folder_structure

boolean

Whether to keep the exact source folder structure. The default value is true if the item being imported is a folder. Should not be used if you are importing a file.

Headers

X-SBG-Auth-Token

string

required

Your Seven Bridges Platform authentication token. For security reasons, token will not be automatically populated in the generated code sample. Please replace <your-token-here> with your token before executing this call.

Content-Type

string

Defaults to application/json

Response

Language

Request

Response

Choose an example:

application/json

200200