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 ParametersExpand Collapse

volume_id: string

formatuuid

ReturnsExpand Collapse

volume: optional object { id, created_at, description, 7 more }

id: optional string

The unique identifier for the block storage volume.

created_at: optional string

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

description: optional string

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

droplet_ids: optional array of number

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_label: optional string

The label currently applied to the filesystem.

filesystem_type: optional string

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

name: optional string

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.

region: optional Region { available, features, name, 2 more }

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.

available: boolean

This is a boolean value that represents whether new Droplets can be created in this region.

features: array of string

This attribute is set to an array which contains features available in this region

name: string

The display name of the region. This will be a full name that is used in the control panel and other interfaces.

sizes: array of string

This attribute is set to an array which contains the identifying slugs for the sizes available in this region. sizes:read is required to view.

slug: string

A human-readable string that is used as a unique identifier for each region.

size_gigabytes: optional number

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

tags: optional array of string

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

Requires tag:read scope.

Retrieve an Existing Block Storage Volume

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

{
  "volume": {
    "id": "506f78a4-e098-11e5-ad9f-000f53306ae1",
    "created_at": "2020-03-02T17:00:49Z",
    "description": "Block store for examples",
    "droplet_ids": [
      0
    ],
    "filesystem_label": "example",
    "filesystem_type": "ext4",
    "name": "example",
    "region": {
      "available": true,
      "features": [
        "private_networking",
        "backups",
        "ipv6",
        "metadata"
      ],
      "name": "New York 1",
      "sizes": [
        "s-1vcpu-1gb",
        "s-1vcpu-2gb",
        "s-1vcpu-3gb",
        "s-2vcpu-2gb",
        "s-3vcpu-1gb",
        "s-2vcpu-4gb",
        "s-4vcpu-8gb",
        "s-6vcpu-16gb",
        "s-8vcpu-32gb",
        "s-12vcpu-48gb",
        "s-16vcpu-64gb",
        "s-20vcpu-96gb",
        "s-24vcpu-128gb",
        "s-32vcpu-192gb"
      ],
      "slug": "nyc1"
    },
    "size_gigabytes": 10,
    "tags": [
      "base-image",
      "prod"
    ]
  }
}

Returns Examples

{
  "volume": {
    "id": "506f78a4-e098-11e5-ad9f-000f53306ae1",
    "created_at": "2020-03-02T17:00:49Z",
    "description": "Block store for examples",
    "droplet_ids": [
      0
    ],
    "filesystem_label": "example",
    "filesystem_type": "ext4",
    "name": "example",
    "region": {
      "available": true,
      "features": [
        "private_networking",
        "backups",
        "ipv6",
        "metadata"
      ],
      "name": "New York 1",
      "sizes": [
        "s-1vcpu-1gb",
        "s-1vcpu-2gb",
        "s-1vcpu-3gb",
        "s-2vcpu-2gb",
        "s-3vcpu-1gb",
        "s-2vcpu-4gb",
        "s-4vcpu-8gb",
        "s-6vcpu-16gb",
        "s-8vcpu-32gb",
        "s-12vcpu-48gb",
        "s-16vcpu-64gb",
        "s-20vcpu-96gb",
        "s-24vcpu-128gb",
        "s-32vcpu-192gb"
      ],
      "slug": "nyc1"
    },
    "size_gigabytes": 10,
    "tags": [
      "base-image",
      "prod"
    ]
  }
}