List

List All Actions for an Image

get/v2/images/{image_id}/actions

To retrieve all actions that have been executed on an image, send a GET request to /v2/images/$IMAGE_ID/actions.

Path ParametersExpand Collapse

image_id: number

ReturnsExpand Collapse

meta: MetaProperties { total }

Information about the response itself.

total: optional number

Number of objects returned by the request.

actions: optional array of Action { 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.

links: optional PageLinks { pages }

pages: optional ForwardLinks { last, next } or BackwardLinks { first, prev } or unknown

Accepts one of the following:

ForwardLinks = object { last, next }

last: optional string

URI of the last page of the results.

next: optional string

URI of the next page of the results.

BackwardLinks = object { first, prev }

first: optional string

URI of the first page of the results.

prev: optional string

URI of the previous page of the results.

UnionMember2 = unknown

List All Actions for an Image

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

{
  "meta": {
    "total": 1
  },
  "actions": [
    {
      "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"
    }
  ],
  "links": {
    "pages": {
      "last": "https://api.digitalocean.com/v2/images?page=2",
      "next": "https://api.digitalocean.com/v2/images?page=2"
    }
  }
}

Returns Examples

{
  "meta": {
    "total": 1
  },
  "actions": [
    {
      "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"
    }
  ],
  "links": {
    "pages": {
      "last": "https://api.digitalocean.com/v2/images?page=2",
      "next": "https://api.digitalocean.com/v2/images?page=2"
    }
  }
}