GuidesAPIDatasets HubRelease Notes
API Reference
CGC

List volumes

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

This call lists all the volumes you've registered.

See also Get details of a volume for a detailed explanation of the fields in the response.

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

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

Request

Example request

GET /v2/storage/volumes HTTP/1.1
Host: cgc-api.sbgenomics.com
X-SBG-Auth-Token: 3210a98c1db9318fa9d9273156740f74
Content-Type: application/json

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

Header Fields

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

Response

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

Example response body

{
  "href": "https://cgc-api.sbgenomics.com/v2/storage/volumes?offset=0&limit=3",
  "items": [
    {
      "href": "https://cgc-api.sbgenomics.com/v2/storage/volumes/rfranklin/gcs_roo",
      "id": "rfranklin/gcs_ro",
      "name": "gcs_ro"
    },
    {
      "href": "https://cgc-api.sbgenomics.com/v2/storage/volumes/rfranklin/gcs_rwr",
      "id": "rfranklin/gcs_rw",
      "name": "gcs_rw"
    },
    {
      "href": "https://cgc-api.sbgenomics.com/v2/storage/volumes/rfranklin/my_s3_volume",
      "id": "rfranklin/my_s3_volume",
      "name": "my_s3_volume"
    }
  ],
  "links": []
}
Language