Organization

Get BYOC infrastructure details

This endpoint is in beta. API contract is stable, and no breaking changes are expected in the future. <br /><br /> 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.

get/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

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",
    "vpcCidrRange": "10.0.0.0/16",
    "vpcAvailabilityZoneList": [
      "us-east-1a",
      "us-east-1b",
      "us-east-1c"
    ],
    "byoVpcId": "vpc-0abc1234def567890"
  }
}

Changes

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