Postgres

Create a read replica for a Postgres service

This endpoint is in beta. API contract is stable, and no breaking changes are expected in the future. <br /><br /> Initiate the process to create a new read replica for a Postgres service.

post/v1/organizations/{organizationId}/postgres/{postgresId}/readReplica

Request

Base URL: https://api.clickhouse.cloud
URL: https://api.clickhouse.cloud/v1/organizations/{organizationId}/postgres/{postgresId}/readReplica
Auth: HTTP basic

Path parameters

organizationIdstring uuid required

ID of the organization that owns the Postgres service.

postgresIdstring uuid required

ID of the requested Postgres service.

Request body

namestring required

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

pgBouncerConfigPgBouncerConfig

PgBouncer runtime configuration configuration.

Example request

{
  "pgConfig": {
    "max_connections": 100
  },
  "pgBouncerConfig": {
    "default_pool_size": "16"
  },
  "tags": [
    {
      "key": "Environment",
      "value": "staging"
    }
  ]
}

Response

Successful response

statusnumber

HTTP status code.

requestIdstring uuid

Unique id assigned to every request. UUIDv4

Example response

{
  "status": 200,
  "result": {
    "tags": [
      {
        "key": "Environment",
        "value": "staging"
      }
    ],
    "id": "f71df78e-ddad-82d0-8dfa-abbec741b82e",
    "createdAt": "2026-03-26T20:51:16.384Z"
  }
}

Changes

No recorded changes to this operation across all 1 revision of this API.