List All 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.
Query parameters
Filters results based on image type which can be either application or distribution.
Used to filter only user images.
Used to filter images by a specific tag.
Number of items returned per page
Which 'page' of paginated results to return.
Response
The response will be a JSON object with a key called images. This will be set to an array of image objects, each of which will contain the standard image attributes.
Example response
{
"images": [
{
"id": 7555620,
"name": "Nifty New Snapshot",
"type": "snapshot",
"distribution": "Ubuntu",
"slug": "nifty1",
"public": true,
"regions": [
"nyc1",
"nyc2"
],
"created_at": "2020-05-04T22:23:02Z",
"min_disk_size": 20,
"size_gigabytes": 2.34,
"description": " ",
"tags": [
"base-image",
"prod"
],
"status": "NEW",
"error_message": " "
}
],
"links": {
"pages": {
"last": "https://api.digitalocean.com/v2/images?page=2",
"next": "https://api.digitalocean.com/v2/images?page=2"
}
},
"meta": {
"total": 1
}
}