v8

latestOpenAPI 3.0.0Apache 2.0raw.githubusercontent.com2025-10-165266542.4 MB
DigitalOcean-public.v2-new_Databases

List All Read-only Replicas

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.

get/v2/databases/{database_cluster_uuid}/replicas

Path parameters

database_cluster_uuidstring uuid required

A unique identifier for a database cluster.

Response

A JSON object with a key of replicas.

Example response

{
  "replicas": [
    {
      "id": "9cc10173-e9ea-4176-9dbc-a4cee4c4ff30",
      "name": "read-nyc3-01",
      "region": "nyc3",
      "size": "db-s-2vcpu-4gb",
      "status": "creating",
      "tags": [
        "production"
      ],
      "created_at": "2019-01-11T18:37:36Z",
      "private_network_uuid": "9423cbad-9211-442f-820b-ef6915e99b5f",
      "connection": {
        "uri": "postgres://doadmin:wv78n3zpz42xezdk@backend-do-user-19081923-0.db.ondigitalocean.com:25060/defaultdb?sslmode=require",
        "database": "defaultdb",
        "host": "backend-do-user-19081923-0.db.ondigitalocean.com",
        "port": 25060,
        "user": "doadmin",
        "password": "wv78n3zpz42xezdk",
        "ssl": true
      },
      "private_connection": {
        "uri": "postgres://doadmin:wv78n3zpz42xezdk@backend-do-user-19081923-0.db.ondigitalocean.com:25060/defaultdb?sslmode=require",
        "database": "defaultdb",
        "host": "backend-do-user-19081923-0.db.ondigitalocean.com",
        "port": 25060,
        "user": "doadmin",
        "password": "wv78n3zpz42xezdk",
        "ssl": true
      },
      "storage_size_mib": 61440
    }
  ]
}