Projects
Add a replica
Adds a read replica to a database.
At a glance
| Item | Value |
|---|---|
| Method | POST |
| Path | /v1/databases/{database_id}/replicas |
| Auth | Authorization: Bearer <token-or-api-key> |
Quick request
Use this as a starting point. Replace the placeholder IDs, set PGBEAM_TOKEN, and create body.json from the schema below.
curl -X POST \
"$PGBEAM_API_URL/v1/databases/<database_id>/replicas" \
-H "Authorization: Bearer $PGBEAM_TOKEN" \
-H "Content-Type: application/json" \
--data @body.jsonAuthorizationBearer <token>
JWT issued by Better Auth. Verified via JWKS.
In: header
Path Parameters
database_id*string
Unique database identifier (prefixed, e.g. db_xxx).
Match
^[a-zA-Z0-9_.-]+$Request Body
application/json
TypeScript Definitions
Use the request body type in TypeScript.
Response Body
application/json
application/json
application/json
application/json
application/json
application/json
curl -X POST "https://api.pgbeam.com/v1/databases/string/replicas" \ -H "Content-Type: application/json" \ -d '{ "host": "string", "port": 1 }'{
"id": "rep_01h455vb4pex5vsknk084sn02q",
"database_id": "string",
"host": "replica.db.example.com",
"port": 5432,
"ssl_mode": "disable",
"created_at": "2019-08-24T14:15:22Z",
"updated_at": "2019-08-24T14:15:22Z"
}{
"error": {
"code": "string",
"message": "string"
}
}{
"error": {
"code": "string",
"message": "string"
}
}{
"error": {
"code": "string",
"message": "string"
}
}{
"error": {
"code": "string",
"message": "string"
}
}{
"error": {
"code": "string",
"message": "string"
}
}