Sign in

v8

latestOpenAPI 3.0.0Apache 2.0raw.githubusercontent.com2025-10-165266542.4 MB
DigitalOcean-public.v2-new_Droplet Actions

Initiate a Droplet Action

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:

ActionDetailsAdditionally Required Permission
<nobr>enable_backups</nobr>Enables backups for a Droplet
<nobr>disable_backups</nobr>Disables backups for a Droplet
<nobr>change_backup_policy</nobr>Update the backup policy for a Droplet
<nobr>reboot</nobr>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.
<nobr>power_cycle</nobr>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.
<nobr>shutdown</nobr>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.
<nobr>power_off</nobr>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.
<nobr>power_on</nobr>Powers on a Droplet.
<nobr>restore</nobr>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.droplet:admin
<nobr>password_reset</nobr>Resets the root password for a Droplet. A new password will be provided via email. It must be changed after first use.droplet:admin
<nobr>resize</nobr>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.droplet:create
<nobr>rebuild</nobr>Rebuilds a Droplet from a new base image. Set the image attribute to an image ID or slug.droplet:admin
<nobr>rename</nobr>Renames a Droplet.
<nobr>change_kernel</nobr>Changes a Droplet's kernel. Only applies to Droplets with externally managed kernels. All Droplets created after March 2017 use internal kernels by default.
<nobr>enable_ipv6</nobr>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.
<nobr>snapshot</nobr>Takes a snapshot of a Droplet.image:create
post/v2/droplets/{droplet_id}/actions

Path parameters

droplet_idinteger required

A unique identifier for a Droplet instance.

Request body

OR
OR
OR
OR
OR
OR
OR
OR

Example request

{
  "type": "reboot"
}

Response

The response will be a JSON object with a key called action.

Example response

{
  "action": {
    "id": 36804636,
    "status": "completed",
    "type": "create",
    "started_at": "2020-11-14T16:29:21Z",
    "completed_at": "2020-11-14T16:30:06Z",
    "resource_id": 3164444,
    "resource_type": "droplet",
    "region": {
      "name": "New York 3",
      "slug": "nyc3",
      "features": [
        "private_networking",
        "backups",
        "ipv6",
        "metadata",
        "install_agent",
        "storage",
        "image_transfer"
      ],
      "available": true,
      "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"
      ]
    },
    "region_slug": "nyc3"
  }
}