Skip to content
  • Auto
  • Light
  • Dark

Delete By Tag

Deleting Droplets by Tag
client.gpuDroplets.deleteByTag(GPUDropletDeleteByTagParams { tag_name } params, RequestOptionsoptions?): void
delete/v2/droplets

To delete all Droplets assigned to a specific tag, include the tag_name query parameter set to the name of the tag in your DELETE request. For example, /v2/droplets?tag_name=$TAG_NAME.

This endpoint requires tag:read scope.

A successful request will receive a 204 status code with no body in response. This indicates that the request was processed successfully.

ParametersExpand Collapse
params: GPUDropletDeleteByTagParams { tag_name }
tag_name: string

Specifies Droplets to be deleted by tag.

Deleting Droplets by Tag
import Gradient from '@digitalocean/gradient';

const client = new Gradient();

await client.gpuDroplets.deleteByTag({ tag_name: 'tag_name' });
Returns Examples