pydo.databases.get_replica()
Generated on 1 Jul 2025
from pydo
version
v0.12.0
Description
To show information about an existing database replica, send a GET request to /v2/databases/$DATABASE_ID/replicas/$REPLICA_NAME
.
Note: Read-only replicas are not supported for Redis or Valkey clusters.
The response will be a JSON object with a replica key
. This will be set to an object containing the standard database replica attributes.
Parameters
Name | Type | Required | Description | Default Value |
---|---|---|---|---|
database_cluster_uuid |
string | True | A unique identifier for a database cluster. | |
replica_name |
string | True | The name of the database replica. |
Request Sample
import os
from pydo import Client
client = Client(token=os.environ.get("DIGITALOCEAN_TOKEN"))
get_resp = client.databases.get_replica(database_cluster_uuid="a7a90a", replica_name="backend-replica")
More Information
See the API spec for this endpoint to view additional detail on responses, headers, parameters, and more.