Skip to content
ClickHouse Docs
ClickHouse DocsClickHouse Docs
49.6kGet Started

Update Postgres service state

Beta
View as MarkdownEdit this pageReport an issueSet up docs MCP
PATCH/v1/organizations/{organizationId}/postgres/{postgresId}/state

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

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

Authorizations

Path parameters

  • organizationIdstringrequired

    ID of the organization that owns the Postgres service.

    format: uuid
  • postgresIdstringrequired

    ID of the requested Postgres service.

    format: uuid

Request bodyJSON

  • commandoptionalrestartorpromoteorswitchover

    Postgres status, which initiates a process.

Response

JSON

200

Successful response

JSON
  • statusoptionalnumber

    HTTP status code.

    Example: 200
  • requestIdoptionalstring

    Unique id assigned to every request. UUIDv4

    format: uuid
  • resultoptionalobject
    16 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"
    • storageSizeoptionalinteger

      The storage size, in GiB, which must be supported by the specified size.

    • 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
    • connectionStringoptionalstring

      Connection string to the Postgres service. Embeds the service password, so it is only returned when the service is created or its password is reset. Omitted from every other response when Postgres credential redaction is enabled for the organization. Not guaranteed to be present — treat as optional.

    • usernameoptionalstring

      Username for the Postgres service

    • passwordoptionalstring

      Password for the Postgres service. Only returned when the service is created or its password is reset. Omitted from every other response when Postgres credential redaction is enabled for the organization. Not guaranteed to be present — treat as optional.

    • hostnameoptionalstring

      Hostname for the Postgres service

Navigation