Skip to main content
GET
/
v1
/
organizations
/
{organizationId}
/
privateEndpointConfig
Get private endpoint configuration for region within cloud provider for an organization
curl --request GET \
  --url https://api.clickhouse.cloud/v1/organizations/{organizationId}/privateEndpointConfig \
  --header 'Authorization: Basic <encoded-value>'
{
  "status": 200,
  "requestId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "result": {
    "endpointServiceId": "<string>"
  }
}

Documentation Index

Fetch the complete documentation index at: https://private-7c7dfe99-pg-auto-scale.mintlify.app/llms.txt

Use this file to discover all available pages before exploring further.

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.

Query Parameters

​
cloud_provider
string
required

Cloud provider identifier. One of aws, gcp, or azure.

​
region_id
string
required

Region identifier within specific cloud providers.

Response

Successful response

​
status
number

HTTP status code.

Example:

200

​
requestId
string<uuid>

Unique id assigned to every request. UUIDv4

​
result
object