Retrieve

Retrieve an Existing Block Storage Volume

get/v2/volumes/{volume_id}

To show information about a block storage volume, send a GET request to /v2/volumes/$VOLUME_ID.

Path Parameters

volume_idstring

formatuuid

Returns

volumeobject

optional

Hide ParametersShow Parameters

idstring

optional

The unique identifier for the block storage volume.

created_atstring

optional

A time value given in ISO8601 combined date and time format that represents when the block storage volume was created.

descriptionstring

optional

An optional free-form text field to describe a block storage volume.

droplet_idsarray of number

optional

An array containing the IDs of the Droplets the volume is attached to. Note that at this time, a volume can only be attached to a single Droplet.

filesystem_labelstring

optional

The label currently applied to the filesystem.

filesystem_typestring

optional

The type of filesystem currently in-use on the volume.

namestring

optional

A human-readable name for the block storage volume. Must be lowercase and be composed only of numbers, letters and "-", up to a limit of 64 characters. The name must begin with a letter.

regionavailablebooleanfeaturesarray of stringnamestringsizesarray of stringslugstringRegion

optional

The region that the block storage volume is located in. When setting a region, the value should be the slug identifier for the region. When you query a block storage volume, the entire region object will be returned.

size_gigabytesnumber

optional

The size of the block storage volume in GiB (1024^3). This field does not apply when creating a volume from a snapshot.

tagsarray of string

optional

A flat array of tag names as strings applied to the resource.

Requires tag:read scope.

HTTPPython

curl https://api.digitalocean.com//v2/volumes/$VOLUME_ID \
    -H "Authorization: Bearer $GRADIENTAI_API_KEY"

200 Example

{
  "volume": {
    "description": "Block store for examples",
    "filesystem_label": "example",
    "filesystem_type": "ext4",
    "name": "example",
    "size_gigabytes": 10,
    "tags": [
      "base-image",
      "prod"
    ]
  }
}