Update BYOC Infrastructure | ClickHouse Docs

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

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.

Authorizations

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

Path parameters

organizationIdstringrequired
ID of the requested organization.

format: uuid
byocInfrastructureIdstringrequired
ID of the requested BYOC Infrastructure

format: uuid

Request bodyJSON

displayNameoptionalstring
Human readable name for infrastructure object
enablePrivateLinkoptionalboolean
Enable or disable private link connectivity on the infrastructure. Disabling is rejected while any service in the organization has active private endpoints
gcpPscSubnetIdoptionalstring
GCP BYO-VPC only: customer-provided Private Service Connect NAT subnet name required to enable private link. Only accepted together with enablePrivateLink: true
enablePrivateLoadBalanceroptionalboolean
Enable or disable the private (internal) load balancer of the infrastructure
enablePublicLoadBalanceroptionalboolean
Enable or disable the public (internet-facing) load balancer of the infrastructure
tagsoptionalmap ofstring

Response

JSON

200

Successful response

JSON

statusoptionalnumber
HTTP status code.

Example: 200
requestIdoptionalstring
Unique id assigned to every request. UUIDv4

format: uuid
resultoptionalobject
7 properties
- idoptionalstring
  Unique identifier of the BYOC configuration
- stateoptionalinfra-provisioningorinfra-terminatedorinfra-terminatingorinfra-readyorinfra-degradedorinfra-upgrading
  State of the infrastructure
  
  Example: "infra-ready"
- accountIdoptionalstring
  Cloud account ID the BYOC infrastructure is bound to: AWS account ID, GCP project ID, or Azure subscription ID
  
  Example: "123456789012"
- accountNamedeprecatedstring
  DEPRECATED. Use accountId instead. Cloud account ID the BYOC infrastructure is bound to
- regionIdoptionalap-northeast-1orap-northeast-2orap-south-1orap-southeast-1orap-southeast-2orca-central-1+18 more
  Region for which the BYOC has been configured and where it is possible to create services
- cloudProvideroptionalgcporawsorazure
  Cloud provider of the region
- displayNameoptionalstring
  Human readable name for infrastructure

Update BYOC Infrastructure

curl --request PATCH \
  --url https://api.clickhouse.cloud/v1/organizations/497f6eca-6276-4993-bfeb-53cbbbba6f08/byocInfrastructure/497f6eca-6276-4993-bfeb-53cbbbba6f08 \
  --header 'Authorization: Basic <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "displayName": "string",
  "enablePrivateLink": true,
  "gcpPscSubnetId": "string",
  "enablePrivateLoadBalancer": true,
  "enablePublicLoadBalancer": true,
  "tags": {
    "property1": "string",
    "property2": "string"
  }
}
'

const url = 'https://api.clickhouse.cloud/v1/organizations/497f6eca-6276-4993-bfeb-53cbbbba6f08/byocInfrastructure/497f6eca-6276-4993-bfeb-53cbbbba6f08';
const options = {
  method: 'PATCH',
  headers: {'Content-Type': 'application/json', Authorization: 'Basic <token>'},
  body: JSON.stringify({
    displayName: 'string',
    enablePrivateLink: true,
    gcpPscSubnetId: 'string',
    enablePrivateLoadBalancer: true,
    enablePublicLoadBalancer: true,
    tags: {property1: 'string', property2: 'string'}
  })
};

fetch(url, options)
  .then(res => res.json())
  .then(json => console.log(json))
  .catch(err => console.error(err));

import requests

url = "https://api.clickhouse.cloud/v1/organizations/497f6eca-6276-4993-bfeb-53cbbbba6f08/byocInfrastructure/497f6eca-6276-4993-bfeb-53cbbbba6f08"

payload = {
    "displayName": "string",
    "enablePrivateLink": True,
    "gcpPscSubnetId": "string",
    "enablePrivateLoadBalancer": True,
    "enablePublicLoadBalancer": True,
    "tags": {
        "property1": "string",
        "property2": "string"
    }
}
headers = {
    "Content-Type": "application/json",
    "Authorization": "Basic <token>"
}

response = requests.patch(url, json=payload, headers=headers)

print(response.text)

Response example

{
  "status": 200,
  "requestId": "d385ab22-0f51-4b97-9ecd-b8ff3fd4fcb6",
  "result": {
    "id": "string",
    "state": "infra-ready",
    "accountId": "123456789012",
    "accountName": "string",
    "regionId": "ap-northeast-1",
    "cloudProvider": "gcp",
    "displayName": "string"
  }
}

{
  "status": 400,
  "error": "string",
  "requestId": "d385ab22-0f51-4b97-9ecd-b8ff3fd4fcb6"
}

{
  "status": 500,
  "error": "string",
  "requestId": "d385ab22-0f51-4b97-9ecd-b8ff3fd4fcb6"
}