Tiger Cloud REST API

A comprehensive RESTful API for managing Tiger Cloud resources including VPCs, services, and read replicas

• API Version: 1.0.0
• Base URL: https://console.cloud.timescale.com/public/api/v1

Authentication

The Tiger Cloud REST API uses HTTP Basic Authentication. Include your access key and secret key in the Authorization header.

Basic Authentication

Authorization: Basic <base64(access_key:secret_key)>

Example

# Using cURL
curl -X GET "https://console.cloud.timescale.com/public/api/v1/projects/{project_id}/services" \
  -H "Authorization: Basic $(echo -n 'your_access_key:your_secret_key' | base64)"

Service Management

You use this endpoint to create a Tiger Cloud service with one or more of the following addons:

• time-series: a Tiger Cloud service optimized for real-time analytics. For time-stamped data like events, prices, metrics, sensor readings, or any information that changes over time.
• ai: a Tiger Cloud service instance with vector extensions.

To have multiple addons when you create a new service, set "addons": ["time-series", "ai"]. To create a vanilla Postgres instance, set addons to an empty list [].

API Endpoints

The REST API is organized around three main resource types:

Service Management

Manage Tiger Cloud database services:

• 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}
• Resize a Service - POST /projects/{project_id}/services/{service_id}/resize
• 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
• 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
• Attach Service to VPC - POST /projects/{project_id}/services/{service_id}/attachToVPC
• Detach Service from VPC - POST /projects/{project_id}/services/{service_id}/detachFromVPC

Read Replica Sets

Manage read replicas for improved read performance:

• 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

VPC Management

Manage Virtual Private Clouds for network isolation:

• 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

VPC Peering

Manage peering connections between VPCs:

• 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}

Analytics

Track usage and events for analytics purposes:

• Identify a User - POST /analytics/identify
• Track an Analytics Event - POST /analytics/track