For AI agents: The documentation index is at https://docs.digitalocean.com/llms.txt. Markdown versions of pages use the same URL with index.html.md in place of the HTML page (for example, append index.html.md to the directory path instead of opening the HTML document).

Usage

client.v2.droplets.delete(requestConfiguration?: RequestConfiguration<DropletsRequestBuilderDeleteQueryParameters>): Promise<void>

Description

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.

Parameters

tagName string required

Example: env:test

Specifies Droplets to be deleted by tag.

Request Sample

import { FetchRequestAdapter } from "@microsoft/kiota-http-fetchlibrary";
import {
    createDigitalOceanClient,
    DigitalOceanApiKeyAuthenticationProvider,
} from "@digitalocean/dots";

const authProvider = new DigitalOceanApiKeyAuthenticationProvider(process.env.DIGITALOCEAN_TOKEN!);
const adapter = new FetchRequestAdapter(authProvider);
const client = createDigitalOceanClient(adapter);

await client.v2.droplets.delete({
    queryParameters: {
        tagName: "env:test",
    },
});

More Information

See /v2/droplets in the API reference for additional detail on responses, headers, parameters, and more.