DigitalOcean API (unofficial showcase)
POST/v2/droplets/actions

Trigger an action on tagged Droplets

Triggers a supported action on Droplets that match a tag. Set the action type in the request body; bulk actions support power, shutdown, IPv6, backup, and snapshot operations, with IPv6 enablement requiring the Droplet to be powered off. A 201 response includes an action object for each affected Droplet.

  • IdempotentThe SDK sends Idempotency-Key, so a retried request is only applied once.

1 parameter · 1 body field
tag_namestringoptional
Filter the affected Droplets by tag. Requires the `tag:read` scope and cannot be combined with `name` or `type` filters.

Optional JSON action payload. Include the required type and any additional attributes required by the selected action.

typestringrequired
The type of action to initiate for the Droplet.
Allowed:enable_backupsdisable_backupsrebootpower_cycleshutdownpower_offpower_onrestorepassword_resetresizerebuildrename

5 status codes
201Returns an array of action objects, each with its identifier, status, type, start and completion times, resource details, and region.
actionsarray<object>optional
401Returned when authentication credentials are invalid.
idstringrequired
A short identifier corresponding to the HTTP status code returned. For example, the ID for a response returning a 404 status code would be "not_found."
messagestringrequired
A message providing additional information about the error, including details to help resolve it when possible.
request_idstringoptional
Optionally, some endpoints may include a request ID that should be provided when reporting bugs or opening support tickets to help identify the issue.
429Returned when the API rate limit has been exceeded.
idstringrequired
A short identifier corresponding to the HTTP status code returned. For example, the ID for a response returning a 404 status code would be "not_found."
messagestringrequired
A message providing additional information about the error, including details to help resolve it when possible.
request_idstringoptional
Optionally, some endpoints may include a request ID that should be provided when reporting bugs or opening support tickets to help identify the issue.
500Returned when a server error occurs.
idstringrequired
A short identifier corresponding to the HTTP status code returned. For example, the ID for a response returning a 404 status code would be "not_found."
messagestringrequired
A message providing additional information about the error, including details to help resolve it when possible.
request_idstringoptional
Optionally, some endpoints may include a request ID that should be provided when reporting bugs or opening support tickets to help identify the issue.
defaultThere was an unexpected error.
idstringrequired
A short identifier corresponding to the HTTP status code returned. For example, the ID for a response returning a 404 status code would be "not_found."
messagestringrequired
A message providing additional information about the error, including details to help resolve it when possible.
request_idstringoptional
Optionally, some endpoints may include a request ID that should be provided when reporting bugs or opening support tickets to help identify the issue.

Error handling

A 401 indicates that authentication credentials are invalid; a 429 indicates that the API rate limit has been exceeded, and a 500 indicates a server error. The type body field must specify an action supported for bulk use, and the tag_name query parameter requires the tag:read scope. If you enable IPv6 on an existing Droplet, it must be powered off first.