Passer au contenu principal
PATCH
Update Postgres service state
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. If there is no standby, replace the primary with a newly provisioned server and switch over to it.

Permission

The API key must have the control-plane:postgres-service:manage permission.

Autorisations

Authorization
string
header
requis

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

Paramètres de chemin

organizationId
string<uuid>
requis

ID of the organization that owns the Postgres service.

postgresId
string<uuid>
requis

ID of the requested Postgres service.

Corps

application/json
command
enum<string>

Postgres status, which initiates a process.

Options disponibles:
restart,
promote,
switchover

Réponse

Successful response

status
number

HTTP status code.

Exemple:

200

requestId
string<uuid>

Unique id assigned to every request. UUIDv4

result
object