Create BYOC Infrastructure

Create a new BYOC Infrastructure in the organization. Returns the configuration of the newly created infrastructure

POST /v1/organizations/{organizationId}/byocInfrastructure

Create BYOC Infrastructure

cURL

curl --request POST \
  --url https://api.clickhouse.cloud/v1/organizations/{organizationId}/byocInfrastructure \
  --header 'Authorization: Basic <encoded-value>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "accountId": "123456789012",
  "availabilityZoneSuffixes": [],
  "vpcCidrRange": "10.0.0.0/16",
  "externalId": "ch-0a1b2c3d4e5f6789",
  "tenantId": "<string>",
  "servicePrincipalClientId": "<string>",
  "vpcId": "vpc-0abc1234def567890",
  "privateSubnetIds": [
    "<string>"
  ],
  "publicSubnetIds": [
    "<string>"
  ],
  "gcpPodCidrRangeNames": [
    "<string>"
  ],
  "gcpSharedVpcHostProjectId": "<string>",
  "tags": {},
  "displayName": "<string>"
}
'

200

{
  "status": 200,
  "requestId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "result": {
    "id": "<string>",
    "state": "infra-ready",
    "accountId": "123456789012",
    "accountName": "<string>",
    "regionId": "ap-northeast-1",
    "cloudProvider": "gcp",
    "displayName": "<string>"
  }
}

Create a new BYOC Infrastructure in the organization. Returns the configuration of the newly created infrastructure

​

Permission

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

인증

Authorization · string · header · 필수

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

경로 매개변수

organizationId · string<uuid> · 필수

ID of the requested organization.

본문

application/json

regionId · enum<string> · 필수

Region in which the BYOC infrastructure will be located

사용 가능한 옵션: ap-northeast-1, ap-northeast-2, ap-south-1, ap-southeast-1, ap-southeast-2, ca-central-1, eu-central-1, eu-west-1, eu-west-2, il-central-1, us-east-1, us-east-2, us-west-2, us-east1, us-central1, europe-west2, europe-west4, asia-southeast1, asia-northeast1, eastus, eastus2, westus3, germanywestcentral, centralus

accountId · string · 필수

Cloud account ID the BYOC infrastructure is configured for: AWS account ID, GCP project ID, or Azure subscription ID

예시:

"123456789012"

availabilityZoneSuffixes · enum<string>[]

List of availability zone suffixes

사용 가능한 옵션: a, b, c, d, e, f

vpcCidrRange · string

CIDR range for the ClickHouse-managed VPC. Mutually exclusive with the BYO-VPC fields (vpcId, privateSubnetIds, publicSubnetIds)

예시:

"10.0.0.0/16"

externalId · string

AWS only: ExternalID baked into the ClickHouse management role trust policy in your account

예시:

"ch-0a1b2c3d4e5f6789"

tenantId · string

Azure only (required for Azure regions): Entra tenant ID of the subscription

servicePrincipalClientId · string

Azure only (required for Azure regions): client ID of the service principal ClickHouse uses to manage the infrastructure

vpcId · string

BYO-VPC only (AWS and GCP): ID or network name of the customer-provided VPC to deploy into. Requires privateSubnetIds

예시:

"vpc-0abc1234def567890"

privateSubnetIds · string[]

BYO-VPC only: private subnet IDs or names (1-6 entries on AWS, exactly one on GCP)

publicSubnetIds · string[]

AWS BYO-VPC only: public subnet IDs (at most 6 entries)

gcpPodCidrRangeNames · string[]

GCP BYO-VPC only: secondary IP range names on the subnet to use for pod IPs. Omitted: all secondary ranges are used

gcpSharedVpcHostProjectId · string

GCP BYO-VPC only: Shared VPC host project owning the VPC and subnet, when different from accountId

tags · object

Show child attributes

displayName · string

Human readable name for infrastructure

응답

200

application/json

Successful response

status · number

HTTP status code.

예시:

200

requestId · string<uuid>

Unique id assigned to every request. UUIDv4

result · object

Show child attributes