Delete a volume

This call deletes a volume you've created to refer to storage on Amazon Web Services or Google Cloud Storage.

To be able to delete a volume, you first need to deactivate it and then delete all files on the Platform that were previously imported from the volume.

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

Request

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

Example request

DELETE /v2/storage/volumes/rfranklin/output HTTP/1.1
Host: api.sbgenomics.com
X-SBG-Auth-Token: 3259c50e1ac5426ea8f1273259740f74
curl -s -H "X-SBG-Auth-Token: 3259c50e1ac5426ea8f1273259740f74" -H "content-type: application/json" -X DELETE "https://api.sbgenomics.com/v2/storage/volumes/rfranklin/output"
from sevenbridges import Api

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

volume = api.volumes.get(id='rfranklin/output')

# send DELETE request to SB API
volume.delete()

Header Fields

Key

Description of value

X-SBG-Auth-Token
required

Your Seven Bridges Platform authentication token.

Content-type
required

application/json

Path parameters

Key

Description of value

volume_id

The ID of the volume to delete.

Response

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