Skip to main content
GET
Get BYOC infrastructure private endpoint configuration
Beta This endpoint is in beta. API contract is stable, and no breaking changes are expected in the future.

Returns the private link endpoint service details of a BYOC infrastructure. For BYOC organizations this replaces the deprecated organization-level privateEndpointConfig endpoint.

Permission

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

Authorizations

Authorization
string
header
required

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

Path Parameters

organizationId
string<uuid>
required

ID of the requested organization.

byocInfrastructureId
string<uuid>
required

ID of the requested BYOC Infrastructure

Response

Successful response

status
number

HTTP status code.

Example:

200

requestId
string<uuid>

Unique id assigned to every request. UUIDv4

result
object
Last modified on October 3, 2026