Postgres

Create new Postgres service

This endpoint is in beta. API contract is stable, and no breaking changes are expected in the future. <br /><br /> Creates a new Postgres service in the organization and returns it. The service is started asynchronously.

post/v1/organizations/{organizationId}/postgres

Request

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

Path parameters

organizationIdstring uuid required

ID of the organization that will own the service.

Request body

namestring required

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

provider'aws' | 'gcp' required

The cloud provider for a Postgres service.

regionstring required

The cloud region for a Postgres service.

postgresVersion'18' | '17'
size'c6gd.large' | 'c6gd.xlarge' | 'c6gd.2xlarge' | 'c6gd.4xlarge' | 'c6gd.8xlarge' | 'c6gd.16xlarge' | 'i7i.large' | 'i7i.xlarge' | 'i7i.2xlarge' | 'i7i.4xlarge' | 'i7i.8xlarge' | 'i7i.12xlarge' | 'i7i.16xlarge' | 'i7i.24xlarge' | 'i7ie.large' | 'i7ie.xlarge' | 'i7ie.2xlarge' | 'i7ie.3xlarge' | 'i7ie.6xlarge' | 'i7ie.12xlarge' | 'i7ie.18xlarge' | 'i7ie.24xlarge' | 'i8g.large' | 'i8g.xlarge' | 'i8g.2xlarge' | 'i8g.4xlarge' | 'i8g.8xlarge' | 'i8g.16xlarge' | 'i8g.24xlarge' | 'i8ge.large' | 'i8ge.xlarge' | 'i8ge.2xlarge' | 'i8ge.3xlarge' | 'i8ge.6xlarge' | 'i8ge.12xlarge' | 'i8ge.18xlarge' | 'i8ge.24xlarge' | 'm6gd.large' | 'm6gd.xlarge' | 'm6gd.2xlarge' | 'm6gd.4xlarge' | 'm6gd.8xlarge' | 'm6gd.16xlarge' | 'm6id.large' | 'm6id.xlarge' | 'm6id.2xlarge' | 'm6id.4xlarge' | 'm6id.8xlarge' | 'm6id.16xlarge' | 'm8gd.large' | 'm8gd.xlarge' | 'm8gd.2xlarge' | 'm8gd.4xlarge' | 'm8gd.8xlarge' | 'm8gd.16xlarge' | 'r6gd.medium' | 'r6gd.large' | 'r6gd.xlarge' | 'r6gd.2xlarge' | 'r6gd.4xlarge' | 'r6gd.8xlarge' | 'r6gd.12xlarge' | 'r6gd.16xlarge' | 'r6id.large' | 'r6id.xlarge' | 'r6id.2xlarge' | 'r6id.4xlarge' | 'r6id.8xlarge' | 'r6id.12xlarge' | 'r6id.16xlarge' | 'r6id.24xlarge' | 'r6id.32xlarge' | 'r8gd.medium' | 'r8gd.large' | 'r8gd.xlarge' | 'r8gd.2xlarge' | 'r8gd.4xlarge' | 'r8gd.8xlarge' | 'r8gd.12xlarge' | 'r8gd.16xlarge' | 'r8gd.24xlarge' | 'r8gd.48xlarge' | 'c4a-highmem-4' | 'c4a-highmem-8' | 'c4a-highmem-16' | 'c4a-highmem-32' | 'c4a-highmem-48' | 'c4a-highmem-64' | 'c4a-highmem-72' | 'c4a-standard-4' | 'c4a-standard-8' | 'c4a-standard-16' | 'c4a-standard-32' | 'c4a-standard-48' | 'c4a-standard-64' | 'c4a-standard-72' | 'c4-highmem-4' | 'c4-highmem-8' | 'c4-highmem-16' | 'c4-highmem-24' | 'c4-highmem-32' | 'c4-highmem-48' | 'c4-highmem-96' | 'c4-highmem-144' | 'c4-highmem-192' | 'c4-highmem-288' | 'c4-standard-4' | 'c4-standard-8' | 'c4-standard-16' | 'c4-standard-24' | 'c4-standard-32' | 'c4-standard-48' | 'c4-standard-96' | 'c4-standard-144' | 'c4-standard-192' | 'c4-standard-288' | 'c4d-highmem-8' | 'c4d-highmem-16' | 'c4d-highmem-32' | 'c4d-highmem-48' | 'c4d-highmem-64' | 'c4d-highmem-96' | 'c4d-highmem-192' | 'c4d-highmem-384' | 'c4d-standard-8' | 'c4d-standard-16' | 'c4d-standard-32' | 'c4d-standard-48' | 'c4d-standard-64' | 'c4d-standard-96' | 'c4d-standard-192' | 'c4d-standard-384' | 'z3-highlssd-8' | 'z3-highlssd-16' | 'z3-highlssd-22' | 'z3-highlssd-32' | 'z3-highlssd-44' | 'z3-highlssd-88' | 'z3-standardlssd-14' | 'z3-standardlssd-22' | 'z3-standardlssd-44' | 'z3-standardlssd-88' | 'z3-standardlssd-176' required

The VM size for a Postgres service.

haType'none' | 'async' | 'sync'

Type of high availability: “none” for no replication, “async” for asynchronous replication to a single standby, and “sync” for synchronous replication to two standbys.

pgBouncerConfigPgBouncerConfig

PgBouncer runtime configuration configuration.

Example request

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

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.