Skip to content

Add service start and stop to the REST API ref and Tiger CLI. #4568

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
billy-the-fish merged 3 commits into from
Nov 19, 2025
Merged

Add service start and stop to the REST API ref and Tiger CLI. #4568

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
622096f
Add service start and stop to the REST API ref and Tiger CLI.
billy-the-fish Nov 13, 2025
ab878f4
Merge branch 'latest' into start-stop-service-cli
billy-the-fish Nov 17, 2025
e7b5114
Merge branch 'latest' into start-stop-service-cli
billy-the-fish Nov 18, 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
2 changes: 2 additions & 0 deletions _partials/_devops-cli-reference.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -25,6 +25,8 @@ You can use the following commands with $CLI_LONG. For more information on each
| | get `<service-id>` <br/>aliases: `describe`, `show` | Show detailed information about a specific $SERVICE_SHORT in this $PROJECT_SHORT |
| | list | List all the $SERVICE_SHORTs in this $PROJECT_SHORT |
| | update-password `<service-id>` | Update the master password for a $SERVICE_SHORT |
| | start `<service-id>` | Start a $SERVICE_SHORT that is currently inactive. Possible flags are: <ul><li>`--no-wait`: don't wait for the operation to complete</li><li>`--wait-timeout`: set the maximum wait time for this operation to complete. For example, `10m` (default), `30m`, `1h30m`, `90s`</li></ul> |
| | stop `<service-id>` | Stop a $SERVICE_SHORT that is currently active. After you run this command `<service-id>` no longer accepts connections. Possible flags are: <ul><li>`--no-wait`: don't wait for the operation to complete</li><li>`--wait-timeout`: set the maximum wait time for this operation to complete. For example, `10m` (default), `30m`, `1h30m`, `90s`</li></ul> |
| db | | Database operations and management |
| | connect `<service-id>` | Connect to a $SERVICE_SHORT |
| | connection-string `<service-id>` | Retrieve the connection string for a $SERVICE_SHORT |
Expand Down
72 changes: 72 additions & 0 deletions api/api-reference.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -276,6 +276,78 @@ Change the HA configuration for a service. This is an asynchronous operation.

**Response:** `202 Accepted`

### Stop a Service

```http
POST /projects/{project_id}/services/{service_id}/stop
```

Stop a running service. This is an asynchronous operation.

**Response:** `202 Accepted`
```json
{
"service_id": "p7zm9wqqii",
"project_id": "jz22xtzemv",
"name": "test-2",
"region_code": "eu-central-1",
"service_type": "TIMESCALEDB",
"created": "2025-09-04T20:46:46.26568Z",
"paused": false,
"status": "PAUSING",
"resources": [
{
"id": "100927",
"spec": {
"cpu_millis": 1000,
"memory_gbs": 4,
"volume_type": ""
}
}
],
"endpoint": {
"host": "p7zm8wqqii.jz4qxtzemv.tsdb.cloud.timescale.com",
"port": 35482
}
}
```

### Start a Service

```http
POST /projects/{project_id}/services/{service_id}/start
```

Start a stopped service. This is an asynchronous operation.

**Response:** `202 Accepted`
```json
{
"service_id": "p7zm9wqqii",
"project_id": "jz22xtzemv",
"name": "test-2",
"region_code": "eu-central-1",
"service_type": "TIMESCALEDB",
"created": "2025-09-04T20:46:46.26568Z",
"paused": false,
"status": "RESUMING",
"resources": [
{
"id": "100927",
"spec": {
"cpu_millis": 1000,
"memory_gbs": 4,
"volume_type": ""
}
}
],
"endpoint": {
"host": "p7zm8wqqii.jz4qxtzemv.tsdb.cloud.timescale.com",
"port": 35482
}
}
```

### Connection Pooler Management

#### Enable Connection Pooler
Expand Down