List

List All Images

gpu_droplets.images.list() ->

get/v2/images

To list all of the images available on your account, send a GET request to /v2/images.

Filtering Results

It's possible to request filtered results by including certain query parameters.

Image Type

Either 1-Click Application or OS Distribution images can be filtered by using the type query parameter.

Important: The type query parameter does not directly relate to the type attribute.

To retrieve only distribution images, include the type query parameter set to distribution, /v2/images?type=distribution.

To retrieve only application images, include the type query parameter set to application, /v2/images?type=application.

User Images

To retrieve only the private images of a user, include the private query parameter set to true, /v2/images?private=true.

Tags

To list all images assigned to a specific tag, include the tag_name query parameter set to the name of the tag in your GET request. For example, /v2/images?tag_name=$TAG_NAME.

Parameters

pageint

optional

Which 'page' of paginated results to return.

minimum1

per_pageint

optional

Number of items returned per page

minimum1

maximum200

privatebool

optional

Used to filter only user images.

tag_namestr

optional

Used to filter images by a specific tag.

typeliteral

optional

Literal["application", "distribution"]

Filters results based on image type which can be either application or distribution.

Hide ParametersShow Parameters

"application"

"distribution"

Returns

ImageListResponseclass

Hide ParametersShow Parameters

imageslist

List[]

Hide ParametersShow Parameters

idint

optional

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

created_atdatetime

optional

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

formatdate-time

descriptionstr

optional

An optional free-form text field to describe an image.

distributionliteral

optional

Optional[Literal["Arch Linux", "CentOS", "CoreOS", 10 more]]

The name of a custom image's distribution. Currently, the valid values are Arch Linux, CentOS, CoreOS, Debian, Fedora, Fedora Atomic, FreeBSD, Gentoo, openSUSE, RancherOS, Rocky Linux, Ubuntu, and Unknown. Any other value will be accepted but ignored, and Unknown will be used in its place.

Hide ParametersShow Parameters

"Arch Linux"

"CentOS"

"CoreOS"

"Debian"

"Fedora"

"Fedora Atomic"

"FreeBSD"

"Gentoo"

"openSUSE"

"RancherOS"

"Rocky Linux"

"Ubuntu"

"Unknown"

error_messagestr

optional

A string containing information about errors that may occur when importing a custom image.

min_disk_sizeint

optional

The minimum disk size in GB required for a Droplet to use this image.

minimum0

namestr

optional

The display name that has been given to an image. This is what is shown in the control panel and is generally a descriptive title for the image in question.

publicbool

optional

This is a boolean value that indicates whether the image in question is public or not. An image that is public is available to all accounts. A non-public image is only accessible from your account.

regionslist

optional

Optional[List[Literal["ams1", "ams2", "ams3", 12 more]]]

This attribute is an array of the regions that the image is available in. The regions are represented by their identifying slug values.

Hide ParametersShow Parameters

"ams1"

"ams2"

"ams3"

"blr1"

"fra1"

"lon1"

"nyc1"

"nyc2"

"nyc3"

"sfo1"

"sfo2"

"sfo3"

"sgp1"

"tor1"

"syd1"

size_gigabytesfloat

optional

The size of the image in gigabytes.

formatfloat

slugstr

optional

A uniquely identifying string that is associated with each of the DigitalOcean-provided public images. These can be used to reference a public image as an alternative to the numeric id.

statusliteral

optional

Optional[Literal["NEW", "available", "pending", 2 more]]

A status string indicating the state of a custom image. This may be NEW, available, pending, deleted, or retired.

Hide ParametersShow Parameters

"NEW"

"available"

"pending"

"deleted"

"retired"

tagslist

optional

Optional[List[str]]

A flat array of tag names as strings to be applied to the resource. Tag names may be for either existing or new tags.

Requires tag:create scope.

typeliteral

optional

Optional[Literal["base", "snapshot", "backup", 2 more]]

Describes the kind of image. It may be one of base, snapshot, backup, custom, or admin. Respectively, this specifies whether an image is a DigitalOcean base OS image, user-generated Droplet snapshot, automatically created Droplet backup, user-provided virtual machine image, or an image used for DigitalOcean managed resources (e.g. DOKS worker nodes).

Hide ParametersShow Parameters

"base"

"snapshot"

"backup"

"custom"

"admin"

meta

Information about the response itself.

linksPageLinks

optional

from do_gradientai import GradientAI

client = GradientAI()
images = client.gpu_droplets.images.list()
print(images.images)

200 Example

{
  "images": [
    {
      "id": 7555620,
      "name": "Nifty New Snapshot",
      "distribution": "Ubuntu",
      "slug": null,
      "public": false,
      "regions": [
        "nyc2",
        "nyc3"
      ],
      "created_at": "2014-11-04T22:23:02Z",
      "type": "snapshot",
      "min_disk_size": 20,
      "size_gigabytes": 2.34,
      "description": "",
      "tags": [],
      "status": "available",
      "error_message": ""
    },
    {
      "id": 7555621,
      "name": "Another Snapshot",
      "distribution": "Ubuntu",
      "slug": null,
      "public": false,
      "regions": [
        "nyc2"
      ],
      "created_at": "2014-11-04T22:23:02Z",
      "type": "snapshot",
      "min_disk_size": 20,
      "size_gigabytes": 2.34,
      "description": "",
      "tags": [],
      "status": "available",
      "error_message": ""
    },
    {
      "id": 63663980,
      "name": "20.04 (LTS) x64",
      "distribution": "Ubuntu",
      "slug": "ubuntu-20-04-x64",
      "public": true,
      "regions": [
        "nyc2",
        "nyc3"
      ],
      "created_at": "2020-05-15T05:47:50Z",
      "type": "snapshot",
      "min_disk_size": 20,
      "size_gigabytes": 2.36,
      "description": "",
      "tags": [],
      "status": "available",
      "error_message": ""
    },
    {
      "id": 7555621,
      "name": "A custom image",
      "distribution": "Arch Linux",
      "slug": null,
      "public": false,
      "regions": [
        "nyc3"
      ],
      "created_at": "2014-11-04T22:23:02Z",
      "type": "custom",
      "min_disk_size": 20,
      "size_gigabytes": 2.34,
      "description": "",
      "tags": [],
      "status": "available",
      "error_message": ""
    },
    {
      "id": 7555621,
      "name": "An APP image",
      "distribution": "Fedora",
      "slug": null,
      "public": false,
      "regions": [
        "nyc2",
        "nyc3"
      ],
      "created_at": "2014-11-04T22:23:02Z",
      "type": "snapshot",
      "min_disk_size": 20,
      "size_gigabytes": 2.34,
      "description": "",
      "tags": [],
      "status": "available",
      "error_message": ""
    },
    {
      "id": 7555621,
      "name": "A simple tagged image",
      "distribution": "CentOS",
      "slug": null,
      "public": false,
      "regions": [
        "nyc2",
        "nyc3"
      ],
      "created_at": "2014-11-04T22:23:02Z",
      "type": "snapshot",
      "min_disk_size": 20,
      "size_gigabytes": 2.34,
      "description": "",
      "tags": [
        "simple-image"
      ],
      "status": "available",
      "error_message": ""
    }
  ],
  "links": {
    "pages": {}
  },
  "meta": {
    "total": 6
  }
}