GuidesAPIDatasets HubRelease Notes
API Reference
CGC

Get details of a volume

get https://cgc-api.sbgenomics.com/v2

This call returns details of the specified volume. The volume is referred to by its ID, which you can obtain by making the call to list all the volumes you've registered.

https://cgc-api.sbgenomics.com/v2/storage/volumes/{volume_id}

Request

Example request

GET /storage/volumes/rfranklin/output HTTP/1.1
Host: cgc-api.sbgenomics.com
X-SBG-Auth-Token: 3210a98c1db9318fa9d9273156740f74

curl  -s -H "X-SBG-Auth-Token: 3210a98c1db9318fa9d9273156740f74" -H "Content-type: application/json" -X GET "https://cgc-api.sbgenomics.com/storage/volumes/rfranklin/output"

Header Fields

KeyDescription of value
X-SBG-Auth-Token
required		Your CGC authentication token.
Content-type
required		application/json

Path parameters

KeyData type of valueDescription of value
volume_id
required		StringThe volume that you want to query, which consists of username of the volume owner and volume name, for example rfranklin/output.

Response

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

KeyData type of valueDescription of value
activeBooleanIf a volume is deactivated, this field will be set to false
idStringID of this volume, containing owner/name
nameStringName of the volume.
descriptionStringThe description of this volume.
serviceObjectThis object more closely describes the mapping of the volume to the cloud service where the data is stored.

See the service object section below for an explanation of its structure.
created_onStringThe date and time this volume was created.
modified_onStringThe date and time this volume was last modified.

The service object

KeyData type of valueDescription of value
typestringThe type of cloud service supported. Currently the only valid values are "s3" for Amazon Web Services and "gcs" for Google Cloud Storage.
access_modestringSignifies 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 the CGC 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"
prefixStringA service-specific prefix to prepend to all objects created in this volume. If the service supports folders, and this prefix includes them, the API will attempt to create any missing folders when it outputs a file.

default: ""
bucket

applies to type: s3 and gcs
required		StringThe name of the AWS S3 or GCS bucket you wish to register as a volume.
root_url

default: https://s3.amazonaws.com fors3 type and https://www.googleapis.com/ for gcs		StringCloud provider API endpoint to use when accessing this bucket.

For a list of AWS-supported endpoints, see AWS Regions and Endpoints.
credentialsObjectContains credentials for the underlying cloud provider.

AWS IAM user:
 access-key-id
secret_access-key

For Google Cloud Storage, these credentials are:

 client_email
* private_key
access_key_id

applies to type: s3
required		StringAWS access key ID of the IAM user shared with the CGC to access this bucket.
secret_access_key

applies to type: s3
required		StringAWS secret access key of the IAM user shared with the CGC to access this bucket.
client_email

applies to type: gcs
required		StringGoogle Cloud Storage user email.
private_key

applies to type: gcs
required		StringGoogle Cloud Storage private key.
propertiesObjectContains properties of specific service.
sse_algorithm

applies to type: s3		StringUse default AES256 server-side encryption or AWS KMS encryption when writing to this bucket.

Can be:
AES256 (default)
 aws:kms

default: AES256
sse_aws_kms_key_id

applies to type: s3		StringIf AWS KMS encryption is used, this should be set to the required KMS key. If not set and aws:kms is set as sse_algorithm, default KMS key is used.

Example response body

{
  "active": True,
  "description": "task outputs bucket",
  "id": "rfranklin/output",
  "service": {
    "type": "s3",
    "bucket": "sbg-test-output",
    "hostname": "s3.amazonaws.com",
    "access_key": "AKIAJRC7TPMRMEXAMPLE",
    "access_mode": "RW",
    "prefix": "",
    "sse_enabled": True,
    "created_time": "2016-06-29T11:13:10+02:00",
    "updated_time": "2016-06-29T12:15:10+02:00"
  }
}
Language