images_info

Generated on 16 Jun 2025 from digitalocean.cloud version v1.2.1

Synopsis

List all of the images available on your account. View the API documentation at https://docs.digitalocean.com/reference/api/api-reference/#operation/images_list.

Requirements

  • pydo >= 0.1.3
  • azure-core >= 1.26.1

Parameters

Parameter Choices / Default Description
client_override_options
dict
Client override options (developer use). For example, can be used to override the DigitalOcean API endpoint for an internal test suite. If provided, these options will knock out existing options.
module_override_options
dict
Module override options (developer use). Can be used to override module options to support experimental or future options. If provided, these options will knock out existing options.
private
bool
Used to filter only user images.
state
str
Choices:
  • present (default)
  • absent
State of the resource, present to create, absent to destroy.
tag_name
str
Used to filter images by a specific tag.
timeout
int
Default: 300 Polling timeout in seconds.
token
str
DigitalOcean API token. There are several environment variables which can be used to provide this value. DIGITALOCEAN_ACCESS_TOKEN, DIGITALOCEAN_TOKEN, DO_API_TOKEN, DO_API_KEY, DO_OAUTH_TOKEN and OAUTH_TOKEN
type
str
Choices:
  • application
  • distribution
Filters results based on image type.

Examples

- name: Get images
  digitalocean.cloud.images_info:
    token: "{{ token }}"

Return Values

KeyReturnedDescription
error
dict
failure DigitalOcean API error.
Sample:
{
  "Message": "Informational error message.",
  "Reason": "Unauthorized",
  "Status Code": 401
}
images
list
always Images.
Sample:
[
  {
    "created_at": "2014-11-04T22:23:02Z",
    "description": "",
    "distribution": "Ubuntu",
    "error_message": "",
    "id": 7555620,
    "min_disk_size": 20,
    "name": "Nifty New Snapshot",
    "public": false,
    "regions": [],
    "size_gigabytes": 2.34,
    "slug": null,
    "status": "available",
    "tags": [],
    "type": "snapshot"
  }
]
msg
str
always Images result information.
Sample:
[
  "Current Droplets",
  "No Droplets"
]

We can't find any results for your search.

Try using different keywords or simplifying your search terms.