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 }

A virtual private cloud that services can be attached to.

id: optional string

The unique identifier for the VPC.

cidr: optional string

The CIDR block for the VPC.

The name of the VPC.

region_code: optional string

The cloud region where the VPC is hosted.

VpcListResponse = array of Vpc { id, cidr, name, region_code }

id: optional string

The unique identifier for the VPC.

cidr: optional string

The CIDR block for the VPC.

The name of the VPC.

region_code: optional string

The cloud region where the VPC is hosted.

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 }

A VPC peering connection to an external cloud account.

id: optional string

The unique identifier for the peering connection.

error_message: optional string

A human-readable error message when the peering connection failed.

peer_account_id: optional string

The cloud account ID of the peer VPC.

peer_region_code: optional string

The cloud region of the peer VPC.

peer_vpc_id: optional string

The ID of the peer VPC.

provisioned_id: optional string

The provider-assigned identifier for the provisioned peering.

status: optional string

The current status of the peering connection.

PeeringListResponse = array of Peering { id, error_message, peer_account_id, 4 more }

id: optional string

The unique identifier for the peering connection.

error_message: optional string

A human-readable error message when the peering connection failed.

peer_account_id: optional string

The cloud account ID of the peer VPC.

peer_region_code: optional string

The cloud region of the peer VPC.

peer_vpc_id: optional string

The ID of the peer VPC.

provisioned_id: optional string

The provider-assigned identifier for the provisioned peering.

status: optional string

The current status of the peering connection.

ProjectsServices

Manage services 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 }

Connection pooler configuration for a service.

endpoint: optional Endpoint { host, port }

A network endpoint for connecting to a service.

host: optional string

The hostname of the endpoint.

port: optional number

The port of the endpoint.

Endpoint object { host, port }

A network endpoint for connecting to a service.

host: optional string

The hostname of the endpoint.

port: optional number

The port of the endpoint.

EnvironmentTag = "DEV" or "PROD"

The environment tag for the service.

One of the following:

"DEV"

"PROD"

ResizeInput object { cpu_millis, memory_gbs }

Parameters for resizing a service.

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 }

A database service and its current configuration.

connection_pooler: optional ConnectionPooler { endpoint }

Connection pooler configuration for a service.

endpoint: optional Endpoint { host, port }

A network endpoint for connecting to a service.

host: optional string

The hostname of the endpoint.

port: optional number

The port of the endpoint.

created: optional string

Creation timestamp.

formatdate-time

endpoint: optional Endpoint { host, port }

A network endpoint for connecting to a service.

host: optional string

The hostname of the endpoint.

port: optional number

The port of the endpoint.

forked_from: optional object { is_standby, project_id, service_id }

The service this service was forked from.

is_standby: optional boolean

Whether this service is a standby of the parent service.

project_id: optional string

The project of the parent service.

service_id: optional string

The ID of the parent service.

ha_replicas: optional object { replica_count, sync_replica_count }

High-availability replica configuration for a service.

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.

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 }

The read replica sets attached to the service.

id: optional string

The unique identifier for the read replica set.

connection_pooler: optional ConnectionPooler { endpoint }

Connection pooler configuration for a service.

endpoint: optional Endpoint { host, port }

A network endpoint for connecting to a service.

host: optional string

The hostname of the endpoint.

port: optional number

The port of the endpoint.

cpu_millis: optional number

CPU allocation in milli-cores.

endpoint: optional Endpoint { host, port }

A network endpoint for connecting to a service.

host: optional string

The hostname of the endpoint.

port: optional number

The port of the endpoint.

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.

The name of the read replica set.

nodes: optional number

Number of nodes in the replica set.

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

The current status of the read replica set.

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

The current deployment 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 }

Parameters for attaching a service to a VPC.

vpc_id: string

The ID of the VPC to attach the service to.

SetEnvironmentInput object { environment }

Parameters for setting a service’s 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 }

Connection pooler configuration for a service.

endpoint: optional Endpoint { host, port }

A network endpoint for connecting to a service.

host: optional string

The hostname of the endpoint.

port: optional number

The port of the endpoint.

created: optional string

Creation timestamp.

formatdate-time

endpoint: optional Endpoint { host, port }

A network endpoint for connecting to a service.

host: optional string

The hostname of the endpoint.

port: optional number

The port of the endpoint.

forked_from: optional object { is_standby, project_id, service_id }

The service this service was forked from.

is_standby: optional boolean

Whether this service is a standby of the parent service.

project_id: optional string

The project of the parent service.

service_id: optional string

The ID of the parent service.

ha_replicas: optional object { replica_count, sync_replica_count }

High-availability replica configuration for a service.

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.

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 }

The read replica sets attached to the service.

id: optional string

The unique identifier for the read replica set.

connection_pooler: optional ConnectionPooler { endpoint }

Connection pooler configuration for a service.

endpoint: optional Endpoint { host, port }

A network endpoint for connecting to a service.

host: optional string

The hostname of the endpoint.

port: optional number

The port of the endpoint.

cpu_millis: optional number

CPU allocation in milli-cores.

endpoint: optional Endpoint { host, port }

A network endpoint for connecting to a service.

host: optional string

The hostname of the endpoint.

port: optional number

The port of the endpoint.

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.

The name of the read replica set.

nodes: optional number

Number of nodes in the replica set.

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

The current status of the read replica set.

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

The current deployment 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

Manage read replica sets and their associated actions.

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 }

A set of read replicas for a service.

id: optional string

The unique identifier for the read replica set.

connection_pooler: optional ConnectionPooler { endpoint }

Connection pooler configuration for a service.

endpoint: optional Endpoint { host, port }

A network endpoint for connecting to a service.

host: optional string

The hostname of the endpoint.

port: optional number

The port of the endpoint.

cpu_millis: optional number

CPU allocation in milli-cores.

endpoint: optional Endpoint { host, port }

A network endpoint for connecting to a service.

host: optional string

The hostname of the endpoint.

port: optional number

The port of the endpoint.

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.

The name of the read replica set.

nodes: optional number

Number of nodes in the replica set.

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

The current status of the read replica set.

One of the following:

"creating"

"active"

"resizing"

"deleting"

"error"

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

id: optional string

The unique identifier for the read replica set.

connection_pooler: optional ConnectionPooler { endpoint }

Connection pooler configuration for a service.

endpoint: optional Endpoint { host, port }

A network endpoint for connecting to a service.

host: optional string

The hostname of the endpoint.

port: optional number

The port of the endpoint.

cpu_millis: optional number

CPU allocation in milli-cores.

endpoint: optional Endpoint { host, port }

A network endpoint for connecting to a service.

host: optional string

The hostname of the endpoint.

port: optional number

The port of the endpoint.

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.

The name of the read replica set.

nodes: optional number

Number of nodes in the replica set.

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

The current status of the read replica set.

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