Skip to content
  • Auto
  • Light
  • Dark

Bulk Initiate

Acting on Tagged Droplets
post/v2/droplets/actions

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 (also requires image:create permission)
Query Parameters
tag_namestring
optional

Used to filter Droplets by a specific tag. Can not be combined with name or type.
Requires tag:read scope.

Body Parameters
bodyunion
optional

Specifies the action that will be taken on the Droplet.

One of the following 2 object variants:
Hide ParametersShow Parameters
DropletActionobject

Specifies the action that will be taken on the Droplet.

Hide ParametersShow Parameters
typeenum
"enable_backups" OR "disable_backups" OR "reboot" OR 12 more

The type of action to initiate for the Droplet.

Hide ParametersShow Parameters
"enable_backups"
"disable_backups"
"reboot"
"power_cycle"
"shutdown"
"power_off"
"power_on"
"restore"
"password_reset"
"resize"
"rebuild"
"rename"
"change_kernel"
"enable_ipv6"
"snapshot"
DropletActionSnapshotobject
Hide ParametersShow Parameters
typeenum
"enable_backups" OR "disable_backups" OR "reboot" OR 12 more

The type of action to initiate for the Droplet.

Hide ParametersShow Parameters
"enable_backups"
"disable_backups"
"reboot"
"power_cycle"
"shutdown"
"power_off"
"power_on"
"restore"
"password_reset"
"resize"
"rebuild"
"rename"
"change_kernel"
"enable_ipv6"
"snapshot"
namestring
optional

The name to give the new snapshot of the Droplet.

Returns
actionsarray of idnumbercompleted_atstringregionRegionregion_slugstringresource_idnumberresource_typestringstarted_atstringstatusenumtypestringAction
optional
curl https://api.digitalocean.com//v2/droplets/actions \
    -H 'Content-Type: application/json' \
    -H "Authorization: Bearer $GRADIENTAI_API_KEY"
200 Example
{
  "actions": [
    {
      "id": 36804636,
      "completed_at": "2020-11-14T16:30:06Z",
      "region": {
        "available": true,
        "features": [
          "private_networking",
          "backups",
          "ipv6",
          "metadata",
          "install_agent",
          "storage",
          "image_transfer"
        ],
        "name": "New York 3",
        "sizes": [
          "s-1vcpu-1gb",
          "s-1vcpu-2gb",
          "s-1vcpu-3gb",
          "s-2vcpu-2gb",
          "s-3vcpu-1gb",
          "s-2vcpu-4gb",
          "s-4vcpu-8gb",
          "s-6vcpu-16gb",
          "s-8vcpu-32gb",
          "s-12vcpu-48gb",
          "s-16vcpu-64gb",
          "s-20vcpu-96gb",
          "s-24vcpu-128gb",
          "s-32vcpu-192g"
        ],
        "slug": "nyc3"
      },
      "region_slug": "nyc3",
      "resource_id": 3164444,
      "resource_type": "droplet",
      "started_at": "2020-11-14T16:29:21Z",
      "status": "completed",
      "type": "create"
    }
  ]
}