Deactivate a volume

This call deactivates a volume. Note that this request is based off of the PATCH request to update a volume.

Once deactivated, you cannot import from, export to, or browse within a volume. As such, the content of the files imported from this volume will no longer be accessible on the CGC. However, you can update the volume and manage members. Note that you cannot deactivate the volume if you have running imports or exports unless you force the operation using the query parameter force=true, as described below.

Note that to delete a volume, first you must deactivate it and delete all files which have been imported from the volume to the CGC.


Example request

PATCH /v2/storage/volumes/rfranklin/output HTTP/1.1
X-SBG-Auth-Token: 3210a98c1db9318fa9d9273156740f74
Content-Type: application/json
curl  - -data '@patch-volume.json' -s -H "X-SBG-Auth-Token: 3210a98c1db9318fa9d9273156740f74" -H "Content-Type: application/json" -X PATCH ""

Header Fields

KeyDescription of value
Your CGC authentication token.

Path parameters

KeyDescription of value
volume_idThe volume that you want to update.

Query parameters

KeyDescription of value
forceSet this to true to force-quit ongoing import or export operations on a volume you intend to deactivate

Request body

In the body, you should enter a list of key-value pairs. The keys and the values they take are described in the following table.

KeyData type of valueDescription of value
activeStringSet this to false to deactivate the volume. Note that if there are ongoing import or export operations on the volume, you must force-quit the operations using the query parameter force=true.

Example request body

    "active": false


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

Response body

The response object contains information about the specified volume. The information is structured using the following key-value pairs:

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.
created_onStringThe date and time this volume was created.
modified_onStringThe date and time this volume was last modified.

Example response body

  "href": "",
  "id": "rfranklin/my-volume",
  "name": "my-volume",
  "access_mode": "RW",
  "service": {
    "type": "S3",
    "bucket": "my_bucket",
    "prefix": "input-files",
    "endpoint": "",
    "credentials": {
      "access_key_id": "AKIAJRC7TPMRMEXAMPLE"
    "properties": {
      "sse_algorithm": "AES256"
  "created_on": "2017-05-09T16:19:10Z",
  "modified_on": "2017-05-24T09:27:41Z",
  "active": false