Give Feedback

droplet_action_resize

Generated on 23 May 2025 from digitalocean.cloud version v1.2.1

Synopsis

Resize a Droplet. View the API documentation at https://docs.digitalocean.com/reference/api/api-reference/#tag/Droplet-Actions.

Requirements

pydo >= 0.1.3
azure-core >= 1.26.1

Parameters

Parameter	Choices / Default	Description
`client_override_options` dict		Client override options (developer use). For example, can be used to override the DigitalOcean API endpoint for an internal test suite. If provided, these options will knock out existing options.
`disk` bool / required		When true, the Droplet’s disk will be resized in addition to its RAM and CPU. This is a permanent change and cannot be reversed as a Droplet’s disk size cannot be decreased.
`droplet_id` int		A unique identifier for a Droplet instance. If provided, `name` and `region` are ignored.
`module_override_options` dict		Module override options (developer use). Can be used to override module options to support experimental or future options. If provided, these options will knock out existing options.
`name` str		The name of the Droplet to act on. If provided, must be unique and given with `region`.
`region` str		The name of the Droplet to act on. Required with `name`.
`size` str / required		The slug identifier for the size to which you wish to resize the Droplet.
`state` str	Choices: `present` (default) `absent`	State of the resource, `present` to create, `absent` to destroy.
`timeout` int	Default: `300`	Polling timeout in seconds.
`token` str		DigitalOcean API token. There are several environment variables which can be used to provide this value. `DIGITALOCEAN_ACCESS_TOKEN`, `DIGITALOCEAN_TOKEN`, `DO_API_TOKEN`, `DO_API_KEY`, `DO_OAUTH_TOKEN` and `OAUTH_TOKEN`

Examples

- name: Resize a Droplet without resizing disk
  digitalocean.cloud.droplet_action_resize:
    token: "{{ token }}"
    state: present
    id: 1122334455
    disk: false
    size: s-2vcpu-4gb

Return Values

Key Returned Description

Key	Returned	Description
`action` dict	always	DigitalOcean action information. Sample: `{ "completed_at": null, "id": 1882339039, "region": { "available": true, "features": [ "backups", "ipv6", "metadata", "install_agent", "storage", "image_transfer" ], "name": "New York 3", "sizes": [ "s-1vcpu-1gb", "s-1vcpu-1gb-amd", "s-1vcpu-1gb-intel", "and many more" ], "slug": "nyc3" }, "region_slug": "nyc3", "resource_id": 336851565, "resource_type": "droplet", "started_at": "2023-09-03T12:59:10Z", "status": "in-progress", "type": "resize" }`
`error` dict	failure	DigitalOcean API error. Sample: `{ "Message": "Informational error message.", "Reason": "Unauthorized", "Status Code": 401 }`
`msg` str	always	DigitalOcean action information. Sample: [ "No Droplet with ID 336851565", "No Droplet with name test-droplet-1 in nyc3", "Droplet test-droplet-1 (336851565) in nyc3 would be sent action 'resize', requested size is 's-2vcpu-4gb' and current size is 's-1vcpu-2gb'", "Droplet test-droplet-1 (336851565) in nyc3 would not be sent action 'resize', requested size is 's-1vcpu-2gb' and current size is 's-1vcpu-2gb'", "Droplet test-droplet-1 (336851565) in nyc3 not sent action 'resize', requested size is 's-2vcpu-4gb' and current size is 's-1vcpu-2gb'", "Droplet test-droplet-1 (336851565) in nyc3 sent action 'resize', new size is 's-2vcpu-4gb'", "Droplet test-droplet-1 (336851565) in nyc3 sent action 'resize' and it has not completed, status is 'in-progress'" ]

action
dict

always

DigitalOcean action information.
Sample:

{
  "completed_at": null,
  "id": 1882339039,
  "region": {
    "available": true,
    "features": [
      "backups",
      "ipv6",
      "metadata",
      "install_agent",
      "storage",
      "image_transfer"
    ],
    "name": "New York 3",
    "sizes": [
      "s-1vcpu-1gb",
      "s-1vcpu-1gb-amd",
      "s-1vcpu-1gb-intel",
      "and many more"
    ],
    "slug": "nyc3"
  },
  "region_slug": "nyc3",
  "resource_id": 336851565,
  "resource_type": "droplet",
  "started_at": "2023-09-03T12:59:10Z",
  "status": "in-progress",
  "type": "resize"
}

error
dict

failure

DigitalOcean API error.
Sample:

{
  "Message": "Informational error message.",
  "Reason": "Unauthorized",
  "Status Code": 401
}

msg
str