POST /v2/droplets/{droplet_id}/actions
To initiate an action on a Droplet send a POST request to
/v2/droplets/$DROPLET_ID/actions. In the JSON body to the request,
set the type attribute to on of the supported action types:
| Action | Details |
|---|---|
enable_backups | Enables backups for a Droplet |
disable_backups | Disables backups for a Droplet |
change_backup_policy | Update the backup policy for a Droplet |
reboot | Reboots a Droplet. A reboot action is an attempt to reboot the Droplet in a graceful way, similar to using the reboot command from the console. |
power_cycle | Power cycles a Droplet. A powercycle action is similar to pushing the reset button on a physical machine, it's similar to booting from scratch. |
shutdown | Shutsdown a Droplet. A shutdown action is an attempt to shutdown the Droplet in a graceful way, similar to using the shutdown command from the console. Since a shutdown command can fail, this action guarantees that the command is issued, not that it succeeds. The preferred way to turn off a Droplet is to attempt a shutdown, with a reasonable timeout, followed by a power_off action to ensure the Droplet is off. |
power_off | Powers off a Droplet. A power_off event is a hard shutdown and should only be used if the shutdown action is not successful. It is similar to cutting the power on a server and could lead to complications. |
power_on | Powers on a Droplet. |
restore | Restore a Droplet using a backup image. The image ID that is passed in must be a backup of the current Droplet instance. The operation will leave any embedded SSH keys intact. |
password_reset | Resets the root password for a Droplet. A new password will be provided via email. It must be changed after first use. |
resize | Resizes a Droplet. Set the size attribute to a size slug. If a permanent resize with disk changes included is desired, set the disk attribute to true. |
rebuild | Rebuilds a Droplet from a new base image. Set the image attribute to an image ID or slug. |
rename | Renames a Droplet. |
change_kernel | Changes a Droplet's kernel. Only applies to Droplets with externally managed kernels. All Droplets created after March 2017 use internal kernels by default. |
enable_ipv6 | Enables IPv6 for a Droplet. Once enabled for a Droplet, IPv6 can not be disabled. When enabling IPv6 on an existing Droplet, additional OS-level configuration is required. |
snapshot | Takes a snapshot of a Droplet. |
Servers
- https://api.digitalocean.com
Path parameters
| Name | Type | Required | Description |
|---|---|---|---|
droplet_id |
Integer | Yes |
A unique identifier for a Droplet instance. |
Request headers
| Name | Type | Required | Description |
|---|---|---|---|
Content-Type |
String | Yes |
The media type of the request body.
Default value: "application/json" |
How to start integrating
- Add HTTP Task to your workflow definition.
- Search for the API you want to integrate with and click on the name.
- This loads the API reference documentation and prepares the Http request settings.
- Click Test request to test run your request to the API and see the API's response.