v8

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

Retrieve an Existing Read-only Replica

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 Caching 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.

get/v2/databases/{database_cluster_uuid}/replicas/{replica_name}

Path parameters

database_cluster_uuidstring uuid required

A unique identifier for a database cluster.

replica_namestring required

The name of the database replica.

Response

A JSON object with a key of replica.

Example response

{
  "replica": {
    "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
  }
}