## List

`gpu_droplets.volumes.list(VolumeListParams**kwargs)  -> VolumeListResponse`

**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

- **name:** `str`

  The block storage volume's name.

- **page:** `int`

  Which 'page' of paginated results to return.

- **per\_page:** `int`

  Number of items returned per page

- **region:** `Literal["ams1", "ams2", "ams3", 12 more]`

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

  - `"ams1"`

  - `"ams2"`

  - `"ams3"`

  - `"blr1"`

  - `"fra1"`

  - `"lon1"`

  - `"nyc1"`

  - `"nyc2"`

  - `"nyc3"`

  - `"sfo1"`

  - `"sfo2"`

  - `"sfo3"`

  - `"sgp1"`

  - `"tor1"`

  - `"syd1"`

### Returns

- `class VolumeListResponse`

  - **meta:** `MetaProperties`

    Information about the response itself.

  - **volumes:** `List[Volume]`

    Array of volumes.

    - **id:** `Optional[str]`

      The unique identifier for the block storage volume.

    - **created\_at:** `Optional[str]`

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

    - **description:** `Optional[str]`

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

    - **droplet\_ids:** `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\_label:** `Optional[str]`

      The label currently applied to the filesystem.

    - **filesystem\_type:** `Optional[str]`

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

    - **name:** `Optional[str]`

      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]`

      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\_gigabytes:** `Optional[int]`

      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[List[str]]`

      A flat array of tag names as strings applied to the resource. <br><br>Requires `tag:read` scope.

  - **links:** `Optional[PageLinks]`

### Example

```python
from do_gradientai import GradientAI

client = GradientAI()
volumes = client.gpu_droplets.volumes.list()
print(volumes.meta)
```