---
title: "ListReplicas"
description: "List replicas"
canonical: "https://pgbeam.com/docs/go-sdk/projects/listReplicas"
last-updated: "2026-10-30T13:45:52.000Z"
---

# ListReplicas

> List replicas

URL: https://pgbeam.com/docs/go-sdk/projects/listReplicas

{/* Auto-generated from OpenAPI. Do not edit. Run `pnpm generate:sdk-docs` to regenerate. */}

Lists a database's read replicas.

## Usage

```go
result, err := client.Projects.ListReplicas(ctx, "db_xxx", nil)
```

## Parameters

| Parameter          | Type                         | Required | Description                                                                                                                                                                                                                                                                                                                                             |
| ------------------ | ---------------------------- | -------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| ctx                | `context.Context`            | Yes      | Request context                                                                                                                                                                                                                                                                                                                                         |
| databaseID         | `string`                     | Yes      | Unique database identifier (prefixed, e.g. db_xxx).                                                                                                                                                                                                                                                                                                     |
| params             | `*pgbeam.ListReplicasParams` | No       | Query and header parameters                                                                                                                                                                                                                                                                                                                             |
| params.PageSize    | `*int`                       | No       | Maximum number of items to return (1-100, default 20).                                                                                                                                                                                                                                                                                                  |
| params.PageToken   | `*string`                    | No       | Opaque token for cursor-based pagination.                                                                                                                                                                                                                                                                                                               |
| params.IfNoneMatch | `*string`                    | No       | Entity tag the client already holds, taken from the `ETag` of an earlier response. When it still matches the current representation the server answers `304 Not Modified` with no body, so a poll that finds nothing changed costs a round trip rather than a transfer. A comma-separated list is accepted, and `*` matches any current representation. |

## Response

`(*pgbeam.ListReplicasResponse, error)`: list of replicas.

## Example

```go
import pgbeam "go.pgbeam.com/sdk"

client := pgbeam.NewClient(&pgbeam.ClientOptions{
  APIKey: "pbu_...",
})

pageSize := 20
result, err := client.Projects.ListReplicas(ctx, "db_xxx", &pgbeam.ListReplicasParams{
    PageSize: &pageSize,
  })
if err != nil {
  log.Fatal(err)
}
fmt.Println(result)
```

## Errors

| Status | Description                                                                                                                                                                                                                                                                                           |
| ------ | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| 400    | The request was rejected. `code` is `INVALID_INPUT`, and `errors` names the offending fields when the failure was a validation one.                                                                                                                                                                   |
| 401    | Missing or invalid authentication. `code` is `UNAUTHORIZED`.                                                                                                                                                                                                                                          |
| 403    | The caller is authenticated but not allowed to perform this operation. `code` is `FORBIDDEN` when the caller's role is insufficient, and `PLAN_LIMIT_REACHED` when the organization's plan is what stands in the way. The two are answered differently, so branch on the code rather than the status. |
| 404    | The resource does not exist, or the caller is not entitled to know that it does. `code` is `NOT_FOUND`.                                                                                                                                                                                               |
| 429    | Rate limited. `code` is `RATE_LIMITED`.                                                                                                                                                                                                                                                               |
| 500    | The request failed for a reason on our side. `code` is `INTERNAL_ERROR`. Quote `request_id` when reporting it.                                                                                                                                                                                        |