diff --git a/_partials/_devops-cli-reference.md b/_partials/_devops-cli-reference.md index 4fe8151ff6..cc8aa99fcf 100644 --- a/_partials/_devops-cli-reference.md +++ b/_partials/_devops-cli-reference.md @@ -25,6 +25,8 @@ You can use the following commands with $CLI_LONG. For more information on each | | get ``
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 `` | Update the master password for a $SERVICE_SHORT | +| | start `` | Start a $SERVICE_SHORT that is currently inactive. Possible flags are:
  • `--no-wait`: don't wait for the operation to complete
  • `--wait-timeout`: set the maximum wait time for this operation to complete. For example, `10m` (default), `30m`, `1h30m`, `90s`
| +| | stop `` | Stop a $SERVICE_SHORT that is currently active. After you run this command `` no longer accepts connections. Possible flags are:
  • `--no-wait`: don't wait for the operation to complete
  • `--wait-timeout`: set the maximum wait time for this operation to complete. For example, `10m` (default), `30m`, `1h30m`, `90s`
| | db | | Database operations and management | | | connect `` | Connect to a $SERVICE_SHORT | | | connection-string `` | Retrieve the connection string for a $SERVICE_SHORT | diff --git a/api/api-reference.md b/api/api-reference.md index de6baf5b27..42a3ec37f1 100644 --- a/api/api-reference.md +++ b/api/api-reference.md @@ -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