Postgres

Update Postgres service state

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

  • restart: Initiates a service restart
  • promote: Promotes a read replica to primary
  • switchover: Switch a primary over to a standby
patch/v1/organizations/{organizationId}/postgres/{postgresId}/state

Request

  • Base URL: https://api.clickhouse.cloud
  • URL: https://api.clickhouse.cloud/v1/organizations/{organizationId}/postgres/{postgresId}/state
  • 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

command'restart' | 'promote' | 'switchover'

Postgres status, which initiates a process.

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.