Organization

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

patch/v1/organizations/{organizationId}/byocInfrastructure/{byocInfrastructureId}

Request

  • Base URL: https://api.clickhouse.cloud
  • URL: https://api.clickhouse.cloud/v1/organizations/{organizationId}/byocInfrastructure/{byocInfrastructureId}
  • Auth: HTTP basic

Path parameters

organizationIdstring uuid required

ID of the requested organization.

byocInfrastructureIdstring uuid required

ID of the requested BYOC Infrastructure

Request body

displayNamestring

Human readable name for infrastructure object

enablePrivateLinkboolean

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

gcpPscSubnetIdstring

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

enablePrivateLoadBalancerboolean

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

enablePublicLoadBalancerboolean

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

tagsByocInfrastructureTags

Response

Successful response

statusnumber

HTTP status code.

requestIdstring uuid

Unique id assigned to every request. UUIDv4

Example response

{
  "status": 200,
  "result": {
    "state": "infra-ready",
    "accountId": "123456789012"
  }
}

Changes

No recorded changes to this operation across all 1 revision of this API.