Sign in
Read-only replicas

List read-only replicas

Authorization

A service token or OAuth token must have at least one of the following access or scopes in order to use this API endpoint:

Service Token Accesses read_branch, delete_branch, create_branch, connect_production_branch, connect_branch

OAuth Scopes

ResourceScopes
Organizationread_branches
Databaseread_branches
Branchread_branch
get/organizations/{organization}/databases/{database}/branches/{branch}/read-only-replicas

Path parameters

organizationstring required

Organization name slug from list_organizations. Example: acme.

databasestring required

Database name slug from list_databases. Example: app-db.

branchstring required

Branch name from list_branches. Example: main.

Response

Returns read-only replicas

idstring required

The ID of the read-only replica

namestring required

The name of the read-only replica

statestring required

The state of the read-only replica: pending, ready, or deleting

replicasinteger required

The number of instances serving reads in this read-only replica

cluster_namestring required

The SKU representing the cluster size of the read-only replica

cluster_display_namestring required

The SKU representing the cluster size of the read-only replica, for display

access_host_urlstring required

The database connection host for the read-only replica

private_access_host_urlstring required

The private database connection host for the read-only replica

private_connection_service_namestring nullable required

The service name to set up private connectivity for the read-only replica

created_atstring required

When the read-only replica was created

updated_atstring required

When the read-only replica was last updated

ready_atstring nullable required

When the read-only replica was ready to serve queries

readyboolean required

Whether or not the read-only replica is ready to serve queries

Changes