Create new Postgres service

This endpoint is in beta. API contract is stable, and no breaking changes are expected in the future.

Creates a new Postgres service in the organization and returns it. The service is started asynchronously.

POST /v1/organizations/{organizationId}/postgres

Create new Postgres service

cURL

curl --request POST \
  --url https://api.clickhouse.cloud/v1/organizations/{organizationId}/postgres \
  --header 'Authorization: Basic <encoded-value>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "name": "<string>",
  "provider": "aws",
  "region": "<string>",
  "tags": [
    {
      "key": "Environment",
      "value": "staging"
    }
  ],
  "pgConfig": {
    "max_connections": 100
  },
  "pgBouncerConfig": {
    "default_pool_size": "16"
  }
}
'

import requests

url = "https://api.clickhouse.cloud/v1/organizations/{organizationId}/postgres"

payload = {
    "name": "<string>",
    "provider": "aws",
    "region": "<string>",
    "tags": [
        {
            "key": "Environment",
            "value": "staging"
        }
    ],
    "pgConfig": { "max_connections": 100 },
    "pgBouncerConfig": { "default_pool_size": "16" }
}
headers = {
    "Authorization": "Basic <encoded-value>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'POST',
  headers: {Authorization: 'Basic <encoded-value>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    name: '<string>',
    provider: 'aws',
    region: '<string>',
    tags: [{key: 'Environment', value: 'staging'}],
    pgConfig: {max_connections: 100},
    pgBouncerConfig: {default_pool_size: '16'}
  })
};

fetch('https://api.clickhouse.cloud/v1/organizations/{organizationId}/postgres', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.clickhouse.cloud/v1/organizations/{organizationId}/postgres",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    'name' => '<string>',
    'provider' => 'aws',
    'region' => '<string>',
    'tags' => [
        [
                'key' => 'Environment',
                'value' => 'staging'
        ]
    ],
    'pgConfig' => [
        'max_connections' => 100
    ],
    'pgBouncerConfig' => [
        'default_pool_size' => '16'
    ]
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: Basic <encoded-value>",
    "Content-Type: application/json"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://api.clickhouse.cloud/v1/organizations/{organizationId}/postgres"

	payload := strings.NewReader("{\n  \"name\": \"<string>\",\n  \"provider\": \"aws\",\n  \"region\": \"<string>\",\n  \"tags\": [\n    {\n      \"key\": \"Environment\",\n      \"value\": \"staging\"\n    }\n  ],\n  \"pgConfig\": {\n    \"max_connections\": 100\n  },\n  \"pgBouncerConfig\": {\n    \"default_pool_size\": \"16\"\n  }\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("Authorization", "Basic <encoded-value>")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.post("https://api.clickhouse.cloud/v1/organizations/{organizationId}/postgres")
  .header("Authorization", "Basic <encoded-value>")
  .header("Content-Type", "application/json")
  .body("{\n  \"name\": \"<string>\",\n  \"provider\": \"aws\",\n  \"region\": \"<string>\",\n  \"tags\": [\n    {\n      \"key\": \"Environment\",\n      \"value\": \"staging\"\n    }\n  ],\n  \"pgConfig\": {\n    \"max_connections\": 100\n  },\n  \"pgBouncerConfig\": {\n    \"default_pool_size\": \"16\"\n  }\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.clickhouse.cloud/v1/organizations/{organizationId}/postgres")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Basic <encoded-value>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"name\": \"<string>\",\n  \"provider\": \"aws\",\n  \"region\": \"<string>\",\n  \"tags\": [\n    {\n      \"key\": \"Environment\",\n      \"value\": \"staging\"\n    }\n  ],\n  \"pgConfig\": {\n    \"max_connections\": 100\n  },\n  \"pgBouncerConfig\": {\n    \"default_pool_size\": \"16\"\n  }\n}"

response = http.request(request)
puts response.read_body

200

{
  "status": 200,
  "requestId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "result": {
    "name": "<string>",
    "provider": "aws",
    "region": "<string>",
    "tags": [
      {
        "key": "Environment",
        "value": "staging"
      }
    ],
    "id": "f71df78e-ddad-82d0-8dfa-abbec741b82e",
    "storageSize": 123,
    "createdAt": "2026-03-26T20:51:16.384Z",
    "isPrimary": false,
    "connectionString": "<string>",
    "username": "<string>",
    "password": "<string>",
    "hostname": "<string>"
  }
}

{
  "status": 400,
  "error": "<string>",
  "requestId": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
}

{
  "status": 500,
  "error": "<string>",
  "requestId": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
}

Beta

This endpoint is in beta. API contract is stable, and no breaking changes are expected in the future.

Creates a new Postgres service in the organization and returns it. The service is started asynchronously.

Authorizations

Authorization · string · header · required

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

Path Parameters

organizationId · string<uuid> · required

ID of the organization that will own the service.

Body

application/json

name · string · required

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

Required string length: 1 - 50

provider · enum<string> · required

The cloud provider for a Postgres service.

Available options: aws

region · string · required

The cloud region for a Postgres service.

size · enum<string> · required

The VM size for a Postgres service.

Available options: 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

postgresVersion · enum<string>

Available options: 18, 17

haType · enum<string>

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

Available options: none, async, sync

tags · Postgres Tags · object[]

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

Maximum array length: 50

Show child attributes

pgConfig · Postgres Configuration · object

Postgres runtime configuration configuration.

Show child attributes

Example:

{ "max_connections": 100 }

pgBouncerConfig · PgBouncer Configuration · object

PgBouncer runtime configuration configuration.

Show child attributes

Example:

{ "default_pool_size": "16" }

Response

200

application/json

Successful response

status · number

HTTP status code.

Example:

200

requestId · string<uuid>

Unique id assigned to every request. UUIDv4

result · object

Show child attributes