Set Environment for a Read Replica

Sets the environment type for the read replica set.

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

Try it

Set Environment for a Read Replica

cURL

curl --request POST \
  --url https://console.cloud.timescale.com/public/api/v1/projects/{project_id}/services/{service_id}/replicaSets/{replica_set_id}/setEnvironment \
  --header 'Content-Type: application/json' \
  --data '
{
  "environment": "PROD"
}
'

200

{
  "message": "Action completed successfully."
}

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

environment · enum<string> · required

The target environment for the service.

Available options: PROD, DEV

Response

200

application/json

The action was completed successfully.

message · string

Example:

"Action completed successfully."