pydo.droplets.destroy_by_tag()

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.

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

Parameters

Request Sample

import os
from pydo import Client

client = Client(token=os.environ.get("DIGITALOCEAN_TOKEN"))

resp = client.droplets.destroy_by_tag(tag_name="production")

Responses

See the API spec for this endpoint to view additional detail on responses, headers, parameters, and more.

{
  "id": "unauthorized",
  "message": "Unable to authenticate you."
}

{
  "id": "not_found",
  "message": "The resource you requested could not be found."
}

{
  "id": "too_many_requests",
  "message": "API Rate limit exceeded."
}

{
  "id": "server_error",
  "message": "Unexpected server-side error"
}

{
  "id": "example_error",
  "message": "some error message"
}