List volumes

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.

Request

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

Example request

GET /v2/storage/volumes HTTP/1.1
Host: api.sbgenomics.com
X-SBG-Auth-Token: 3259c50e1ac5426ea8f1273259740f74
Content-Type: application/json
curl -s -H "X-SBG-Auth-Token: 6282d5e2121d43e7900e9d52b15845e7" -H "Content-Type: application/json" -X GET "https://api.sbgenomics.com/v2/storage/volumes"
from sevenbridges import Api

api = Api(url='https://api.sbgenomics.com/v2',
          token='3259c50e1ac5426ea8f1273259740f74')

# send GET request to SB API
volumes = api.volumes.query()

for volume in volumes:
    print(volume.id, volume.name, volume.active)

Header Fields

Key

Description of value

X-SBG-Auth-Token
required

Your Seven Bridges Platform authentication token.

Content-type
required

application/json

Response

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

Example response body

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