Passer au contenu principal
POST
Create a read replica for a Postgres service
Initiate the process to create a new read replica for a Postgres service.

Permissions

The API key must have the control-plane:postgres-service:manage, control-plane:organization:create-service permissions.

Autorisations

Authorization
string
header
requis

Use key ID and key secret obtained in ClickHouse Cloud console: https://clickhouse.com/docs/cloud/manage/openapi

Paramètres de chemin

organizationId
string<uuid>
requis

ID of the organization that owns the Postgres service.

postgresId
string<uuid>
requis

ID of the requested Postgres service.

Corps

application/json
name
string
requis

Name of the Postgres service. Alphanumerical string with whitespaces up to 50 characters.

Required string length: 1 - 50
pgConfig
Postgres Configuration · object

Postgres runtime configuration configuration.

Exemple:
pgBouncerConfig
PgBouncer Configuration · object

PgBouncer runtime configuration configuration.

Exemple:
tags
Postgres Tags · object[]

Tags associated with the Postgres service. Tag keys starting with “chc_” are reserved for internal use.

Maximum array length: 50

Réponse

Successful response

status
number

HTTP status code.

Exemple:

200

requestId
string<uuid>

Unique id assigned to every request. UUIDv4

result
object