GuidesAPI ReferenceRelease NotesTutorials
API Reference

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.

https://api.sb.biodatacatalyst.nhlbi.nih.gov/v2/storage/volumes/{volume_id}

Request

Example request

DELETE /v2/storage/volumes/rfranklin/output HTTP/1.1
Host: api.sb.biodatacatalyst.nhlbi.nih.gov
X-SBG-Auth-Token: 3259c50e1ac5426ea8f1273259740f74

curl -s -H "X-SBG-Auth-Token: 3259c50e1ac5426ea8f1273259740f74" -H "content-type: application/json" -X DELETE "https://api.sb.biodatacatalyst.nhlbi.nih.gov/v2/storage/volumes/rfranklin/output"

Header Fields

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

Path parameters

KeyDescription of value
volume_idThe ID of the volume to delete.

Response

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

Example response body

{HTTP/1.1 204 No Content
Date: Tue, 29 Mar 2016 15:47:44 GMT
Connection: close