Give Feedback

pydo.image_actions.post()

Generated on 9 Jun 2026 from pydo version v0.36.0

Copy page as Markdown View page as Markdown

Usage

client.image_actions.post(
    image_id=62137902,
    body={
        "type": "convert",
        "region": "nyc3",
    },
)

Returns JSONRaises HttpResponseError

Description

The following actions are available on an Image.

Convert an Image to a Snapshot

To convert an image, for example, a backup to a snapshot, send a POST request to /v2/images/{image_id}/actions. Set the type attribute to convert.

Transfer an Image

To transfer an image to another region, send a POST request to /v2/images/{image_id}/actions. Set the type attribute to transfer and set region attribute to the slug identifier of the region you wish to transfer to.

Parameters

image_id integer required

A unique number that can be used to identify and reference a specific image.

type string required

The action to be taken on the image. Can be either convert or transfer.

One of: convert, transfer

region string optional

The slug identifier for the region where the resource will initially be available.

One of: ams1, ams2, ams3, blr1, fra1, lon1, nyc1, nyc2, nyc3, sfo1, sfo2, sfo3, sgp1, tor1, syd1

Request Sample

Show Request Sample

import os
from pydo import Client

client = Client(token=os.environ.get("DIGITALOCEAN_TOKEN"))

req = {
  "type": "convert"
}
resp = client.image_actions.post(image_id=342341, body=req)

Response Example

Show Response Example

{
  "action": {
    "id": 36805527,
    "status": "in-progress",
    "type": "transfer",
    "started_at": "2014-11-14T16:42:45Z",
    "completed_at": null,
    "resource_id": 7938269,
    "resource_type": "image",
    "region": {
      "name": "New York 3",
      "slug": "nyc3",
      "sizes": [
        "s-1vcpu-3gb",
        "m-1vcpu-8gb",
        "s-3vcpu-1gb",
        "s-1vcpu-2gb",
        "s-2vcpu-2gb",
        "s-2vcpu-4gb",
        "s-4vcpu-8gb",
        "s-6vcpu-16gb",
        "s-8vcpu-32gb",
        "s-12vcpu-48gb",
        "s-16vcpu-64gb",
        "s-20vcpu-96gb",
        "s-1vcpu-1gb",
        "c-1vcpu-2gb",
        "s-24vcpu-128gb"
      ],
      "features": [
        "private_networking",
        "backups",
        "ipv6",
        "metadata",
        "server_id",
        "install_agent",
        "storage",
        "image_transfer"
      ],
      "available": true
    },
    "region_slug": "nyc3"
  }
}

More Information

See /v2/images/{image_id}/actions in the API reference for additional detail on responses, headers, parameters, and more.