Skip to content
ClickHouse Docs
ClickHouse DocsClickHouse Docs

Get BYOC infrastructure details

GET/v1/organizations/{organizationId}/byocInfrastructure/{byocInfrastructureId}
API playground

This endpoint is in beta. API contract is stable, and no breaking changes are expected in the future.

Returns the full configuration of a BYOC infrastructure, including private link and load balancer state, network layout, and BYO-VPC settings read from the data plane.

Permission

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

Authorizations

Path parameters

  • organizationIdstringrequired

    ID of the requested organization.

    format: uuid
  • byocInfrastructureIdstringrequired

    ID of the requested BYOC Infrastructure

    format: uuid

Response

JSON

200

Successful response

JSON
  • statusoptionalnumber

    HTTP status code.

    Example: 200
  • requestIdoptionalstring

    Unique id assigned to every request. UUIDv4

    format: uuid
  • resultoptionalobject
    17 properties
    • idoptionalstring

      Unique identifier of the BYOC infrastructure

    • 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"
    • regionIdoptionalap-northeast-1orap-northeast-2orap-south-1orap-southeast-1orap-southeast-2orca-central-1+18 more

      Region the BYOC infrastructure is located in

    • cloudProvideroptionalgcporawsorazure

      Cloud provider of the region

    • displayNameoptionalstring

      Human readable name for infrastructure

    • enablePrivateLoadBalanceroptionalboolean

      Whether the private load balancer is enabled on the infrastructure

    • enablePublicLoadBalanceroptionalboolean

      Whether the public load balancer is enabled on the infrastructure

    • vpcCidrRangeoptionalstring

      CIDR range of the ClickHouse-managed VPC. Absent for BYO-VPC infrastructures

      Example: "10.0.0.0/16"
    • vpcAvailabilityZoneListoptionalarray ofstring

      Availability zones the infrastructure spans

      Example: ["us-east-1a","us-east-1b","us-east-1c"]
    • isByoVpcoptionalboolean

      True when the infrastructure runs in a customer-provided VPC (BYO-VPC) instead of a ClickHouse-managed one

    • byoVpcIdoptionalstring

      Customer VPC ID or network name (BYO-VPC only)

      Example: "vpc-0abc1234def567890"
    • byoVpcPrivateSubnetIdsoptionalarray ofstring

      Customer private subnet IDs or names (BYO-VPC only; exactly one entry on GCP)

    • byoVpcPodCidrRangeNamesoptionalarray ofstring

      Secondary IP range names pinned for pod IPs (GCP BYO-VPC only). Absent when all secondary ranges are used

    • byoVpcSharedVpcHostProjectIdoptionalstring

      Shared VPC host project owning the VPC and subnet (GCP BYO-VPC only). Absent when the VPC lives in the service project

    • gcpPscSubnetIdoptionalstring

      Customer-provided Private Service Connect NAT subnet name configured for private link (GCP BYO-VPC only)