Create a volume

post

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

This call creates a new volume. Volumes authorize the Platform to access and query objects on a specified cloud storage (Amazon Web Services or Google Cloud Storage) on your behalf.

Learn more about using the Volumes API for Amazon S3 and for Google Cloud Storage. These tutorials also detail how to configure your bucket.

Body Params

name

string

required

The name of the volume. It must be unique from all other volumes for this user.

access_mode

string

Signifies whether this volume should be used for read-write (RW) or read-only (RO) operations. The access mode is consulted independently of the credentials granted to Seven Bridges when the volume was created, so it is possible to use a read-write credentials to register both read-write and read-only volumes using it. default: "RW"

description

string

An optional description of this volume.

service

object

required

This object should contain the information about the cloud service that this volume represents.

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