Sign in

v8

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

Initiate an Image Action

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.

post/v2/images/{image_id}/actions

Path parameters

image_idinteger required

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

Request body

OR

Example request

{
  "type": "convert"
}

Response

The response will be a JSON object with a key called action. The value of this will be an object containing the standard image action attributes.

idinteger

A unique numeric ID that can be used to identify and reference an action.

status'in-progress' | 'completed' | 'errored'

The current status of the action. This can be "in-progress", "completed", or "errored".

typestring

This is the type of action that the object represents. For example, this could be "transfer" to represent the state of an image transfer action.

started_atstring date-time

A time value given in ISO8601 combined date and time format that represents when the action was initiated.

completed_atstring date-time nullable

A time value given in ISO8601 combined date and time format that represents when the action was completed.

resource_idinteger nullable

A unique identifier for the resource that the action is associated with.

resource_typestring

The type of resource that the action is associated with.

region_slugstring nullable

A human-readable string that is used as a unique identifier for each region.

Example response

{
  "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"
}