Skip to content
  • Auto
  • Light
  • Dark

Delete By Name

Delete a Block Storage Volume by Name
client.gpuDroplets.volumes.deleteByName(VolumeDeleteByNameParams { name, region } params?, RequestOptionsoptions?): void
delete/v2/volumes

Block storage volumes may also be deleted by name by sending a DELETE 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. No response body will be sent back, but the response code will indicate success. Specifically, the response code will be a 204, which means that the action was successful with no returned body data.

ParametersExpand Collapse
params: VolumeDeleteByNameParams { name, region }
name?: string

The block storage volume's name.

region?: "ams1" | "ams2" | "ams3" | 12 more

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

Accepts one of the following:
"ams1"
"ams2"
"ams3"
"blr1"
"fra1"
"lon1"
"nyc1"
"nyc2"
"nyc3"
"sfo1"
"sfo2"
"sfo3"
"sgp1"
"tor1"
"syd1"
Delete a Block Storage Volume by Name
import Gradient from '@digitalocean/gradient';

const client = new Gradient();

await client.gpuDroplets.volumes.deleteByName();
Returns Examples