---
title: "List read-only replicas"
method: GET
path: "/organizations/{organization}/databases/{database}/branches/{branch}/read-only-replicas"
tags: ["Read-only replicas"]
---

# List read-only replicas

`GET /organizations/{organization}/databases/{database}/branches/{branch}/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**

 | Resource | Scopes |
| :------- | :---------- |
| Organization | `read_branches` |
| Database | `read_branches` |
| Branch | `read_branch` |

## Path parameters

- `organization` string, required
- `database` string, required
- `branch` string, required

## Response `200`

Returns read-only replicas

- object[]
  - `id` string, required — The ID of the read-only replica
  - `name` string, required — The name of the read-only replica
  - `state` string, required — The state of the read-only replica: pending, ready, or deleting
  - `replicas` integer, required — The number of instances serving reads in this read-only replica
  - `cluster_name` string, required — The SKU representing the cluster size of the read-only replica
  - `cluster_display_name` string, required — The SKU representing the cluster size of the read-only replica, for display
  - `access_host_url` string, required — The database connection host for the read-only replica
  - `private_access_host_url` string, required — The private database connection host for the read-only replica
  - `private_connection_service_name` string, nullable, required — The service name to set up private connectivity for the read-only replica
  - `created_at` string, required — When the read-only replica was created
  - `updated_at` string, required — When the read-only replica was last updated
  - `ready_at` string, nullable, required — When the read-only replica was ready to serve queries
  - `ready` boolean, required — Whether or not the read-only replica is ready to serve queries
  - `actor` object, required
    - `id` string, required — The ID of the actor
    - `display_name` string, required — The name of the actor
    - `avatar_url` string, required — The URL of the actor's avatar
  - `region` object, required
    - `id` string, required — The ID of the region
    - `provider` string, required — Provider for the region (ex. AWS)
    - `enabled` boolean, required — Whether or not the region is currently active
    - `public_ip_addresses` string[], required — Public IP addresses for the region
    - `display_name` string, required — Name of the region
    - `location` string, required — Location of the region
    - `slug` string, required — The slug of the region
    - `current_default` boolean, required — True if the region is the default for new branch creation
    - `mysql_supported` boolean, required — Whether the region supports MySQL/Vitess databases
    - `postgresql_supported` boolean, required — Whether the region supports PostgreSQL databases
  - `parameters` object[], required
    - `id` string, required — The ID of the parameter
    - `namespace` 'pgconf', required — The namespace of the parameter
    - `name` string, required — The name of the parameter
    - `display_name` string, required — The display name of the parameter
    - `category` string, required — The category of the parameter
    - `description` string, required — The description of the parameter
    - `immutable` boolean, required — Whether the parameter can be changed
    - `parameter_type` 'integer' | 'time', required — The type of the parameter
    - `default_value` string, required — The default value of the parameter, which is the primary's current value
    - `disabled_reason` string, nullable — Why the parameter cannot be changed
    - `value` string, required — The configured value of the parameter
    - `required` boolean, required — Whether the parameter is required
    - `created_at` string, nullable, required — When the parameter was created
    - `updated_at` string, nullable, required — When the parameter was last updated
    - `restart` boolean, required — True if processes require a server restart on change
    - `max` number, required — The maximum value of the parameter
    - `min` number, required — The minimum value of the parameter, floored at the primary's current value
    - `url` string, required — The URL of the parameter
    - `options` string[], required — Valid options for the parameter value
    - `units` string[], required — Display units for the parameter value
    - `actor` object, required
      - `id` string, required — The ID of the actor
      - `display_name` string, required — The name of the actor
      - `avatar_url` string, required — The URL of the actor's avatar

## Other responses

- `401` — Unauthorized
- `403` — Forbidden
- `404` — Not Found
- `500` — Internal Server Error

## Changes

- **2026-08-28** `6d28c038c4fd` — 1 info
  - endpoint added

[Change history](https://skmtc.dev/planetscale/apis/planetscale-api/changes/organizations/:organization/databases/:database/branches/:branch/read-only-replicas/get.md)

---

[API](https://skmtc.dev/planetscale/apis/planetscale-api.md) · [All operations](https://skmtc.dev/planetscale/apis/planetscale-api/llms.txt) · [OpenAPI document](https://skmtc-service-production.skmtc.workers.dev/v1/apis/planetscale/planetscale-api/revisions/6d28c038c4fd/schema)