Update a volume

patch

https://api.sbgenomics.com/v2/storage/volumes/{volume_owner}/{volume_name}

This call updates the details of a specific volume.

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

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

📘
If you are using Seven Bridges Platform EU, please use the following endpoint: https://eu-api.sbgenomics.com/v2/storage/volumes/{volume_owner}/{volume_name}

Example request body

{
  "description": null,
  "service": {
    "properties": {
      "sse_algorithm": "AES256"
    }
  },
}

Response

See a list of Seven Bridges Platform-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 `volume_owner/volume_name`.
`name`	String	Name of the volume.
`description`	String	The description of this volume.
`service`	Object	This object more closely describes the mapping of the volume to the cloud service where the data is stored.
`created_on`	String	The date and time this volume was created.
`modified_on`	String	The date and time this volume was last modified.

👍
Note that you cannot view volumes that you have created via the visual interface. However, you can see all your volumes by making the call to list volumes.

Path Params

volume_owner

string

required

Username of the volume owner.

volume_name

string

required

The name of the volume you want to update.

Body Params

access_mode

string

Defaults to RW

Signifies whether this volume should be used for read-write ("RW") or read-only ("RO") operations. The access mode is consulted independently of the credentials granted to Seven Bridges when the volume was created, so it is possible to use a read-write credentials to register both read-write and read-only volumes using it. default: "RW"

description

string

An optional description of this volume.

service

object

This object should contain the information about the cloud service that this volume represents.

Headers

X-SBG-Auth-Token

string

required

Your Seven Bridges Platform authentication token. For security reasons, token will not be automatically populated in the generated code sample. Please replace <your-token-here> with your token before executing this call.

Response

If you are using Seven Bridges Platform EU, please use the following endpoint: https://eu-api.sbgenomics.com/v2/storage/volumes/{volume_owner}/{volume_name}

Example request body

Response

Response body

Note that you cannot view volumes that you have created via the visual interface. However, you can see all your volumes by making the call to list volumes.

200200

If you are using Seven Bridges Platform EU, please use the following endpoint: `https://eu-api.sbgenomics.com/v2/storage/volumes/{volume_owner}/{volume_name}`