---
title: "CreateReplica"
description: "Add a replica"
canonical: "https://pgbeam.com/docs/go-sdk/projects/createReplica"
last-updated: "2026-10-30T13:32:17.000Z"
---

# CreateReplica

> Add a replica

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

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

Adds a read replica to a database.

## Usage

```go
result, err := client.Projects.CreateReplica(ctx, "db_xxx", pgbeam.CreateReplicaRequest{
    Host: "replica.us-west-2.rds.amazonaws.com",
    Port: 5432,
  })
```

## Parameters

| Parameter    | Type                          | Required | Description                                         |
| ------------ | ----------------------------- | -------- | --------------------------------------------------- |
| ctx          | `context.Context`             | Yes      | Request context                                     |
| databaseID   | `string`                      | Yes      | Unique database identifier (prefixed, e.g. db_xxx). |
| body         | `pgbeam.CreateReplicaRequest` | Yes      | Request body                                        |
| body.Host    | `string`                      | Yes      | PostgreSQL replica host.                            |
| body.Port    | `int`                         | Yes      | PostgreSQL replica port.                            |
| body.SslMode | `*pgbeam.SSLMode`             | No       | PostgreSQL SSL connection mode.                     |

## Response

`(*pgbeam.Replica, error)`: replica created.

## Example

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

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

result, err := client.Projects.CreateReplica(ctx, "db_xxx", pgbeam.CreateReplicaRequest{
    Host: "replica.us-west-2.rds.amazonaws.com",
    Port: 5432,
  })
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`.                                                                                                                                                                                                                               |
| 409    | The request conflicts with the current state. `code` distinguishes the cases: `RESOURCE_EXISTS` for a name or value already in use, `INVALID_STATE` for a resource that is no longer in a state that allows the operation, and `IDEMPOTENCY_KEY_REUSED` for a retry whose body does not match the request the key was first used for. |
| 413    | The request body exceeds the 2 MB limit. `code` is `PAYLOAD_TOO_LARGE`.                                                                                                                                                                                                                                                               |
| 415    | The request body is not JSON, or carries a body without declaring a Content-Type. `code` is `UNSUPPORTED_MEDIA_TYPE`.                                                                                                                                                                                                                 |
| 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.                                                                                                                                                                                                                        |