Give Feedback

image_action

Generated on 11 Feb 2026 from digitalocean.cloud version v1.2.1

Synopsis

Perform actions on images such as transfer and convert. View the API documentation at https://docs.digitalocean.com/reference/api/api-reference/#tag/Image-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.
`image_id` int / required		The unique identifier of the image.
`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.
`region` str		The slug identifier for the region to transfer the image to. Required when type is `transfer`.
`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`
`type` str / required	Choices: `transfer` `convert`	The type of action to perform.

Examples

- name: Transfer image to another region
  digitalocean.cloud.image_action:
    token: "{{ token }}"
    image_id: 12345678
    type: transfer
    region: sfo2

- name: Convert image to snapshot
  digitalocean.cloud.image_action:
    token: "{{ token }}"
    image_id: 12345678
    type: convert

Return Values

Key Returned Description

Key	Returned	Description
`action` dict	always	Image action information. Sample: `{ "completed_at": null, "id": 12345678, "region": { "available": true, "features": [], "name": "San Francisco 2", "sizes": [], "slug": "sfo2" }, "resource_id": 7555620, "resource_type": "image", "started_at": "2020-03-13T19:20:47.442049222Z", "status": "in-progress", "type": "transfer" }`
`error` dict	failure	DigitalOcean API error. Sample: `{ "Message": "Informational error message.", "Reason": "Unauthorized", "Status Code": 401 }`
`msg` str	always	Image action result information. Sample: `[ "Initiated transfer action on image", "Initiated convert action on image" ]`

action
dict

always

Image action information.
Sample:

{
  "completed_at": null,
  "id": 12345678,
  "region": {
    "available": true,
    "features": [],
    "name": "San Francisco 2",
    "sizes": [],
    "slug": "sfo2"
  },
  "resource_id": 7555620,
  "resource_type": "image",
  "started_at": "2020-03-13T19:20:47.442049222Z",
  "status": "in-progress",
  "type": "transfer"
}

error
dict

failure

DigitalOcean API error.
Sample:

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

msg
str