# Projects # Vpcs ## List All VPCs **get** `/projects/{project_id}/vpcs` Retrieves a list of all Virtual Private Clouds (VPCs). ### Path Parameters - `project_id: string` ### Returns - `id: optional string` - `cidr: optional string` - `name: optional string` - `region_code: optional string` ### Example ```http curl http://localhost:8080/projects/$PROJECT_ID/vpcs \ -H "Authorization: Bearer $TIGER_CLOUD_API_KEY" ``` #### Response ```json [ { "id": "1234567890", "cidr": "10.0.0.0/16", "name": "my-production-vpc", "region_code": "us-east-1" } ] ``` ## Create a VPC **post** `/projects/{project_id}/vpcs` Creates a new Virtual Private Cloud (VPC). ### Path Parameters - `project_id: string` ### Body Parameters - `cidr: string` - `name: string` - `region_code: string` ### Returns - `Vpc = object { id, cidr, name, region_code }` - `id: optional string` - `cidr: optional string` - `name: optional string` - `region_code: optional string` ### Example ```http curl http://localhost:8080/projects/$PROJECT_ID/vpcs \ -H 'Content-Type: application/json' \ -H "Authorization: Bearer $TIGER_CLOUD_API_KEY" \ -d '{ "cidr": "10.0.0.0/16", "name": "my-production-vpc", "region_code": "us-east-1" }' ``` #### Response ```json { "id": "1234567890", "cidr": "10.0.0.0/16", "name": "my-production-vpc", "region_code": "us-east-1" } ``` ## Get a VPC **get** `/projects/{project_id}/vpcs/{vpc_id}` Retrieves the details of a specific VPC by its ID. ### Path Parameters - `project_id: string` - `vpc_id: string` ### Returns - `Vpc = object { id, cidr, name, region_code }` - `id: optional string` - `cidr: optional string` - `name: optional string` - `region_code: optional string` ### Example ```http curl http://localhost:8080/projects/$PROJECT_ID/vpcs/$VPC_ID \ -H "Authorization: Bearer $TIGER_CLOUD_API_KEY" ``` #### Response ```json { "id": "1234567890", "cidr": "10.0.0.0/16", "name": "my-production-vpc", "region_code": "us-east-1" } ``` ## Delete a VPC **delete** `/projects/{project_id}/vpcs/{vpc_id}` Deletes a specific VPC. ### Path Parameters - `project_id: string` - `vpc_id: string` ### Example ```http curl http://localhost:8080/projects/$PROJECT_ID/vpcs/$VPC_ID \ -X DELETE \ -H "Authorization: Bearer $TIGER_CLOUD_API_KEY" ``` ## Rename a VPC **post** `/projects/{project_id}/vpcs/{vpc_id}/rename` Updates the name of a specific VPC. ### Path Parameters - `project_id: string` - `vpc_id: string` ### Body Parameters - `name: string` The new name for the VPC. ### Returns - `Vpc = object { id, cidr, name, region_code }` - `id: optional string` - `cidr: optional string` - `name: optional string` - `region_code: optional string` ### Example ```http curl http://localhost:8080/projects/$PROJECT_ID/vpcs/$VPC_ID/rename \ -H 'Content-Type: application/json' \ -H "Authorization: Bearer $TIGER_CLOUD_API_KEY" \ -d '{ "name": "my-renamed-vpc" }' ``` #### Response ```json { "id": "1234567890", "cidr": "10.0.0.0/16", "name": "my-production-vpc", "region_code": "us-east-1" } ``` ## Domain Types ### Vpc - `Vpc = object { id, cidr, name, region_code }` - `id: optional string` - `cidr: optional string` - `name: optional string` - `region_code: optional string` ### Vpc List Response - `VpcListResponse = array of Vpc` - `id: optional string` - `cidr: optional string` - `name: optional string` - `region_code: optional string` # Peerings ## List VPC Peerings **get** `/projects/{project_id}/vpcs/{vpc_id}/peerings` Retrieves a list of all VPC peering connections for a given VPC. ### Path Parameters - `project_id: string` - `vpc_id: string` ### Returns - `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` ### Example ```http curl http://localhost:8080/projects/$PROJECT_ID/vpcs/$VPC_ID/peerings \ -H "Authorization: Bearer $TIGER_CLOUD_API_KEY" ``` #### Response ```json [ { "id": "1234567890", "error_message": "VPC not found", "peer_account_id": "acc-12345", "peer_region_code": "aws-us-east-1", "peer_vpc_id": "1234567890", "provisioned_id": "1234567890", "status": "active" } ] ``` ## Create a VPC Peering **post** `/projects/{project_id}/vpcs/{vpc_id}/peerings` Creates a new VPC peering connection. ### Path Parameters - `project_id: string` - `vpc_id: string` ### Body Parameters - `peer_account_id: string` - `peer_region_code: string` - `peer_vpc_id: string` ### Returns - `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` ### Example ```http curl http://localhost:8080/projects/$PROJECT_ID/vpcs/$VPC_ID/peerings \ -H 'Content-Type: application/json' \ -H "Authorization: Bearer $TIGER_CLOUD_API_KEY" \ -d '{ "peer_account_id": "acc-12345", "peer_region_code": "aws-us-east-1", "peer_vpc_id": "1234567890" }' ``` #### Response ```json { "id": "1234567890", "error_message": "VPC not found", "peer_account_id": "acc-12345", "peer_region_code": "aws-us-east-1", "peer_vpc_id": "1234567890", "provisioned_id": "1234567890", "status": "active" } ``` ## Get a VPC Peering **get** `/projects/{project_id}/vpcs/{vpc_id}/peerings/{peering_id}` Retrieves the details of a specific VPC peering connection. ### Path Parameters - `project_id: string` - `vpc_id: string` - `peering_id: string` ### Returns - `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` ### Example ```http curl http://localhost:8080/projects/$PROJECT_ID/vpcs/$VPC_ID/peerings/$PEERING_ID \ -H "Authorization: Bearer $TIGER_CLOUD_API_KEY" ``` #### Response ```json { "id": "1234567890", "error_message": "VPC not found", "peer_account_id": "acc-12345", "peer_region_code": "aws-us-east-1", "peer_vpc_id": "1234567890", "provisioned_id": "1234567890", "status": "active" } ``` ## Delete a VPC Peering **delete** `/projects/{project_id}/vpcs/{vpc_id}/peerings/{peering_id}` Deletes a specific VPC peering connection. ### Path Parameters - `project_id: string` - `vpc_id: string` - `peering_id: string` ### Example ```http curl http://localhost:8080/projects/$PROJECT_ID/vpcs/$VPC_ID/peerings/$PEERING_ID \ -X DELETE \ -H "Authorization: Bearer $TIGER_CLOUD_API_KEY" ``` ## Domain Types ### Peering - `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` ### Peering List Response - `PeeringListResponse = array of Peering` - `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` # Services ## List All Services **get** `/projects/{project_id}/services` Retrieves a list of all services within a specific project. ### Path Parameters - `project_id: string` ### Returns - `connection_pooler: optional ConnectionPooler` - `endpoint: optional Endpoint` - `host: optional string` - `port: optional number` - `created: optional string` Creation timestamp - `endpoint: optional Endpoint` - `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. - `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: optional string` - `connection_pooler: optional ConnectionPooler` - `cpu_millis: optional number` CPU allocation in milli-cores. - `endpoint: optional 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 - `name: optional string` - `nodes: optional number` Number of nodes in the replica set. - `status: optional "creating" or "active" or "resizing" or 2 more` - `"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. - `"TIMESCALEDB"` - `"POSTGRES"` - `"VECTOR"` - `status: optional "QUEUED" or "DELETING" or "CONFIGURING" or 8 more` Current status of the service - `"QUEUED"` - `"DELETING"` - `"CONFIGURING"` - `"READY"` - `"DELETED"` - `"UNSTABLE"` - `"PAUSING"` - `"PAUSED"` - `"RESUMING"` - `"UPGRADING"` - `"OPTIMIZING"` - `vpcEndpoint: optional unknown` VPC endpoint configuration if available ### Example ```http curl http://localhost:8080/projects/$PROJECT_ID/services \ -H "Authorization: Bearer $TIGER_CLOUD_API_KEY" ``` #### Response ```json [ { "connection_pooler": { "endpoint": { "host": "my-service.com", "port": 8080 } }, "created": "2019-12-27T18:11:19.117Z", "endpoint": { "host": "my-service.com", "port": 8080 }, "forked_from": { "is_standby": false, "project_id": "asda1b2c3", "service_id": "bbss422fg" }, "ha_replicas": { "replica_count": 1, "sync_replica_count": 1 }, "initial_password": "a-very-secure-initial-password", "metadata": { "environment": "environment" }, "metrics": { "memory_mb": 512, "milli_cpu": 250, "storage_mb": 1024 }, "name": "name", "project_id": "project_id", "read_replica_sets": [ { "id": "alb8jicdpr", "connection_pooler": { "endpoint": { "host": "my-service.com", "port": 8080 } }, "cpu_millis": 250, "endpoint": { "host": "my-service.com", "port": 8080 }, "memory_gbs": 1, "metadata": { "environment": "environment" }, "name": "reporting-replica-1", "nodes": 2, "status": "active" } ], "region_code": "us-east-1", "resources": [ { "id": "id", "spec": { "cpu_millis": 0, "memory_gbs": 0, "volume_type": "volume_type" } } ], "service_id": "service_id", "service_type": "TIMESCALEDB", "status": "QUEUED", "vpcEndpoint": {} } ] ``` ## Create a Service **post** `/projects/{project_id}/services` Creates a new database service within a project. This is an asynchronous operation. ### Path Parameters - `project_id: string` ### Body Parameters - `name: string` A human-readable name for the service. - `addons: optional array of "time-series" or "ai"` List of addons to enable for the service. 'time-series' enables TimescaleDB, 'ai' enables AI/vector extensions. - `"time-series"` - `"ai"` - `cpu_millis: optional string` The initial CPU allocation in milli-cores, or 'shared' for a shared-resource service. - `environment_tag: optional EnvironmentTag` The environment tag for the service, 'DEV' by default. - `"DEV"` - `"PROD"` - `memory_gbs: optional string` The initial memory allocation in gigabytes, or 'shared' for a shared-resource service. - `region_code: optional string` The region where the service will be created. If not provided, we'll choose the best region for you. - `replica_count: optional number` Number of high-availability replicas to create (all replicas are asynchronous by default). ### Returns - `Service = object { connection_pooler, created, endpoint, 14 more }` - `connection_pooler: optional ConnectionPooler` - `endpoint: optional Endpoint` - `host: optional string` - `port: optional number` - `created: optional string` Creation timestamp - `endpoint: optional Endpoint` - `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. - `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: optional string` - `connection_pooler: optional ConnectionPooler` - `cpu_millis: optional number` CPU allocation in milli-cores. - `endpoint: optional 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 - `name: optional string` - `nodes: optional number` Number of nodes in the replica set. - `status: optional "creating" or "active" or "resizing" or 2 more` - `"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. - `"TIMESCALEDB"` - `"POSTGRES"` - `"VECTOR"` - `status: optional "QUEUED" or "DELETING" or "CONFIGURING" or 8 more` Current status of the service - `"QUEUED"` - `"DELETING"` - `"CONFIGURING"` - `"READY"` - `"DELETED"` - `"UNSTABLE"` - `"PAUSING"` - `"PAUSED"` - `"RESUMING"` - `"UPGRADING"` - `"OPTIMIZING"` - `vpcEndpoint: optional unknown` VPC endpoint configuration if available ### Example ```http curl http://localhost:8080/projects/$PROJECT_ID/services \ -H 'Content-Type: application/json' \ -H "Authorization: Bearer $TIGER_CLOUD_API_KEY" \ -d '{ "name": "my-production-db", "addons": [ "time-series", "ai" ], "cpu_millis": "1000", "memory_gbs": "4", "region_code": "us-east-1", "replica_count": 2 }' ``` #### Response ```json { "connection_pooler": { "endpoint": { "host": "my-service.com", "port": 8080 } }, "created": "2019-12-27T18:11:19.117Z", "endpoint": { "host": "my-service.com", "port": 8080 }, "forked_from": { "is_standby": false, "project_id": "asda1b2c3", "service_id": "bbss422fg" }, "ha_replicas": { "replica_count": 1, "sync_replica_count": 1 }, "initial_password": "a-very-secure-initial-password", "metadata": { "environment": "environment" }, "metrics": { "memory_mb": 512, "milli_cpu": 250, "storage_mb": 1024 }, "name": "name", "project_id": "project_id", "read_replica_sets": [ { "id": "alb8jicdpr", "connection_pooler": { "endpoint": { "host": "my-service.com", "port": 8080 } }, "cpu_millis": 250, "endpoint": { "host": "my-service.com", "port": 8080 }, "memory_gbs": 1, "metadata": { "environment": "environment" }, "name": "reporting-replica-1", "nodes": 2, "status": "active" } ], "region_code": "us-east-1", "resources": [ { "id": "id", "spec": { "cpu_millis": 0, "memory_gbs": 0, "volume_type": "volume_type" } } ], "service_id": "service_id", "service_type": "TIMESCALEDB", "status": "QUEUED", "vpcEndpoint": {} } ``` ## Get a Service **get** `/projects/{project_id}/services/{service_id}` Retrieves the details of a specific service by its ID. ### Path Parameters - `project_id: string` - `service_id: string` ### Returns - `Service = object { connection_pooler, created, endpoint, 14 more }` - `connection_pooler: optional ConnectionPooler` - `endpoint: optional Endpoint` - `host: optional string` - `port: optional number` - `created: optional string` Creation timestamp - `endpoint: optional Endpoint` - `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. - `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: optional string` - `connection_pooler: optional ConnectionPooler` - `cpu_millis: optional number` CPU allocation in milli-cores. - `endpoint: optional 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 - `name: optional string` - `nodes: optional number` Number of nodes in the replica set. - `status: optional "creating" or "active" or "resizing" or 2 more` - `"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. - `"TIMESCALEDB"` - `"POSTGRES"` - `"VECTOR"` - `status: optional "QUEUED" or "DELETING" or "CONFIGURING" or 8 more` Current status of the service - `"QUEUED"` - `"DELETING"` - `"CONFIGURING"` - `"READY"` - `"DELETED"` - `"UNSTABLE"` - `"PAUSING"` - `"PAUSED"` - `"RESUMING"` - `"UPGRADING"` - `"OPTIMIZING"` - `vpcEndpoint: optional unknown` VPC endpoint configuration if available ### Example ```http curl http://localhost:8080/projects/$PROJECT_ID/services/$SERVICE_ID \ -H "Authorization: Bearer $TIGER_CLOUD_API_KEY" ``` #### Response ```json { "connection_pooler": { "endpoint": { "host": "my-service.com", "port": 8080 } }, "created": "2019-12-27T18:11:19.117Z", "endpoint": { "host": "my-service.com", "port": 8080 }, "forked_from": { "is_standby": false, "project_id": "asda1b2c3", "service_id": "bbss422fg" }, "ha_replicas": { "replica_count": 1, "sync_replica_count": 1 }, "initial_password": "a-very-secure-initial-password", "metadata": { "environment": "environment" }, "metrics": { "memory_mb": 512, "milli_cpu": 250, "storage_mb": 1024 }, "name": "name", "project_id": "project_id", "read_replica_sets": [ { "id": "alb8jicdpr", "connection_pooler": { "endpoint": { "host": "my-service.com", "port": 8080 } }, "cpu_millis": 250, "endpoint": { "host": "my-service.com", "port": 8080 }, "memory_gbs": 1, "metadata": { "environment": "environment" }, "name": "reporting-replica-1", "nodes": 2, "status": "active" } ], "region_code": "us-east-1", "resources": [ { "id": "id", "spec": { "cpu_millis": 0, "memory_gbs": 0, "volume_type": "volume_type" } } ], "service_id": "service_id", "service_type": "TIMESCALEDB", "status": "QUEUED", "vpcEndpoint": {} } ``` ## Delete a Service **delete** `/projects/{project_id}/services/{service_id}` Deletes a specific service. This is an asynchronous operation. ### Path Parameters - `project_id: string` - `service_id: string` ### Example ```http curl http://localhost:8080/projects/$PROJECT_ID/services/$SERVICE_ID \ -X DELETE \ -H "Authorization: Bearer $TIGER_CLOUD_API_KEY" ``` ## Start a Service **post** `/projects/{project_id}/services/{service_id}/start` Starts a stopped service within a project. This is an asynchronous operation. ### Path Parameters - `project_id: string` - `service_id: string` ### Returns - `Service = object { connection_pooler, created, endpoint, 14 more }` - `connection_pooler: optional ConnectionPooler` - `endpoint: optional Endpoint` - `host: optional string` - `port: optional number` - `created: optional string` Creation timestamp - `endpoint: optional Endpoint` - `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. - `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: optional string` - `connection_pooler: optional ConnectionPooler` - `cpu_millis: optional number` CPU allocation in milli-cores. - `endpoint: optional 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 - `name: optional string` - `nodes: optional number` Number of nodes in the replica set. - `status: optional "creating" or "active" or "resizing" or 2 more` - `"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. - `"TIMESCALEDB"` - `"POSTGRES"` - `"VECTOR"` - `status: optional "QUEUED" or "DELETING" or "CONFIGURING" or 8 more` Current status of the service - `"QUEUED"` - `"DELETING"` - `"CONFIGURING"` - `"READY"` - `"DELETED"` - `"UNSTABLE"` - `"PAUSING"` - `"PAUSED"` - `"RESUMING"` - `"UPGRADING"` - `"OPTIMIZING"` - `vpcEndpoint: optional unknown` VPC endpoint configuration if available ### Example ```http curl http://localhost:8080/projects/$PROJECT_ID/services/$SERVICE_ID/start \ -X POST \ -H "Authorization: Bearer $TIGER_CLOUD_API_KEY" ``` #### Response ```json { "connection_pooler": { "endpoint": { "host": "my-service.com", "port": 8080 } }, "created": "2019-12-27T18:11:19.117Z", "endpoint": { "host": "my-service.com", "port": 8080 }, "forked_from": { "is_standby": false, "project_id": "asda1b2c3", "service_id": "bbss422fg" }, "ha_replicas": { "replica_count": 1, "sync_replica_count": 1 }, "initial_password": "a-very-secure-initial-password", "metadata": { "environment": "environment" }, "metrics": { "memory_mb": 512, "milli_cpu": 250, "storage_mb": 1024 }, "name": "name", "project_id": "project_id", "read_replica_sets": [ { "id": "alb8jicdpr", "connection_pooler": { "endpoint": { "host": "my-service.com", "port": 8080 } }, "cpu_millis": 250, "endpoint": { "host": "my-service.com", "port": 8080 }, "memory_gbs": 1, "metadata": { "environment": "environment" }, "name": "reporting-replica-1", "nodes": 2, "status": "active" } ], "region_code": "us-east-1", "resources": [ { "id": "id", "spec": { "cpu_millis": 0, "memory_gbs": 0, "volume_type": "volume_type" } } ], "service_id": "service_id", "service_type": "TIMESCALEDB", "status": "QUEUED", "vpcEndpoint": {} } ``` ## Stop a Service **post** `/projects/{project_id}/services/{service_id}/stop` Stops a running service within a project. This is an asynchronous operation. ### Path Parameters - `project_id: string` - `service_id: string` ### Returns - `Service = object { connection_pooler, created, endpoint, 14 more }` - `connection_pooler: optional ConnectionPooler` - `endpoint: optional Endpoint` - `host: optional string` - `port: optional number` - `created: optional string` Creation timestamp - `endpoint: optional Endpoint` - `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. - `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: optional string` - `connection_pooler: optional ConnectionPooler` - `cpu_millis: optional number` CPU allocation in milli-cores. - `endpoint: optional 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 - `name: optional string` - `nodes: optional number` Number of nodes in the replica set. - `status: optional "creating" or "active" or "resizing" or 2 more` - `"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. - `"TIMESCALEDB"` - `"POSTGRES"` - `"VECTOR"` - `status: optional "QUEUED" or "DELETING" or "CONFIGURING" or 8 more` Current status of the service - `"QUEUED"` - `"DELETING"` - `"CONFIGURING"` - `"READY"` - `"DELETED"` - `"UNSTABLE"` - `"PAUSING"` - `"PAUSED"` - `"RESUMING"` - `"UPGRADING"` - `"OPTIMIZING"` - `vpcEndpoint: optional unknown` VPC endpoint configuration if available ### Example ```http curl http://localhost:8080/projects/$PROJECT_ID/services/$SERVICE_ID/stop \ -X POST \ -H "Authorization: Bearer $TIGER_CLOUD_API_KEY" ``` #### Response ```json { "connection_pooler": { "endpoint": { "host": "my-service.com", "port": 8080 } }, "created": "2019-12-27T18:11:19.117Z", "endpoint": { "host": "my-service.com", "port": 8080 }, "forked_from": { "is_standby": false, "project_id": "asda1b2c3", "service_id": "bbss422fg" }, "ha_replicas": { "replica_count": 1, "sync_replica_count": 1 }, "initial_password": "a-very-secure-initial-password", "metadata": { "environment": "environment" }, "metrics": { "memory_mb": 512, "milli_cpu": 250, "storage_mb": 1024 }, "name": "name", "project_id": "project_id", "read_replica_sets": [ { "id": "alb8jicdpr", "connection_pooler": { "endpoint": { "host": "my-service.com", "port": 8080 } }, "cpu_millis": 250, "endpoint": { "host": "my-service.com", "port": 8080 }, "memory_gbs": 1, "metadata": { "environment": "environment" }, "name": "reporting-replica-1", "nodes": 2, "status": "active" } ], "region_code": "us-east-1", "resources": [ { "id": "id", "spec": { "cpu_millis": 0, "memory_gbs": 0, "volume_type": "volume_type" } } ], "service_id": "service_id", "service_type": "TIMESCALEDB", "status": "QUEUED", "vpcEndpoint": {} } ``` ## Attach Service to VPC **post** `/projects/{project_id}/services/{service_id}/attachToVPC` Associates a service with a VPC. ### Path Parameters - `project_id: string` - `service_id: string` ### Body Parameters - `vpc_id: string` The ID of the VPC to attach the service to. ### Returns - `message: optional string` ### Example ```http curl http://localhost:8080/projects/$PROJECT_ID/services/$SERVICE_ID/attachToVPC \ -H 'Content-Type: application/json' \ -H "Authorization: Bearer $TIGER_CLOUD_API_KEY" \ -d '{ "vpc_id": "1234567890" }' ``` #### Response ```json { "message": "Action completed successfully." } ``` ## Detach Service from VPC **post** `/projects/{project_id}/services/{service_id}/detachFromVPC` Disassociates a service from its VPC. ### Path Parameters - `project_id: string` - `service_id: string` ### Body Parameters - `vpc_id: string` The ID of the VPC to attach the service to. ### Returns - `message: optional string` ### Example ```http curl http://localhost:8080/projects/$PROJECT_ID/services/$SERVICE_ID/detachFromVPC \ -H 'Content-Type: application/json' \ -H "Authorization: Bearer $TIGER_CLOUD_API_KEY" \ -d '{ "vpc_id": "1234567890" }' ``` #### Response ```json { "message": "Action completed successfully." } ``` ## Resize a Service **post** `/projects/{project_id}/services/{service_id}/resize` Changes the CPU and memory allocation for a specific service within a project. This is an asynchronous operation. ### Path Parameters - `project_id: string` - `service_id: string` ### Body Parameters - `cpu_millis: string` The new CPU allocation in milli-cores. - `memory_gbs: string` The new memory allocation in gigabytes. ### Returns - `Service = object { connection_pooler, created, endpoint, 14 more }` - `connection_pooler: optional ConnectionPooler` - `endpoint: optional Endpoint` - `host: optional string` - `port: optional number` - `created: optional string` Creation timestamp - `endpoint: optional Endpoint` - `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. - `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: optional string` - `connection_pooler: optional ConnectionPooler` - `cpu_millis: optional number` CPU allocation in milli-cores. - `endpoint: optional 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 - `name: optional string` - `nodes: optional number` Number of nodes in the replica set. - `status: optional "creating" or "active" or "resizing" or 2 more` - `"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. - `"TIMESCALEDB"` - `"POSTGRES"` - `"VECTOR"` - `status: optional "QUEUED" or "DELETING" or "CONFIGURING" or 8 more` Current status of the service - `"QUEUED"` - `"DELETING"` - `"CONFIGURING"` - `"READY"` - `"DELETED"` - `"UNSTABLE"` - `"PAUSING"` - `"PAUSED"` - `"RESUMING"` - `"UPGRADING"` - `"OPTIMIZING"` - `vpcEndpoint: optional unknown` VPC endpoint configuration if available ### Example ```http curl http://localhost:8080/projects/$PROJECT_ID/services/$SERVICE_ID/resize \ -H 'Content-Type: application/json' \ -H "Authorization: Bearer $TIGER_CLOUD_API_KEY" \ -d '{ "cpu_millis": "1000", "memory_gbs": "4" }' ``` #### Response ```json { "connection_pooler": { "endpoint": { "host": "my-service.com", "port": 8080 } }, "created": "2019-12-27T18:11:19.117Z", "endpoint": { "host": "my-service.com", "port": 8080 }, "forked_from": { "is_standby": false, "project_id": "asda1b2c3", "service_id": "bbss422fg" }, "ha_replicas": { "replica_count": 1, "sync_replica_count": 1 }, "initial_password": "a-very-secure-initial-password", "metadata": { "environment": "environment" }, "metrics": { "memory_mb": 512, "milli_cpu": 250, "storage_mb": 1024 }, "name": "name", "project_id": "project_id", "read_replica_sets": [ { "id": "alb8jicdpr", "connection_pooler": { "endpoint": { "host": "my-service.com", "port": 8080 } }, "cpu_millis": 250, "endpoint": { "host": "my-service.com", "port": 8080 }, "memory_gbs": 1, "metadata": { "environment": "environment" }, "name": "reporting-replica-1", "nodes": 2, "status": "active" } ], "region_code": "us-east-1", "resources": [ { "id": "id", "spec": { "cpu_millis": 0, "memory_gbs": 0, "volume_type": "volume_type" } } ], "service_id": "service_id", "service_type": "TIMESCALEDB", "status": "QUEUED", "vpcEndpoint": {} } ``` ## Enable Connection Pooler for a Service **post** `/projects/{project_id}/services/{service_id}/enablePooler` Activates the connection pooler for a specific service within a project. ### Path Parameters - `project_id: string` - `service_id: string` ### Returns - `message: optional string` ### Example ```http curl http://localhost:8080/projects/$PROJECT_ID/services/$SERVICE_ID/enablePooler \ -X POST \ -H "Authorization: Bearer $TIGER_CLOUD_API_KEY" ``` #### Response ```json { "message": "Action completed successfully." } ``` ## Disable Connection Pooler for a Service **post** `/projects/{project_id}/services/{service_id}/disablePooler` Deactivates the connection pooler for a specific service within a project. ### Path Parameters - `project_id: string` - `service_id: string` ### Returns - `message: optional string` ### Example ```http curl http://localhost:8080/projects/$PROJECT_ID/services/$SERVICE_ID/disablePooler \ -X POST \ -H "Authorization: Bearer $TIGER_CLOUD_API_KEY" ``` #### Response ```json { "message": "Action completed successfully." } ``` ## Fork a Service **post** `/projects/{project_id}/services/{service_id}/forkService` Creates a new, independent service within a project by taking a snapshot of an existing one. ### Path Parameters - `project_id: string` - `service_id: string` ### Body Parameters - `fork_strategy: "LAST_SNAPSHOT" or "NOW" or "PITR"` Strategy for creating the fork. This field is required. - `"LAST_SNAPSHOT"` - `"NOW"` - `"PITR"` - `cpu_millis: optional string` The initial CPU allocation in milli-cores, or 'shared' for a shared-resource service. If not provided, will inherit from parent service. - `environment_tag: optional EnvironmentTag` The environment tag for the forked service, 'DEV' by default. - `"DEV"` - `"PROD"` - `memory_gbs: optional string` The initial memory allocation in gigabytes, or 'shared' for a shared-resource service. If not provided, will inherit from parent service. - `name: optional string` A human-readable name for the forked service. If not provided, will use parent service name with "-fork" suffix. - `target_time: optional string` Target time for point-in-time recovery. Required when fork_strategy is PITR. ### Returns - `Service = object { connection_pooler, created, endpoint, 14 more }` - `connection_pooler: optional ConnectionPooler` - `endpoint: optional Endpoint` - `host: optional string` - `port: optional number` - `created: optional string` Creation timestamp - `endpoint: optional Endpoint` - `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. - `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: optional string` - `connection_pooler: optional ConnectionPooler` - `cpu_millis: optional number` CPU allocation in milli-cores. - `endpoint: optional 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 - `name: optional string` - `nodes: optional number` Number of nodes in the replica set. - `status: optional "creating" or "active" or "resizing" or 2 more` - `"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. - `"TIMESCALEDB"` - `"POSTGRES"` - `"VECTOR"` - `status: optional "QUEUED" or "DELETING" or "CONFIGURING" or 8 more` Current status of the service - `"QUEUED"` - `"DELETING"` - `"CONFIGURING"` - `"READY"` - `"DELETED"` - `"UNSTABLE"` - `"PAUSING"` - `"PAUSED"` - `"RESUMING"` - `"UPGRADING"` - `"OPTIMIZING"` - `vpcEndpoint: optional unknown` VPC endpoint configuration if available ### Example ```http curl http://localhost:8080/projects/$PROJECT_ID/services/$SERVICE_ID/forkService \ -H 'Content-Type: application/json' \ -H "Authorization: Bearer $TIGER_CLOUD_API_KEY" \ -d '{ "fork_strategy": "LAST_SNAPSHOT", "cpu_millis": "1000", "memory_gbs": "4", "name": "my-production-db-fork", "target_time": "2024-01-01T00:00:00Z" }' ``` #### Response ```json { "connection_pooler": { "endpoint": { "host": "my-service.com", "port": 8080 } }, "created": "2019-12-27T18:11:19.117Z", "endpoint": { "host": "my-service.com", "port": 8080 }, "forked_from": { "is_standby": false, "project_id": "asda1b2c3", "service_id": "bbss422fg" }, "ha_replicas": { "replica_count": 1, "sync_replica_count": 1 }, "initial_password": "a-very-secure-initial-password", "metadata": { "environment": "environment" }, "metrics": { "memory_mb": 512, "milli_cpu": 250, "storage_mb": 1024 }, "name": "name", "project_id": "project_id", "read_replica_sets": [ { "id": "alb8jicdpr", "connection_pooler": { "endpoint": { "host": "my-service.com", "port": 8080 } }, "cpu_millis": 250, "endpoint": { "host": "my-service.com", "port": 8080 }, "memory_gbs": 1, "metadata": { "environment": "environment" }, "name": "reporting-replica-1", "nodes": 2, "status": "active" } ], "region_code": "us-east-1", "resources": [ { "id": "id", "spec": { "cpu_millis": 0, "memory_gbs": 0, "volume_type": "volume_type" } } ], "service_id": "service_id", "service_type": "TIMESCALEDB", "status": "QUEUED", "vpcEndpoint": {} } ``` ## Update Service Password **post** `/projects/{project_id}/services/{service_id}/updatePassword` Sets a new master password for the service within a project. ### Path Parameters - `project_id: string` - `service_id: string` ### Body Parameters - `password: string` The new password. ### Example ```http curl http://localhost:8080/projects/$PROJECT_ID/services/$SERVICE_ID/updatePassword \ -H 'Content-Type: application/json' \ -H "Authorization: Bearer $TIGER_CLOUD_API_KEY" \ -d '{ "password": "a-very-secure-new-password" }' ``` ## Set Environment for a Service **post** `/projects/{project_id}/services/{service_id}/setEnvironment` Sets the environment type for the service. ### Path Parameters - `project_id: string` - `service_id: string` ### Body Parameters - `environment: "PROD" or "DEV"` The target environment for the service. - `"PROD"` - `"DEV"` ### Returns - `message: optional string` ### Example ```http curl http://localhost:8080/projects/$PROJECT_ID/services/$SERVICE_ID/setEnvironment \ -H 'Content-Type: application/json' \ -H "Authorization: Bearer $TIGER_CLOUD_API_KEY" \ -d '{ "environment": "PROD" }' ``` #### Response ```json { "message": "Action completed successfully." } ``` ## Change HA configuration for a Service **post** `/projects/{project_id}/services/{service_id}/setHA` Changes the HA configuration for a specific service. This is an asynchronous operation. ### Path Parameters - `project_id: string` - `service_id: string` ### Body Parameters - `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. ### Returns - `Service = object { connection_pooler, created, endpoint, 14 more }` - `connection_pooler: optional ConnectionPooler` - `endpoint: optional Endpoint` - `host: optional string` - `port: optional number` - `created: optional string` Creation timestamp - `endpoint: optional Endpoint` - `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. - `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: optional string` - `connection_pooler: optional ConnectionPooler` - `cpu_millis: optional number` CPU allocation in milli-cores. - `endpoint: optional 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 - `name: optional string` - `nodes: optional number` Number of nodes in the replica set. - `status: optional "creating" or "active" or "resizing" or 2 more` - `"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. - `"TIMESCALEDB"` - `"POSTGRES"` - `"VECTOR"` - `status: optional "QUEUED" or "DELETING" or "CONFIGURING" or 8 more` Current status of the service - `"QUEUED"` - `"DELETING"` - `"CONFIGURING"` - `"READY"` - `"DELETED"` - `"UNSTABLE"` - `"PAUSING"` - `"PAUSED"` - `"RESUMING"` - `"UPGRADING"` - `"OPTIMIZING"` - `vpcEndpoint: optional unknown` VPC endpoint configuration if available ### Example ```http curl http://localhost:8080/projects/$PROJECT_ID/services/$SERVICE_ID/setHA \ -H 'Content-Type: application/json' \ -H "Authorization: Bearer $TIGER_CLOUD_API_KEY" \ -d '{ "replica_count": 1, "sync_replica_count": 1 }' ``` #### Response ```json { "connection_pooler": { "endpoint": { "host": "my-service.com", "port": 8080 } }, "created": "2019-12-27T18:11:19.117Z", "endpoint": { "host": "my-service.com", "port": 8080 }, "forked_from": { "is_standby": false, "project_id": "asda1b2c3", "service_id": "bbss422fg" }, "ha_replicas": { "replica_count": 1, "sync_replica_count": 1 }, "initial_password": "a-very-secure-initial-password", "metadata": { "environment": "environment" }, "metrics": { "memory_mb": 512, "milli_cpu": 250, "storage_mb": 1024 }, "name": "name", "project_id": "project_id", "read_replica_sets": [ { "id": "alb8jicdpr", "connection_pooler": { "endpoint": { "host": "my-service.com", "port": 8080 } }, "cpu_millis": 250, "endpoint": { "host": "my-service.com", "port": 8080 }, "memory_gbs": 1, "metadata": { "environment": "environment" }, "name": "reporting-replica-1", "nodes": 2, "status": "active" } ], "region_code": "us-east-1", "resources": [ { "id": "id", "spec": { "cpu_millis": 0, "memory_gbs": 0, "volume_type": "volume_type" } } ], "service_id": "service_id", "service_type": "TIMESCALEDB", "status": "QUEUED", "vpcEndpoint": {} } ``` ## Domain Types ### Connection Pooler - `ConnectionPooler = object { endpoint }` - `endpoint: optional Endpoint` - `host: optional string` - `port: optional number` ### Endpoint - `Endpoint = object { host, port }` - `host: optional string` - `port: optional number` ### Environment Tag - `EnvironmentTag = "DEV" or "PROD"` The environment tag for the service. - `"DEV"` - `"PROD"` ### Resize Input - `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 - `Service = object { connection_pooler, created, endpoint, 14 more }` - `connection_pooler: optional ConnectionPooler` - `endpoint: optional Endpoint` - `host: optional string` - `port: optional number` - `created: optional string` Creation timestamp - `endpoint: optional Endpoint` - `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. - `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: optional string` - `connection_pooler: optional ConnectionPooler` - `cpu_millis: optional number` CPU allocation in milli-cores. - `endpoint: optional 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 - `name: optional string` - `nodes: optional number` Number of nodes in the replica set. - `status: optional "creating" or "active" or "resizing" or 2 more` - `"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. - `"TIMESCALEDB"` - `"POSTGRES"` - `"VECTOR"` - `status: optional "QUEUED" or "DELETING" or "CONFIGURING" or 8 more` Current status of the service - `"QUEUED"` - `"DELETING"` - `"CONFIGURING"` - `"READY"` - `"DELETED"` - `"UNSTABLE"` - `"PAUSING"` - `"PAUSED"` - `"RESUMING"` - `"UPGRADING"` - `"OPTIMIZING"` - `vpcEndpoint: optional unknown` VPC endpoint configuration if available ### Service Vpc Input - `ServiceVpcInput = object { vpc_id }` - `vpc_id: string` The ID of the VPC to attach the service to. ### Set Environment Input - `SetEnvironmentInput = object { environment }` - `environment: "PROD" or "DEV"` The target environment for the service. - `"PROD"` - `"DEV"` ### Service List Response - `ServiceListResponse = array of Service` - `connection_pooler: optional ConnectionPooler` - `endpoint: optional Endpoint` - `host: optional string` - `port: optional number` - `created: optional string` Creation timestamp - `endpoint: optional Endpoint` - `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. - `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: optional string` - `connection_pooler: optional ConnectionPooler` - `cpu_millis: optional number` CPU allocation in milli-cores. - `endpoint: optional 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 - `name: optional string` - `nodes: optional number` Number of nodes in the replica set. - `status: optional "creating" or "active" or "resizing" or 2 more` - `"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. - `"TIMESCALEDB"` - `"POSTGRES"` - `"VECTOR"` - `status: optional "QUEUED" or "DELETING" or "CONFIGURING" or 8 more` Current status of the service - `"QUEUED"` - `"DELETING"` - `"CONFIGURING"` - `"READY"` - `"DELETED"` - `"UNSTABLE"` - `"PAUSING"` - `"PAUSED"` - `"RESUMING"` - `"UPGRADING"` - `"OPTIMIZING"` - `vpcEndpoint: optional unknown` VPC endpoint configuration if available ### Service Attach To Vpc Response - `ServiceAttachToVpcResponse = object { message }` - `message: optional string` ### Service Detach From Vpc Response - `ServiceDetachFromVpcResponse = object { message }` - `message: optional string` ### Service Enable Pooler Response - `ServiceEnablePoolerResponse = object { message }` - `message: optional string` ### Service Disable Pooler Response - `ServiceDisablePoolerResponse = object { message }` - `message: optional string` ### Service Set Environment Response - `ServiceSetEnvironmentResponse = object { message }` - `message: optional string` # Replica Sets ## Get Read Replica Sets **get** `/projects/{project_id}/services/{service_id}/replicaSets` Retrieves a list of all read replica sets associated with a primary service within a project. ### Path Parameters - `project_id: string` - `service_id: string` ### Returns - `id: optional string` - `connection_pooler: optional ConnectionPooler` - `endpoint: optional Endpoint` - `host: optional string` - `port: optional number` - `cpu_millis: optional number` CPU allocation in milli-cores. - `endpoint: optional 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 - `name: optional string` - `nodes: optional number` Number of nodes in the replica set. - `status: optional "creating" or "active" or "resizing" or 2 more` - `"creating"` - `"active"` - `"resizing"` - `"deleting"` - `"error"` ### Example ```http curl http://localhost:8080/projects/$PROJECT_ID/services/$SERVICE_ID/replicaSets \ -H "Authorization: Bearer $TIGER_CLOUD_API_KEY" ``` #### Response ```json [ { "id": "alb8jicdpr", "connection_pooler": { "endpoint": { "host": "my-service.com", "port": 8080 } }, "cpu_millis": 250, "endpoint": { "host": "my-service.com", "port": 8080 }, "memory_gbs": 1, "metadata": { "environment": "environment" }, "name": "reporting-replica-1", "nodes": 2, "status": "active" } ] ``` ## Create a Read Replica Set **post** `/projects/{project_id}/services/{service_id}/replicaSets` Creates a new read replica set for a service. This is an asynchronous operation. ### Path Parameters - `project_id: string` - `service_id: string` ### Body Parameters - `cpu_millis: number` The initial CPU allocation in milli-cores. - `memory_gbs: number` The initial memory allocation in gigabytes. - `name: string` A human-readable name for the read replica. - `nodes: number` Number of nodes to create in the replica set. ### Returns - `ReadReplicaSet = object { id, connection_pooler, cpu_millis, 6 more }` - `id: optional string` - `connection_pooler: optional ConnectionPooler` - `endpoint: optional Endpoint` - `host: optional string` - `port: optional number` - `cpu_millis: optional number` CPU allocation in milli-cores. - `endpoint: optional 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 - `name: optional string` - `nodes: optional number` Number of nodes in the replica set. - `status: optional "creating" or "active" or "resizing" or 2 more` - `"creating"` - `"active"` - `"resizing"` - `"deleting"` - `"error"` ### Example ```http curl http://localhost:8080/projects/$PROJECT_ID/services/$SERVICE_ID/replicaSets \ -H 'Content-Type: application/json' \ -H "Authorization: Bearer $TIGER_CLOUD_API_KEY" \ -d '{ "cpu_millis": 250, "memory_gbs": 1, "name": "my-reporting-replica", "nodes": 2 }' ``` #### Response ```json { "id": "alb8jicdpr", "connection_pooler": { "endpoint": { "host": "my-service.com", "port": 8080 } }, "cpu_millis": 250, "endpoint": { "host": "my-service.com", "port": 8080 }, "memory_gbs": 1, "metadata": { "environment": "environment" }, "name": "reporting-replica-1", "nodes": 2, "status": "active" } ``` ## Delete a Read Replica Set **delete** `/projects/{project_id}/services/{service_id}/replicaSets/{replica_set_id}` Deletes a specific read replica set. This is an asynchronous operation. ### Path Parameters - `project_id: string` - `service_id: string` - `replica_set_id: string` ### Example ```http curl http://localhost:8080/projects/$PROJECT_ID/services/$SERVICE_ID/replicaSets/$REPLICA_SET_ID \ -X DELETE \ -H "Authorization: Bearer $TIGER_CLOUD_API_KEY" ``` ## Resize a Read Replica Set **post** `/projects/{project_id}/services/{service_id}/replicaSets/{replica_set_id}/resize` Changes the resource allocation for a specific read replica set. ### Path Parameters - `project_id: string` - `service_id: string` - `replica_set_id: string` ### Body Parameters - `cpu_millis: string` The new CPU allocation in milli-cores. - `memory_gbs: string` The new memory allocation in gigabytes. ### Example ```http curl http://localhost:8080/projects/$PROJECT_ID/services/$SERVICE_ID/replicaSets/$REPLICA_SET_ID/resize \ -H 'Content-Type: application/json' \ -H "Authorization: Bearer $TIGER_CLOUD_API_KEY" \ -d '{ "cpu_millis": "1000", "memory_gbs": "4" }' ``` ## Enable Connection Pooler for a Read Replica **post** `/projects/{project_id}/services/{service_id}/replicaSets/{replica_set_id}/enablePooler` Activates the connection pooler for a specific read replica set. ### Path Parameters - `project_id: string` - `service_id: string` - `replica_set_id: string` ### Returns - `message: optional string` ### Example ```http curl http://localhost:8080/projects/$PROJECT_ID/services/$SERVICE_ID/replicaSets/$REPLICA_SET_ID/enablePooler \ -X POST \ -H "Authorization: Bearer $TIGER_CLOUD_API_KEY" ``` #### Response ```json { "message": "Action completed successfully." } ``` ## Disable Connection Pooler for a Read Replica **post** `/projects/{project_id}/services/{service_id}/replicaSets/{replica_set_id}/disablePooler` Deactivates the connection pooler for a specific read replica set. ### Path Parameters - `project_id: string` - `service_id: string` - `replica_set_id: string` ### Returns - `message: optional string` ### Example ```http curl http://localhost:8080/projects/$PROJECT_ID/services/$SERVICE_ID/replicaSets/$REPLICA_SET_ID/disablePooler \ -X POST \ -H "Authorization: Bearer $TIGER_CLOUD_API_KEY" ``` #### Response ```json { "message": "Action completed successfully." } ``` ## Set Environment for a Read Replica **post** `/projects/{project_id}/services/{service_id}/replicaSets/{replica_set_id}/setEnvironment` Sets the environment type for the read replica set. ### Path Parameters - `project_id: string` - `service_id: string` - `replica_set_id: string` ### Body Parameters - `environment: "PROD" or "DEV"` The target environment for the service. - `"PROD"` - `"DEV"` ### Returns - `message: optional string` ### Example ```http curl http://localhost:8080/projects/$PROJECT_ID/services/$SERVICE_ID/replicaSets/$REPLICA_SET_ID/setEnvironment \ -H 'Content-Type: application/json' \ -H "Authorization: Bearer $TIGER_CLOUD_API_KEY" \ -d '{ "environment": "PROD" }' ``` #### Response ```json { "message": "Action completed successfully." } ``` ## Domain Types ### Read Replica Set - `ReadReplicaSet = object { id, connection_pooler, cpu_millis, 6 more }` - `id: optional string` - `connection_pooler: optional ConnectionPooler` - `endpoint: optional Endpoint` - `host: optional string` - `port: optional number` - `cpu_millis: optional number` CPU allocation in milli-cores. - `endpoint: optional 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 - `name: optional string` - `nodes: optional number` Number of nodes in the replica set. - `status: optional "creating" or "active" or "resizing" or 2 more` - `"creating"` - `"active"` - `"resizing"` - `"deleting"` - `"error"` ### Replica Set Retrieve Replica Sets Response - `ReplicaSetRetrieveReplicaSetsResponse = array of ReadReplicaSet` - `id: optional string` - `connection_pooler: optional ConnectionPooler` - `endpoint: optional Endpoint` - `host: optional string` - `port: optional number` - `cpu_millis: optional number` CPU allocation in milli-cores. - `endpoint: optional 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 - `name: optional string` - `nodes: optional number` Number of nodes in the replica set. - `status: optional "creating" or "active" or "resizing" or 2 more` - `"creating"` - `"active"` - `"resizing"` - `"deleting"` - `"error"` ### Replica Set Enable Pooler Response - `ReplicaSetEnablePoolerResponse = object { message }` - `message: optional string` ### Replica Set Disable Pooler Response - `ReplicaSetDisablePoolerResponse = object { message }` - `message: optional string` ### Replica Set Set Environment Response - `ReplicaSetSetEnvironmentResponse = object { message }` - `message: optional string`