> ## Documentation Index > Fetch the complete documentation index at: https://clickhouse.com/docs/llms.txt > Use this file to discover all available pages before exploring further. # Get BYOC infrastructure details > **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. Beta **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.
## OpenAPI ````yaml _specs/cloud-openapi.json GET /v1/organizations/{organizationId}/byocInfrastructure/{byocInfrastructureId} openapi: 3.1.1 info: title: OpenAPI spec for ClickHouse Cloud version: '1.0' contact: name: ClickHouse Support url: >- https://clickhouse.com/docs/en/cloud/manage/openapi?referrer=openapi-1173305 email: support@clickhouse.com servers: - url: https://api.clickhouse.cloud security: - basicAuth: [] tags: - name: Organization - name: User management - name: Billing - name: Role Management - name: Service - name: Backup - name: Snapshot - name: API keys - name: Prometheus - name: ClickPipes - name: ClickStack - name: Postgres - name: UDF - name: Query API endpoints paths: /v1/organizations/{organizationId}/byocInfrastructure/{byocInfrastructureId}: get: tags: - Organization summary: Get BYOC infrastructure details description: >- **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. operationId: organizationByocInfrastructureGet parameters: - in: path name: organizationId description: ID of the requested organization. required: true schema: type: string format: uuid - in: path name: byocInfrastructureId description: ID of the requested BYOC Infrastructure required: true schema: type: string format: uuid responses: '200': description: Successful response content: application/json: schema: type: object properties: status: type: number description: HTTP status code. example: 200 requestId: type: string description: Unique id assigned to every request. UUIDv4 format: uuid result: $ref: '#/components/schemas/ByocInfrastructureDetails' '400': description: >- The request cannot be processed due to a client error. Please verify your request parameters and try again. content: application/json: schema: type: object properties: status: type: number description: HTTP status code. example: 400 error: type: string description: Detailed error description. requestId: type: string description: Unique id assigned to every request. UUIDv4 format: uuid '500': description: >- An internal server error has occurred. If this issue persists, please contact ClickHouse Cloud support for assistance. content: application/json: schema: type: object properties: status: type: integer description: HTTP status code. example: 500 error: type: string description: Detailed error description. requestId: type: string description: Unique id assigned to every request. UUIDv4 format: uuid components: schemas: ByocInfrastructureDetails: properties: id: description: Unique identifier of the BYOC infrastructure type: string state: description: State of the infrastructure type: string enum: - infra-provisioning - infra-terminated - infra-terminating - infra-ready - infra-degraded - infra-upgrading example: infra-ready accountId: description: >- Cloud account ID the BYOC infrastructure is bound to: AWS account ID, GCP project ID, or Azure subscription ID type: string example: '123456789012' regionId: description: Region the BYOC infrastructure is located in type: string enum: - 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 cloudProvider: description: Cloud provider of the region type: string enum: - gcp - aws - azure displayName: description: Human readable name for infrastructure type: string enablePrivateLink: description: Whether private link connectivity is enabled on the infrastructure type: boolean enablePrivateLoadBalancer: description: Whether the private load balancer is enabled on the infrastructure type: boolean enablePublicLoadBalancer: description: Whether the public load balancer is enabled on the infrastructure type: boolean vpcCidrRange: description: >- CIDR range of the ClickHouse-managed VPC. Absent for BYO-VPC infrastructures type: string example: 10.0.0.0/16 vpcAvailabilityZoneList: type: array description: Availability zones the infrastructure spans items: type: string example: - us-east-1a - us-east-1b - us-east-1c isByoVpc: description: >- True when the infrastructure runs in a customer-provided VPC (BYO-VPC) instead of a ClickHouse-managed one type: boolean byoVpcId: description: Customer VPC ID or network name (BYO-VPC only) type: string example: vpc-0abc1234def567890 byoVpcPrivateSubnetIds: type: array description: >- Customer private subnet IDs or names (BYO-VPC only; exactly one entry on GCP) items: type: string byoVpcPodCidrRangeNames: type: array description: >- Secondary IP range names pinned for pod IPs (GCP BYO-VPC only). Absent when all secondary ranges are used items: type: string byoVpcSharedVpcHostProjectId: description: >- Shared VPC host project owning the VPC and subnet (GCP BYO-VPC only). Absent when the VPC lives in the service project type: string gcpPscSubnetId: description: >- Customer-provided Private Service Connect NAT subnet name configured for private link (GCP BYO-VPC only) type: string securitySchemes: basicAuth: type: http scheme: basic description: >- Use key ID and key secret obtained in ClickHouse Cloud console: https://clickhouse.com/docs/cloud/manage/openapi x-permission-scopes: >- The scope list of a `security` requirement holds ClickHouse Cloud API key permission ids (for example `control-plane:organization:view`), not OAuth scopes. OpenAPI has no field for API key permissions, so this is the closest available place. A key must hold every permission listed on an operation to call it; an operation with no scopes needs none beyond a valid key. Every operation declares at most one requirement object, always for this scheme, so the list is only ever conjunctive — alternative sets of permissions are never expressed. ````