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®ion=nyc1
.
Servers
- https://api.digitalocean.com
Query parameters
Name | Type | Required | Description |
---|---|---|---|
page |
Integer | No |
Which 'page' of paginated results to return. Default value: 1 |
region |
String | No |
The slug identifier for the region where the resource is available. Possible values:
|
name |
String | No |
The block storage volume's name. |
per_page |
Integer | No |
Number of items returned per page Default value: 20 |
How to start integrating
- Add HTTP Task to your workflow definition.
- Search for the API you want to integrate with and click on the name.
- This loads the API reference documentation and prepares the Http request settings.
- Click Test request to test run your request to the API and see the API's response.