Give Feedback

pydo.images.list()

Generated on 24 Apr 2025 from pydo version v0.10.0

Description

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

Name	Type	Required	Description	Default Value
`type`	string	False	Filters results based on image type which can be either `application` or `distribution`.
`private`	boolean	False	Used to filter only user images.
`tag_name`	string	False	Used to filter images by a specific tag.
`per_page`	integer	False	Number of items returned per page	20
`page`	integer	False	Which ‘page’ of paginated results to return.	1

Request Sample

import os
from pydo import Client

client = Client(token=os.environ.get("DIGITALOCEAN_TOKEN"))

resp = client.images.list()

More Information

See the API spec for this endpoint to view additional detail on responses, headers, parameters, and more.