API Reference

Projects

Services

Copy Markdown

Open in Claude

Open in ChatGPT

Open in Cursor

---

Copy Markdown

View as Markdown

Replica Sets

Get Read Replica Sets

GET/projects/{project_id}/services/{service_id}/replicaSets

Create a Read Replica Set

POST/projects/{project_id}/services/{service_id}/replicaSets

Delete a Read Replica Set

DELETE/projects/{project_id}/services/{service_id}/replicaSets/{replica_set_id}

Resize a Read Replica Set

POST/projects/{project_id}/services/{service_id}/replicaSets/{replica_set_id}/resize

Enable Connection Pooler for a Read Replica

POST/projects/{project_id}/services/{service_id}/replicaSets/{replica_set_id}/enablePooler

Disable Connection Pooler for a Read Replica

POST/projects/{project_id}/services/{service_id}/replicaSets/{replica_set_id}/disablePooler

Set Environment for a Read Replica

POST/projects/{project_id}/services/{service_id}/replicaSets/{replica_set_id}/setEnvironment

ModelsExpand Collapse

ReadReplicaSet = object { id, connection_pooler, cpu_millis, 6 more }

id: optional string

connection_pooler: optional ConnectionPooler { endpoint }

endpoint: optional Endpoint { host, port }

host: optional string

port: optional number

cpu_millis: optional number

CPU allocation in milli-cores.

endpoint: optional Endpoint { host, port }

host: optional string

port: optional number

memory_gbs: optional number

Memory allocation in gigabytes.

metadata: optional object { environment }

Additional metadata for the read replica set

environment: optional string

Environment tag for the read replica set

name: optional string

nodes: optional number

Number of nodes in the replica set.

status: optional "creating" or "active" or "resizing" or 2 more

One of the following:

"creating"

"active"

"resizing"

"deleting"

"error"

ReplicaSetRetrieveReplicaSetsResponse = array of ReadReplicaSet { id, connection_pooler, cpu_millis, 6 more }

id: optional string

connection_pooler: optional ConnectionPooler { endpoint }

endpoint: optional Endpoint { host, port }

host: optional string

port: optional number

cpu_millis: optional number

CPU allocation in milli-cores.

endpoint: optional Endpoint { host, port }

host: optional string

port: optional number

memory_gbs: optional number

Memory allocation in gigabytes.

metadata: optional object { environment }

Additional metadata for the read replica set

environment: optional string

Environment tag for the read replica set

name: optional string

nodes: optional number

Number of nodes in the replica set.

status: optional "creating" or "active" or "resizing" or 2 more

One of the following:

"creating"

"active"

"resizing"

"deleting"

"error"

ReplicaSetEnablePoolerResponse = object { message }

message: optional string

ReplicaSetDisablePoolerResponse = object { message }

message: optional string

ReplicaSetSetEnvironmentResponse = object { message }

message: optional string