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 CAVATICA. 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 CAVATICA.

Request

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

Example request

PATCH /v2/storage/volumes/rfranklin/output HTTP/1.1
Host: cavatica-api.sbgenomics.com
X-SBG-Auth-Token: 3259c50e1ac5426ea8f1273259740f75
Content-Type: application/json

curl  - -data '@patch-volume.json' -s -H "X-SBG-Auth-Token: 6282d5e2121d43e7900e9d52b15845e7" -H "Content-Type: application/json" -X PATCH "https://cavatica-api.sbgenomics.com/storage/volumes/rfranklin/output"

Header Fields

Key	Description of value
`X-SBG-Auth-Token` required	Your CAVATICA authentication token.
`Content-type` required	`application/json`

Path parameters

Key	Description of value
`volume_id`	The volume that you want to update.

Query parameters

Key	Description of value
`force`	Set 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.

Key	Data type of value	Description of value
`active`	String	Set 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
}

Response

See a list of CAVATICA-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:

Key	Data type of value	Description of value
`active`	Boolean	If a volume is deactivated, this field will be set to false
`id`	String	ID of this volume, containing owner/name
`name`	String	Name of the volume.
`description`	String	The description of this volume.
`created_on`	String	The date and time this volume was created.
`modified_on`	String	The date and time this volume was last modified.

Example response body

{
  "href": "https://cavatica-api.sbgenomics.com/v2/storage/volumes/rfranklin/output",
  "id": "rfranklin/my-volume",
  "name": "my-volume",
  "access_mode": "RW",
  "service": {
    "type": "S3",
    "bucket": "my_bucket",
    "prefix": "input-files",
    "endpoint": "s3.amazonaws.com",
    "credentials": {
      "access_key_id": "AKIAJRC7TPMRMEAMPLE"
    },
    "properties": {
      "sse_algorithm": "AES256"
    }
   },
  "created_on": "2017-05-09T16:19:10Z",
  "modified_on": "2017-05-24T09:27:41Z",
  "active": false
}