pydo.databases.list_replicas()
Generated on 20 Oct 2025
from pydo version
v0.18.0
Description
To list all of the read-only replicas associated with a database cluster, send a GET request to /v2/databases/$DATABASE_ID/replicas.
Note: Read-only replicas are not supported for Caching or Valkey clusters.
The result will be a JSON object with a replicas key. This will be set to an array of database replica objects, each of which will contain the standard database replica attributes.
Parameters
| Name | Type | Required | Description | Default Value |
|---|---|---|---|---|
database_cluster_uuid |
string | True | A unique identifier for a database cluster. |
Request Sample
import os
from pydo import Client
client = Client(token=os.environ.get("DIGITALOCEAN_TOKEN"))
get_resp = client.databases.list_replicas(database_cluster_uuid="a7aba3")More Information
See the API spec for this endpoint to view additional detail on responses, headers, parameters, and more.