PgBeam Docs
Projects

ListReplicas

List replicas

Lists all read replicas for a database.

Usage

result, err := client.Projects.ListReplicas(ctx)

Parameters

ParameterTypeRequiredDescription
ctxcontext.ContextYesRequest context

Response

(*pgbeam.ListReplicasResponse, error) — list of replicas.

Example

import pgbeam "github.com/pgbeam/pgbeam-go"

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

result, err := client.Projects.ListReplicas(ctx)
if err != nil {
  log.Fatal(err)
}
fmt.Println(result)

Errors

StatusDescription
400Invalid request parameters.
401Missing or invalid authentication.
403Operation not allowed by current plan limits.
404Resource not found.
429Rate limited. Try again later.

On this page