Skip to content
ClickHouse Docs
ClickHouse DocsClickHouse Docs

Get BYOC infrastructure private endpoint configuration

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

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

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
    2 properties
    • endpointNamestringrequired

      Cloud-provider identifier of the private link endpoint service of the infrastructure: VPC endpoint service name on AWS, Private Service Connect service attachment on GCP, or Private Link service on Azure

    • privateDnsHostnamestringrequired

      Private DNS hostname under which services of the infrastructure are reachable over private link