Create

Initiate an Image Action

post/v2/images/{image_id}/actions

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.

Path ParametersExpand Collapse

image_id: number

Body ParametersExpand Collapse

body: optional object { type } or object { region, type }

Accepts one of the following:

ImageActionBase = object { type }

type: "convert" or "transfer"

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

Accepts one of the following:

"convert"

"transfer"

ImageActionTransfer = object { region, type }

region: "ams1" or "ams2" or "ams3" or 12 more

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

Accepts one of the following:

"ams1"

"ams2"

"ams3"

"blr1"

"fra1"

"lon1"

"nyc1"

"nyc2"

"nyc3"

"sfo1"

"sfo2"

"sfo3"

"sgp1"

"tor1"

"syd1"

type: "convert" or "transfer"

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

Accepts one of the following:

"convert"

"transfer"

ReturnsExpand Collapse

Action = object { id, completed_at, region, 6 more }

id: optional number

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

completed_at: optional string

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

formatdate-time

region: optional Region { available, features, name, 2 more }

available: boolean

This is a boolean value that represents whether new Droplets can be created in this region.

features: array of string

This attribute is set to an array which contains features available in this region

name: string

The display name of the region. This will be a full name that is used in the control panel and other interfaces.

sizes: array of string

This attribute is set to an array which contains the identifying slugs for the sizes available in this region. sizes:read is required to view.

slug: string

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

region_slug: optional string

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

resource_id: optional number

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

resource_type: optional string

The type of resource that the action is associated with.

started_at: optional string

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

formatdate-time

status: optional "in-progress" or "completed" or "errored"

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

Accepts one of the following:

"in-progress"

"completed"

"errored"

type: optional string

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.

Initiate an Image Action

curl https://api.digitalocean.com/v2/images/$IMAGE_ID/actions \
    -H 'Content-Type: application/json' \
    -H "Authorization: Bearer $DIGITALOCEAN_ACCESS_TOKEN"

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

Returns Examples

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