Skip to main content
PATCH
Update BYOC Infrastructure
Update configuration of the BYOC infrastructure: rename it, toggle private link and load balancers, or replace its tags. The request is validated as a whole before anything is applied. If applying a field then fails in the data plane, client errors name the fields already applied, while internal errors return a generic message; retrying the same request is safe either way and converges the infrastructure to the requested state. Returns the modified infrastructure

Permission

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

Autorizações

Authorization
string
header
obrigatório

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

Parâmetros de caminho

organizationId
string<uuid>
obrigatório

ID of the requested organization.

byocInfrastructureId
string<uuid>
obrigatório

ID of the requested BYOC Infrastructure

Corpo

application/json
displayName
string

Human readable name for infrastructure object

Enable or disable private link connectivity on the infrastructure. Disabling is rejected while any service in the organization has active private endpoints

gcpPscSubnetId
string

GCP BYO-VPC only: customer-provided Private Service Connect NAT subnet name required to enable private link. Only accepted together with enablePrivateLink: true

enablePrivateLoadBalancer
boolean

Enable or disable the private (internal) load balancer of the infrastructure

enablePublicLoadBalancer
boolean

Enable or disable the public (internet-facing) load balancer of the infrastructure

tags
object

Resposta

Successful response

status
number

HTTP status code.

Exemplo:

200

requestId
string<uuid>

Unique id assigned to every request. UUIDv4

result
object
Última modificação em 7 de outubro de 2026