pydo.droplet_actions.post_by_tag()

Description

Some actions can be performed in bulk on tagged Droplets. The actions can be initiated by sending a POST to /v2/droplets/actions?tag_name=$TAG_NAME with the action arguments.

Only a sub-set of action types are supported:

  • power_cycle
  • power_on
  • power_off
  • shutdown
  • enable_ipv6
  • enable_backups
  • disable_backups
  • snapshot

Parameters

Name Type Required Description Default Value
tag_name string False Used to filter Droplets by a specific tag. Can not be combined with name or type.
body JSON or IO[bytes] False The type attribute set in the request body will specify the action that
will be taken on the Droplet. Some actions will require additional
attributes to be set as well.

Request Sample

import os
from pydo import Client

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

req = {
"type": "enable_backups"
}

resp = client.droplet_actions.post_by_tag(tag_name="production",body=req)

More Information

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

In this article...