Skip to content

Delete a Block Storage Volume by Name

client.GPUDroplets.Volumes.DeleteByName(ctx, body) error
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
body GPUDropletVolumeDeleteByNameParams
Name param.Field[string]optional

The block storage volume's name.

Region param.Field[GPUDropletVolumeDeleteByNameParamsRegion]optional

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

const GPUDropletVolumeDeleteByNameParamsRegionAms1 GPUDropletVolumeDeleteByNameParamsRegion = "ams1"
const GPUDropletVolumeDeleteByNameParamsRegionAms2 GPUDropletVolumeDeleteByNameParamsRegion = "ams2"
const GPUDropletVolumeDeleteByNameParamsRegionAms3 GPUDropletVolumeDeleteByNameParamsRegion = "ams3"
const GPUDropletVolumeDeleteByNameParamsRegionBlr1 GPUDropletVolumeDeleteByNameParamsRegion = "blr1"
const GPUDropletVolumeDeleteByNameParamsRegionFra1 GPUDropletVolumeDeleteByNameParamsRegion = "fra1"
const GPUDropletVolumeDeleteByNameParamsRegionLon1 GPUDropletVolumeDeleteByNameParamsRegion = "lon1"
const GPUDropletVolumeDeleteByNameParamsRegionNyc1 GPUDropletVolumeDeleteByNameParamsRegion = "nyc1"
const GPUDropletVolumeDeleteByNameParamsRegionNyc2 GPUDropletVolumeDeleteByNameParamsRegion = "nyc2"
const GPUDropletVolumeDeleteByNameParamsRegionNyc3 GPUDropletVolumeDeleteByNameParamsRegion = "nyc3"
const GPUDropletVolumeDeleteByNameParamsRegionSfo1 GPUDropletVolumeDeleteByNameParamsRegion = "sfo1"
const GPUDropletVolumeDeleteByNameParamsRegionSfo2 GPUDropletVolumeDeleteByNameParamsRegion = "sfo2"
const GPUDropletVolumeDeleteByNameParamsRegionSfo3 GPUDropletVolumeDeleteByNameParamsRegion = "sfo3"
const GPUDropletVolumeDeleteByNameParamsRegionSgp1 GPUDropletVolumeDeleteByNameParamsRegion = "sgp1"
const GPUDropletVolumeDeleteByNameParamsRegionTor1 GPUDropletVolumeDeleteByNameParamsRegion = "tor1"
const GPUDropletVolumeDeleteByNameParamsRegionSyd1 GPUDropletVolumeDeleteByNameParamsRegion = "syd1"
Delete a Block Storage Volume by Name
package main

import (
  "context"

  "github.com/stainless-sdks/-go"
  "github.com/stainless-sdks/-go/option"
)

func main() {
  client := gradient.NewClient(
    option.WithAccessToken("My Access Token"),
  )
  err := client.GPUDroplets.Volumes.DeleteByName(context.TODO(), gradient.GPUDropletVolumeDeleteByNameParams{

  })
  if err != nil {
    panic(err.Error())
  }
}
Returns Examples