Skip to content
Open
Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
47 commits
Select commit Hold shift + click to select a range
a52c271
chore: more migration.
billy-the-fish Sep 17, 2025
c38b45f
Merge branch '400-migration-branch' of github.com:timescale/documenta…
billy-the-fish Nov 3, 2025
89f5c56
chore: first step on the hyperfunctions
billy-the-fish Nov 5, 2025
f4530ff
chore: last hyperfunctions
billy-the-fish Nov 6, 2025
96395fe
chore: hypertable
billy-the-fish Nov 6, 2025
fbaeb28
chore: hypertable
billy-the-fish Nov 6, 2025
58cabf4
chore: add the snippets
billy-the-fish Nov 7, 2025
4447dbf
chore: more edits
billy-the-fish Nov 7, 2025
3720164
chore: variables and PGAI
billy-the-fish Nov 9, 2025
43680e3
chore: pgvectorscale
billy-the-fish Nov 9, 2025
91c4daf
chore: variables
billy-the-fish Nov 9, 2025
71b8cea
chore: more migration.
billy-the-fish Nov 11, 2025
b58f750
Merge branch '369-migrate-the-timescaledb-api-ref-to-mintlify' of git…
billy-the-fish Nov 11, 2025
d7ebe0e
chore: more migration.
billy-the-fish Nov 11, 2025
794cdff
chore: code checks
billy-the-fish Nov 11, 2025
cb68ce1
chore: cleanup
billy-the-fish Nov 11, 2025
638deaa
With menus (#16)
billy-the-fish Nov 13, 2025
11ae0dd
chore: add Agentic Postgres to the landing page
billy-the-fish Nov 13, 2025
d5027df
chore: rename :-).
billy-the-fish Nov 13, 2025
998118a
update for text wrapping in tables
atovpeko Nov 17, 2025
4a21c53
chore: remove extra sentences in api features list.
billy-the-fish Nov 17, 2025
fe3395c
chore: move api category.
billy-the-fish Nov 17, 2025
0dcaa1e
chore: old and deprecated.
billy-the-fish Nov 17, 2025
f5ab912
chore: cleanup
billy-the-fish Nov 17, 2025
ac6e8de
chore: update materialized view arguments table
billy-the-fish Nov 17, 2025
4f95c42
Update api-reference/timescaledb/continuous-aggregates/drop_materiali…
billy-the-fish Nov 17, 2025
3836a6d
chore: updates
billy-the-fish Nov 17, 2025
e4e8fa0
chore: Samples before arguments in the API ref.
billy-the-fish Nov 17, 2025
7400f2a
update for missing functions
atovpeko Nov 18, 2025
342b18b
chore: add syntax, sort out returns for hyperfunctions.
billy-the-fish Nov 18, 2025
1debf47
chore: cleanup.
billy-the-fish Nov 18, 2025
4eaa45c
chore: ugly workaround for listing .
billy-the-fish Nov 18, 2025
9c08cf3
chore: add syntax.
billy-the-fish Nov 18, 2025
09974ee
chore: remove dead cards.
billy-the-fish Nov 18, 2025
24c8d75
text wrapping
atovpeko Nov 20, 2025
84facdd
update for missing columns
atovpeko Nov 24, 2025
bffee0e
chore: Update nav to have full dropdowns.
billy-the-fish Nov 24, 2025
f3dc248
chore: update on review.
billy-the-fish Nov 26, 2025
ded1fc2
chore: Add returns.
billy-the-fish Nov 26, 2025
c86139c
chore: get REST working.
billy-the-fish Nov 27, 2025
04f1253
chore: get REST working.
billy-the-fish Nov 27, 2025
86f000f
chore: merge
billy-the-fish Nov 27, 2025
a54f872
chore: update into for REST API updates.
billy-the-fish Nov 27, 2025
d6b1ec1
chore: add returns info.
billy-the-fish Nov 27, 2025
a24e68a
chore: add returns info.
billy-the-fish Nov 28, 2025
161f49f
chore: add since info.
billy-the-fish Nov 28, 2025
7b18b79
Merge.
billy-the-fish Nov 28, 2025
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1,827 changes: 0 additions & 1,827 deletions api-reference/pgai/vectorizer-api-reference.mdx

This file was deleted.

69 changes: 63 additions & 6 deletions api-reference/tiger-cloud-rest-api/introduction.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -9,23 +9,78 @@ description: A comprehensive RESTful API for managing Tiger Cloud resources incl

## Authentication

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

To run the samples in this API reference, add your [public key and secret key](/integrations/integrate/find-connection-details)
as the `Authorization.username` and `Authorization.password` when you run the calls.

### Basic Authentication
```http
Authorization: Basic <base64(access_key:secret_key)>
Authorization: Basic <base64(public_key:secret_key)>
```

### Example
## Samples

### List all services

```bash
# 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)"
-H "Authorization: Basic $(echo -n 'your_public_key:your_secret_key' | base64)"
```

### Create a new service

```bash
curl -X POST "https://console.cloud.timescale.com/public/api/v1/projects/{project_id}/services" \
-H "Authorization: Basic $(echo -n 'your_public_key:your_secret_key' | base64)" \
-H "Content-Type: application/json" \
-d '{
"name": "my-production-db",
"region_code": "us-east-1",
"compute": {
"cpu": "0.5",
"memory_gb": 2
}
}'
```

### Create a VPC

```bash
curl -X POST "https://console.cloud.timescale.com/public/api/v1/projects/{project_id}/vpcs" \
-H "Authorization: Basic $(echo -n 'your_public_key:your_secret_key' | base64)" \
-H "Content-Type: application/json" \
-d '{
"name": "my-vpc",
"region_code": "us-east-1",
"cidr": "10.0.0.0/16"
}'
```

### Create a read replica set

```bash
curl -X POST "https://console.cloud.timescale.com/public/api/v1/projects/{project_id}/services/{service_id}/replicaSets" \
-H "Authorization: Basic $(echo -n 'your_public_key:your_secret_key' | base64)" \
-H "Content-Type: application/json" \
-d '{
"region_code": "us-west-2",
"compute": {
"cpu": "0.5",
"memory_gb": 2
}
}'
```

## API Endpoints

The REST API is organized around three main resource types:
The REST API is organized around the following resource types:

### Authentication

Get information about your API credentials:

- [**Get Authentication Info**](/api-reference/auth/get-authentication-info) - `GET /auth/info`

### Service Management

Expand All @@ -35,6 +90,8 @@ Manage Tiger Cloud database services:
- [**Create a Service**](/api-reference/services/create-a-service) - `POST /projects/{project_id}/services`
- [**Get a Service**](/api-reference/services/get-a-service) - `GET /projects/{project_id}/services/{service_id}`
- [**Delete a Service**](/api-reference/services/delete-a-service) - `DELETE /projects/{project_id}/services/{service_id}`
- [**Start a Service**](/api-reference/services/start-a-service) - `POST /projects/{project_id}/services/{service_id}/start`
- [**Stop a Service**](/api-reference/services/stop-a-service) - `POST /projects/{project_id}/services/{service_id}/stop`
- [**Resize a Service**](/api-reference/services/resize-a-service) - `POST /projects/{project_id}/services/{service_id}/resize`
- [**Update Service Password**](/api-reference/services/update-service-password) - `POST /projects/{project_id}/services/{service_id}/updatePassword`
- [**Set Environment for a Service**](/api-reference/services/set-environment-for-a-service) - `POST /projects/{project_id}/services/{service_id}/setEnvironment`
Expand Down
Loading