Update BYOC Infrastructure | ClickHouse Docs

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

Update configuration of the BYOC infrastructure. Returns the modified infrastructure

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

Response

JSON

200

Successful response

JSON

statusoptionalnumber
HTTP status code.

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

format: uuid
resultoptionalobject
6 properties
- idoptionalstring
  Unique identifier of the BYOC configuration
- stateoptionalinfra-readyorinfra-provisioningorinfra-terminated
  State of the infrastructure
- accountNameoptionalstring
  Name of the account
- 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"
}
'

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'})
};

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" }
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",
    "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"
}