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
typequery parameter does not directly relate to thetypeattribute.
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.
Servers
- https://api.digitalocean.com
Query parameters
| Name | Type | Required | Description |
|---|---|---|---|
page |
Integer | No |
Which 'page' of paginated results to return. Default value: 1 |
tag_name |
String | No |
Used to filter images by a specific tag. |
per_page |
Integer | No |
Number of items returned per page Default value: 20 |
type |
String | No |
Filters results based on image type which can be either Possible values:
|
private |
Boolean | No |
Used to filter only user images. |
How to start integrating
- Add HTTP Task to your workflow definition.
- Search for the API you want to integrate with and click on the name.
- This loads the API reference documentation and prepares the Http request settings.
- Click Test request to test run your request to the API and see the API's response.