Create a private endpoint

Create a new private endpoint. The private endpoint will be associated with this service and organization

POST /v1/organizations/{organizationId}/services/{serviceId}/privateEndpoint

Create a private endpoint

cURL

curl --request POST \
  --url https://api.clickhouse.cloud/v1/organizations/{organizationId}/services/{serviceId}/privateEndpoint \
  --header 'Authorization: Basic <encoded-value>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "id": "<string>",
  "description": "<string>"
}
'

200

{
  "status": 200,
  "requestId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "result": {
    "id": "<string>",
    "description": "<string>",
    "cloudProvider": "gcp",
    "region": "ap-northeast-1"
  }
}

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.

serviceId · string<uuid> · required

ID of the requested service.

Body

application/json

id · string

Private endpoint identifier

description · string

Description of private endpoint

Response

200

application/json

Successful response

status · number

HTTP status code.

Example:

200

requestId · string<uuid>

Unique id assigned to every request. UUIDv4

result · object

Show child attributes