Get private endpoint configuration for region within cloud provider for an organization

GET/v1/organizations/{organizationId}/privateEndpointConfig

Deprecated. Please follow documentation for the updated process.

Authorizations

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

Path parameters

organizationIdstringrequired
ID of the requested organization.

format: uuid

Query parameters

cloud_providerstringrequired
Cloud provider identifier. One of aws, gcp, or azure.
region_idstringrequired
Region identifier within specific cloud providers.

Response

JSON

200

Successful response

JSON

statusoptionalnumber
HTTP status code.

Example: 200
requestIdoptionalstring
Unique id assigned to every request. UUIDv4

format: uuid
resultoptionalobject
1 properties
- endpointServiceIdoptionalstring
  Unique identifier of the interface endpoint you created in your VPC with the AWS(Service Name) or GCP(Target Service) resource

Get private endpoint configuration for region within cloud provider for an organization

curl --request GET \
  --url 'https://api.clickhouse.cloud/v1/organizations/497f6eca-6276-4993-bfeb-53cbbbba6f08/privateEndpointConfig?cloud_provider=string&region_id=string' \
  --header 'Authorization: Basic <token>'

const url = 'https://api.clickhouse.cloud/v1/organizations/497f6eca-6276-4993-bfeb-53cbbbba6f08/privateEndpointConfig?cloud_provider=string&region_id=string';
const options = {method: 'GET', headers: {Authorization: 'Basic <token>'}};

fetch(url, options)
  .then(res => res.json())
  .then(json => console.log(json))
  .catch(err => console.error(err));

import requests

url = "https://api.clickhouse.cloud/v1/organizations/497f6eca-6276-4993-bfeb-53cbbbba6f08/privateEndpointConfig?cloud_provider=string&region_id=string"

headers = {"Authorization": "Basic <token>"}

response = requests.get(url, headers=headers)

print(response.text)

Response example

{
  "status": 200,
  "requestId": "d385ab22-0f51-4b97-9ecd-b8ff3fd4fcb6",
  "result": {
    "endpointServiceId": "string"
  }
}

{
  "status": 400,
  "error": "string",
  "requestId": "d385ab22-0f51-4b97-9ecd-b8ff3fd4fcb6"
}

{
  "status": 500,
  "error": "string",
  "requestId": "d385ab22-0f51-4b97-9ecd-b8ff3fd4fcb6"
}