pydo.droplets.list()
Generated on 8 Jul 2025
from pydo version
v0.12.0
Description
To list all Droplets in your account, send a GET request to /v2/droplets.
The response body will be a JSON object with a key of droplets. This will be
set to an array containing objects each representing a Droplet. These will
contain the standard Droplet attributes.
Filtering Results by Tag
It’s possible to request filtered results by including certain query parameters.
To only list Droplets 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/droplets?tag_name=$TAG_NAME.
GPU Droplets
By default, only non-GPU Droplets are returned. To list only GPU Droplets, set
the type query parameter to gpus. For example, /v2/droplets?type=gpus.
Parameters
| Name | Type | Required | Description | Default Value |
|---|---|---|---|---|
per_page |
integer | False | Number of items returned per page | 20 |
page |
integer | False | Which ‘page’ of paginated results to return. | 1 |
tag_name |
string | False | Used to filter Droplets by a specific tag. Can not be combined with name or type. |
|
name |
string | False | Used to filter list response by Droplet name returning only exact matches. It is case-insensitive and can not be combined with tag_name. |
|
type |
string | False | When type is set to gpus, only GPU Droplets will be returned. By default, only non-GPU Droplets are returned. Can not be combined with tag_name. |
Request Sample
import os
from pydo import Client
client = Client(token=os.environ.get("DIGITALOCEAN_TOKEN"))
resp = client.droplets.list()More Information
See the API spec for this endpoint to view additional detail on responses, headers, parameters, and more.