API Reference
Libraries
API Overview
Auth
Authentication and authorization information.
Get Authentication Info
GET/auth/info
Analytics
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
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}
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
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