/v1/organizations/{organizationId}/postgres/{postgresId}/readReplicaInitiate the process to create a new read replica for a Postgres service.
Permission
The API key must have the control-plane:postgres-service:manage and control-plane:organization:create-service permissions.
Authorizations
- AuthorizationstringheaderrequiredUse key ID and key secret obtained in ClickHouse Cloud console: https://clickhouse.com/docs/cloud/manage/openapi
Path parameters
Request bodyJSON
- pgConfigoptionalobject{ … }
Postgres runtime configuration configuration.
Example: {"max_connections":100}64 properties
- pgBouncerConfigoptionalmap ofstring
PgBouncer runtime configuration configuration.
Example: {"default_pool_size":"16"}
Response
200
Successful response
- resultoptionalobject{ … }
20 properties
- connectionStringoptionalstring
Connection string to the Postgres service. Embeds the service password, so it is only returned when the service is created or its password is reset. Omitted from every other response when Postgres credential redaction is enabled for the organization. Not guaranteed to be present — treat as optional.
400
The request cannot be processed due to a client error. Please verify your request parameters and try again.
500
An internal server error has occurred. If this issue persists, please contact ClickHouse Cloud support for assistance.