Skip to content
Gradient SDK Docs
  • Auto
  • Light
  • Dark

List

List All Block Storage Volumes
gpu_droplets.volumes.list(VolumeListParams**kwargs) -> metaMetaPropertiesvolumeslistlinksPageLinksVolumeListResponse
get/v2/volumes

To list all of the block storage volumes available on your account, send a GET request to /v2/volumes.

Filtering Results

By Region

The region may be provided as query parameter in order to restrict results to volumes available in a specific region. For example: /v2/volumes?region=nyc1

By Name

It is also possible to list volumes on your account that match a specified name. To do so, send a GET request with the volume's name as a query parameter to /v2/volumes?name=$VOLUME_NAME. Note: You can only create one volume per region with the same name.

By Name and Region

It is also possible to retrieve information about a block storage volume by name. To do so, send a GET request with the volume's name and the region slug for the region it is located in as query parameters to /v2/volumes?name=$VOLUME_NAME&region=nyc1.

Parameters
namestr
optional

The block storage volume's name.

pageint
optional

Which 'page' of paginated results to return.

minimum1
per_pageint
optional

Number of items returned per page

minimum1
maximum200
regionliteral
optional
Literal["ams1", "ams2", "ams3", 12 more]

The slug identifier for the region where the resource is available.

Hide ParametersShow Parameters
"ams1"
"ams2"
"ams3"
"blr1"
"fra1"
"lon1"
"nyc1"
"nyc2"
"nyc3"
"sfo1"
"sfo2"
"sfo3"
"sgp1"
"tor1"
"syd1"
Returns
VolumeListResponseclass
Hide ParametersShow Parameters
metatotalintMetaProperties

Information about the response itself.

volumeslist
List[Volume]

Array of volumes.

Hide ParametersShow Parameters
idstr
optional

The unique identifier for the block storage volume.

created_atstr
optional

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

descriptionstr
optional

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

droplet_idslist
optional
Optional[List[int]]

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_labelstr
optional

The label currently applied to the filesystem.

filesystem_typestr
optional

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

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

regionRegion
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_gigabytesint
optional

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

tagslist
optional
Optional[List[str]]

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

Requires tag:read scope.

from do_gradientai import GradientAI

client = GradientAI()
volumes = client.gpu_droplets.volumes.list()
print(volumes.meta)
200 Example
{
  "volumes": [
    {
      "id": "506f78a4-e098-11e5-ad9f-000f53306ae1",
      "region": {
        "name": "New York 1",
        "slug": "nyc1",
        "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"
        ],
        "features": [
          "private_networking",
          "backups",
          "ipv6",
          "metadata"
        ],
        "available": true
      },
      "droplet_ids": [],
      "name": "example",
      "description": "Block store for examples",
      "size_gigabytes": 10,
      "created_at": "2016-03-02T17:00:49Z",
      "filesystem_type": "ext4",
      "filesystem_label": "example",
      "tags": [
        "aninterestingtag"
      ]
    },
    {
      "id": "506f78a4-e098-11e5-ad9f-000f53305eb2",
      "region": {
        "name": "New York 3",
        "slug": "nyc3",
        "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"
        ],
        "features": [
          "private_networking",
          "backups",
          "ipv6",
          "metadata"
        ],
        "available": true
      },
      "droplet_ids": [],
      "name": "example",
      "description": "Block store for examples",
      "size_gigabytes": 10,
      "created_at": "2016-03-02T17:01:49Z",
      "filesystem_type": "ext4",
      "filesystem_label": "example",
      "tags": [
        "aninterestingtag"
      ]
    }
  ],
  "links": {},
  "meta": {
    "total": 2
  }
}