List of organization Postgres services

GET/v1/organizations/{organizationId}/postgres

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

Returns a list of all Postgres services in the organization.

Authorizations

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

Path parameters

organizationIdstringrequired
ID of the organization that owns the services.

format: uuid

Response

JSON

200

Successful response

JSON

statusoptionalnumber
HTTP status code.

Example: 200
requestIdoptionalstring
Unique id assigned to every request. UUIDv4

format: uuid
resultoptionalarray ofobject
11 properties
- nameoptionalstring
  Name of the Postgres service. Alphanumerical string with whitespaces up to 50 characters.
  
  maxLength: 50, minLength: 1
- provideroptionalawsorgcp
  The cloud provider for a Postgres service.
- regionoptionalstring
  The cloud region for a Postgres service.
- postgresVersionoptional18or17
- sizeoptionalc6gd.largeorc6gd.xlargeorc6gd.2xlargeorc6gd.4xlargeorc6gd.8xlargeorc6gd.16xlarge+137 more
  The VM size for a Postgres service.
- haTypeoptionalnoneorasyncorsync
  Type of high availability: “none” for no replication, “async” for asynchronous replication to a single standby, and “sync” for synchronous replication to two standbys.
- tagsoptionalarray ofobject
  Tags associated with the Postgres service. Tag keys starting with “chc_” are reserved for internal use.
  
  2 properties
  keystringrequired
  Tag key. Must be alphanumeric with dashes, underscores and dots.
  
  maxLength: 128, minLength: 1, pattern: ^[a-zA-Z0-9._-]+$
  valueoptionalstring
  Tag value. Must be alphanumeric with dashes, underscores and dots.
  
  maxLength: 256, pattern: ^[a-zA-Z0-9._-]+$
- idoptionalstring
  format: uuid
  Example: "f71df78e-ddad-82d0-8dfa-abbec741b82e"
- stateoptionalcreatingorrestartingorrunningorreplaying_walorrestoring_backuporfinalizing_restore+3 more
  Current state of the service
- createdAtoptionalstring
  format: date-time
  Example: "2026-03-26T20:51:16.384Z"
- isPrimaryoptionalboolean
  True if this service is the primary service in the data warehouse
  
  Default: false

List of organization Postgres services

curl --request GET \
  --url https://api.clickhouse.cloud/v1/organizations/497f6eca-6276-4993-bfeb-53cbbbba6f08/postgres \
  --header 'Authorization: Basic <token>'

const url = 'https://api.clickhouse.cloud/v1/organizations/497f6eca-6276-4993-bfeb-53cbbbba6f08/postgres';
const options = {method: 'GET', headers: {Authorization: 'Basic <token>'}};

fetch(url, options)
  .then(res => res.json())
  .then(json => console.log(json))
  .catch(err => console.error(err));

import requests

url = "https://api.clickhouse.cloud/v1/organizations/497f6eca-6276-4993-bfeb-53cbbbba6f08/postgres"

headers = {"Authorization": "Basic <token>"}

response = requests.get(url, headers=headers)

print(response.text)

Response example

{
  "status": 200,
  "requestId": "d385ab22-0f51-4b97-9ecd-b8ff3fd4fcb6",
  "result": [
    {
      "name": "string",
      "provider": "aws",
      "region": "string",
      "postgresVersion": "18",
      "size": "c6gd.large",
      "haType": "none",
      "tags": [
        {
          "key": "Environment",
          "value": "staging"
        }
      ],
      "id": "f71df78e-ddad-82d0-8dfa-abbec741b82e",
      "state": "creating",
      "createdAt": "2026-03-26T20:51:16.384Z",
      "isPrimary": false
    }
  ]
}

{
  "status": 400,
  "error": "string",
  "requestId": "d385ab22-0f51-4b97-9ecd-b8ff3fd4fcb6"
}

{
  "status": 500,
  "error": "string",
  "requestId": "d385ab22-0f51-4b97-9ecd-b8ff3fd4fcb6"
}