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

client.projects.services.replicaSets.retrieveReplicaSets(stringserviceID, ReplicaSetRetrieveReplicaSetsParams { project_id } params, RequestOptionsoptions?): ReplicaSetRetrieveReplicaSetsResponse { id, connection_pooler, cpu_millis, 6 more }

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

Create a Read Replica Set

client.projects.services.replicaSets.replicaSets(stringserviceID, ReplicaSetReplicaSetsParams { project_id, cpu_millis, memory_gbs, 2 more } params, RequestOptionsoptions?): ReadReplicaSet { id, connection_pooler, cpu_millis, 6 more }

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

Delete a Read Replica Set

client.projects.services.replicaSets.delete(stringreplicaSetID, ReplicaSetDeleteParams { project_id, service_id } params, RequestOptionsoptions?): void

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

Resize a Read Replica Set

client.projects.services.replicaSets.resize(stringreplicaSetID, ReplicaSetResizeParams { project_id, service_id, cpu_millis, memory_gbs } params, RequestOptionsoptions?): void

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

Enable Connection Pooler for a Read Replica

client.projects.services.replicaSets.enablePooler(stringreplicaSetID, ReplicaSetEnablePoolerParams { project_id, service_id } params, RequestOptionsoptions?): ReplicaSetEnablePoolerResponse { message }

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

Disable Connection Pooler for a Read Replica

client.projects.services.replicaSets.disablePooler(stringreplicaSetID, ReplicaSetDisablePoolerParams { project_id, service_id } params, RequestOptionsoptions?): ReplicaSetDisablePoolerResponse { message }

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

Set Environment for a Read Replica

client.projects.services.replicaSets.setEnvironment(stringreplicaSetID, ReplicaSetSetEnvironmentParams { project_id, service_id, environment } params, RequestOptionsoptions?): ReplicaSetSetEnvironmentResponse { message }

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

ModelsExpand Collapse

ReadReplicaSet { id, connection_pooler, cpu_millis, 6 more }

id?: string

connection_pooler?: ConnectionPooler { endpoint }

endpoint?: Endpoint { host, port }

host?: string

port?: number

cpu_millis?: number

CPU allocation in milli-cores.

endpoint?: Endpoint { host, port }

host?: string

port?: number

memory_gbs?: number

Memory allocation in gigabytes.

metadata?: Metadata { environment }

Additional metadata for the read replica set

environment?: string

Environment tag for the read replica set

name?: string

nodes?: number

Number of nodes in the replica set.

status?: "creating" | "active" | "resizing" | 2 more

One of the following:

"creating"

"active"

"resizing"

"deleting"

"error"

ReplicaSetRetrieveReplicaSetsResponse = Array<ReadReplicaSet { id, connection_pooler, cpu_millis, 6 more } >

id?: string

connection_pooler?: ConnectionPooler { endpoint }

endpoint?: Endpoint { host, port }

host?: string

port?: number

cpu_millis?: number

CPU allocation in milli-cores.

endpoint?: Endpoint { host, port }

host?: string

port?: number

memory_gbs?: number

Memory allocation in gigabytes.

metadata?: Metadata { environment }

Additional metadata for the read replica set

environment?: string

Environment tag for the read replica set

name?: string

nodes?: number

Number of nodes in the replica set.

status?: "creating" | "active" | "resizing" | 2 more

One of the following:

"creating"

"active"

"resizing"

"deleting"

"error"

ReplicaSetEnablePoolerResponse { message }

message?: string

ReplicaSetDisablePoolerResponse { message }

message?: string

ReplicaSetSetEnvironmentResponse { message }

message?: string