Resize a Read Replica Set

Changes the resource allocation for a specific read replica set.

POST /projects/{project_id}/services/{service_id}/replicaSets/{replica_set_id}/resize

Try it

Resize a Read Replica Set

cURL

curl --request POST \
  --url https://console.cloud.timescale.com/public/api/v1/projects/{project_id}/services/{service_id}/replicaSets/{replica_set_id}/resize \
  --header 'Authorization: Basic <encoded-value>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "cpu_millis": 1000,
  "memory_gbs": 4,
  "nodes": 2
}
'

4XX

{
  "code": "<string>",
  "message": "<string>"
}

Authorizations

Authorization · string · header · required

HTTP Basic Authentication using your Tiger Cloud public key and secret key.

Format: Authorization: Basic <base64(public_key:secret_key)>

Example:

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

Path Parameters

project_id · string · required

The unique identifier of the project.

Example:

"rp1pz7uyae"

service_id · string · required

The unique identifier of the service.

Example:

"d1k5vk7hf2"

replica_set_id · string · required

The unique identifier of the read replica set.

Example:

"alb8jicdpr"

Body

application/json

cpu_millis · integer · required

The new CPU allocation in milli-cores (e.g., 1000 for 1 vCPU).

Example:

1000

memory_gbs · integer · required

The new memory allocation in gigabytes.

Example:

4

nodes · integer

The new number of nodes in the replica set.

Example:

2

Response

202

Resize request has been accepted and is in progress.