Skip to content
Search ⌘K
Get started
API Reference

Projects

ProjectsVpcs

Manage VPCs and their peering connections.

List All VPCs
GET/projects/{project_id}/vpcs
Create a VPC
POST/projects/{project_id}/vpcs
Get a VPC
GET/projects/{project_id}/vpcs/{vpc_id}
Delete a VPC
DELETE/projects/{project_id}/vpcs/{vpc_id}
Rename a VPC
POST/projects/{project_id}/vpcs/{vpc_id}/rename
ModelsExpand Collapse
Vpc = object { id, cidr, name, region_code }
id: optional string
cidr: optional string
name: optional string
region_code: optional string
VpcListResponse = array of Vpc { id, cidr, name, region_code }
id: optional string
cidr: optional string
name: optional string
region_code: optional string

ProjectsVpcsPeerings

Manage VPCs and their peering connections.

List VPC Peerings
GET/projects/{project_id}/vpcs/{vpc_id}/peerings
Create a VPC Peering
POST/projects/{project_id}/vpcs/{vpc_id}/peerings
Get a VPC Peering
GET/projects/{project_id}/vpcs/{vpc_id}/peerings/{peering_id}
Delete a VPC Peering
DELETE/projects/{project_id}/vpcs/{vpc_id}/peerings/{peering_id}
ModelsExpand Collapse
Peering = object { id, error_message, peer_account_id, 4 more }
id: optional string
error_message: optional string
peer_account_id: optional string
peer_region_code: optional string
peer_vpc_id: optional string
provisioned_id: optional string
status: optional string
PeeringListResponse = array of Peering { id, error_message, peer_account_id, 4 more }
id: optional string
error_message: optional string
peer_account_id: optional string
peer_region_code: optional string
peer_vpc_id: optional string
provisioned_id: optional string
status: optional string

ProjectsServices

Manage services, read replicas, and their associated actions.

List All Services
GET/projects/{project_id}/services
Create a Service
POST/projects/{project_id}/services
Get a Service
GET/projects/{project_id}/services/{service_id}
Delete a Service
DELETE/projects/{project_id}/services/{service_id}
Start a Service
POST/projects/{project_id}/services/{service_id}/start
Stop a Service
POST/projects/{project_id}/services/{service_id}/stop
Attach Service to VPC
POST/projects/{project_id}/services/{service_id}/attachToVPC
Detach Service from VPC
POST/projects/{project_id}/services/{service_id}/detachFromVPC
Resize a Service
POST/projects/{project_id}/services/{service_id}/resize
Enable Connection Pooler for a Service
POST/projects/{project_id}/services/{service_id}/enablePooler
Disable Connection Pooler for a Service
POST/projects/{project_id}/services/{service_id}/disablePooler
Fork a Service
POST/projects/{project_id}/services/{service_id}/forkService
Update Service Password
POST/projects/{project_id}/services/{service_id}/updatePassword
Set Environment for a Service
POST/projects/{project_id}/services/{service_id}/setEnvironment
Change HA configuration for a Service
POST/projects/{project_id}/services/{service_id}/setHA
ModelsExpand Collapse
ConnectionPooler = object { endpoint }
endpoint: optional Endpoint { host, port }
host: optional string
port: optional number
Endpoint = object { host, port }
host: optional string
port: optional number
EnvironmentTag = "DEV" or "PROD"

The environment tag for the service.

One of the following:
"DEV"
"PROD"
ResizeInput = object { cpu_millis, memory_gbs }
cpu_millis: string

The new CPU allocation in milli-cores.

memory_gbs: string

The new memory allocation in gigabytes.

Service = object { connection_pooler, created, endpoint, 14 more }
connection_pooler: optional ConnectionPooler { endpoint }
endpoint: optional Endpoint { host, port }
host: optional string
port: optional number
created: optional string

Creation timestamp

formatdate-time
endpoint: optional Endpoint { host, port }
host: optional string
port: optional number
forked_from: optional object { is_standby, project_id, service_id }
is_standby: optional boolean
project_id: optional string
service_id: optional string
ha_replicas: optional object { replica_count, sync_replica_count }
replica_count: optional number

Number of high-availability replicas (all replicas are asynchronous by default).

sync_replica_count: optional number

Number of synchronous high-availability replicas.

initial_password: optional string

The initial password for the service.

formatpassword
metadata: optional object { environment }

Additional metadata for the service

environment: optional string

Environment tag for the service

metrics: optional object { memory_mb, milli_cpu, storage_mb }

Resource usage metrics for the service

memory_mb: optional number

Memory usage in megabytes

milli_cpu: optional number

CPU usage in millicores

storage_mb: optional number

Storage usage in megabytes

name: optional string

The name of the service.

project_id: optional string

The project this service belongs to.

read_replica_sets: optional 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"
region_code: optional string

The cloud region where the service is hosted.

resources: optional array of object { id, spec }

List of resources allocated to the service

id: optional string

Resource identifier

spec: optional object { cpu_millis, memory_gbs, volume_type }

Resource specification

cpu_millis: optional number

CPU allocation in millicores

memory_gbs: optional number

Memory allocation in gigabytes

volume_type: optional string

Type of storage volume

service_id: optional string

The unique identifier for the service.

service_type: optional "TIMESCALEDB" or "POSTGRES" or "VECTOR"

The type of the service.

One of the following:
"TIMESCALEDB"
"POSTGRES"
"VECTOR"
status: optional "QUEUED" or "DELETING" or "CONFIGURING" or 8 more

Current status of the service

One of the following:
"QUEUED"
"DELETING"
"CONFIGURING"
"READY"
"DELETED"
"UNSTABLE"
"PAUSING"
"PAUSED"
"RESUMING"
"UPGRADING"
"OPTIMIZING"
vpcEndpoint: optional unknown

VPC endpoint configuration if available

ServiceVpcInput = object { vpc_id }
vpc_id: string

The ID of the VPC to attach the service to.

SetEnvironmentInput = object { environment }
environment: "PROD" or "DEV"

The target environment for the service.

One of the following:
"PROD"
"DEV"
ServiceListResponse = array of Service { connection_pooler, created, endpoint, 14 more }
connection_pooler: optional ConnectionPooler { endpoint }
endpoint: optional Endpoint { host, port }
host: optional string
port: optional number
created: optional string

Creation timestamp

formatdate-time
endpoint: optional Endpoint { host, port }
host: optional string
port: optional number
forked_from: optional object { is_standby, project_id, service_id }
is_standby: optional boolean
project_id: optional string
service_id: optional string
ha_replicas: optional object { replica_count, sync_replica_count }
replica_count: optional number

Number of high-availability replicas (all replicas are asynchronous by default).

sync_replica_count: optional number

Number of synchronous high-availability replicas.

initial_password: optional string

The initial password for the service.

formatpassword
metadata: optional object { environment }

Additional metadata for the service

environment: optional string

Environment tag for the service

metrics: optional object { memory_mb, milli_cpu, storage_mb }

Resource usage metrics for the service

memory_mb: optional number

Memory usage in megabytes

milli_cpu: optional number

CPU usage in millicores

storage_mb: optional number

Storage usage in megabytes

name: optional string

The name of the service.

project_id: optional string

The project this service belongs to.

read_replica_sets: optional 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"
region_code: optional string

The cloud region where the service is hosted.

resources: optional array of object { id, spec }

List of resources allocated to the service

id: optional string

Resource identifier

spec: optional object { cpu_millis, memory_gbs, volume_type }

Resource specification

cpu_millis: optional number

CPU allocation in millicores

memory_gbs: optional number

Memory allocation in gigabytes

volume_type: optional string

Type of storage volume

service_id: optional string

The unique identifier for the service.

service_type: optional "TIMESCALEDB" or "POSTGRES" or "VECTOR"

The type of the service.

One of the following:
"TIMESCALEDB"
"POSTGRES"
"VECTOR"
status: optional "QUEUED" or "DELETING" or "CONFIGURING" or 8 more

Current status of the service

One of the following:
"QUEUED"
"DELETING"
"CONFIGURING"
"READY"
"DELETED"
"UNSTABLE"
"PAUSING"
"PAUSED"
"RESUMING"
"UPGRADING"
"OPTIMIZING"
vpcEndpoint: optional unknown

VPC endpoint configuration if available

ServiceAttachToVpcResponse = object { message }
message: optional string
ServiceDetachFromVpcResponse = object { message }
message: optional string
ServiceEnablePoolerResponse = object { message }
message: optional string
ServiceDisablePoolerResponse = object { message }
message: optional string
ServiceSetEnvironmentResponse = object { message }
message: optional string

ProjectsServicesReplica 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