Skip to main content
GET
List dedicated read replicas

Authorizations

Authorization
string
header
required

The access token received from the authorization server in the OAuth 2.0 flow.

FlowAuthorization Code
Authorization URL
https://app.planetscale.com/oauth/authorize
Token URL
https://auth.planetscale.com/oauth/token

Path Parameters

organization
string
required

Organization name slug from list_organizations. Example: acme.

database
string
required

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

branch
string
required

Branch name from list_branches. Example: main.

Response

Returns dedicated read replicas

id
string
required

The ID of the dedicated read replica

name
string
required

The name of the dedicated read replica

state
string
required

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

replicas
integer
required

The number of instances serving reads in this dedicated read replica

cluster_name
string
required

The SKU representing the cluster size of the dedicated read replica

cluster_display_name
string
required

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

access_host_url
string
required

The database connection host for the dedicated read replica

private_access_host_url
string
required

The private database connection host for the dedicated read replica

private_connection_service_name
string | null
required

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

minimum_storage_bytes
integer | null
required

The minimum storage size in bytes

maximum_storage_bytes
integer | null
required

The maximum storage size in bytes

storage_autoscaling
boolean | null
required

Whether storage autoscaling is enabled

storage_type
enum<string> | null
required

The storage type

Available options:
gp3,
io2,
pd_ssd,
hyperdisk_balanced,
premium_v2_lrs
storage_iops
integer | null
required

The storage IOPS

storage_throughput_mibs
integer | null
required

The storage throughput in MiB/s

volume_modifications_blocked_until
string | null
required

When volume modifications will be allowed again

created_at
string
required

When the dedicated read replica was created

updated_at
string
required

When the dedicated read replica was last updated

ready_at
string | null
required

When the dedicated read replica was ready to serve queries

ready
boolean
required

Whether or not the dedicated read replica is ready to serve queries

actor
object
required
region
object
required
parameters
object[]
required