Skip to content
  • Auto
  • Light
  • Dark

List

List All Actions for an Image
gpu_droplets.images.actions.list(intimage_id) -> ActionListResponse
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.

ParametersExpand Collapse
image_id: int
ReturnsExpand Collapse
class ActionListResponse:

Information about the response itself.

total: Optional[int]

Number of objects returned by the request.

actions: Optional[List[Action]]
id: Optional[int]

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

completed_at: Optional[datetime]

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

formatdate-time
region: Optional[Region]
available: bool

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

features: List[str]

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

name: str

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

sizes: List[str]

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: str

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

region_slug: Optional[str]

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

resource_id: Optional[int]

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

resource_type: Optional[str]

The type of resource that the action is associated with.

started_at: Optional[datetime]

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

formatdate-time
status: Optional[Literal["in-progress", "completed", "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[str]

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.

Accepts one of the following:

URI of the last page of the results.

URI of the next page of the results.

URI of the first page of the results.

URI of the previous page of the results.

List All Actions for an Image
from gradient import Gradient

client = Gradient()
actions = client.gpu_droplets.images.actions.list(
    0,
)
print(actions.meta)
{
  "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"
    }
  }
}