Create reverse private endpoint

This endpoint is in beta. API contract is stable, and no breaking changes are expected in the future.

Create a new reverse private endpoint.

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

Create reverse private endpoint

cURL

curl --request POST \
  --url https://api.clickhouse.cloud/v1/organizations/{organizationId}/services/{serviceId}/clickpipesReversePrivateEndpoints \
  --header 'Authorization: Basic <encoded-value>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "description": "My reverse private endpoint",
  "type": "VPC_ENDPOINT_SERVICE",
  "vpcEndpointServiceName": "com.amazonaws.vpce.us-east-1.vpce-svc-12345678901234567",
  "vpcResourceConfigurationId": "rcfg-12345678901234567",
  "vpcResourceShareArn": "arn:aws:ram:us-east-1:123456789012:resource-share/share-12345678901234567",
  "mskClusterArn": "arn:aws:kafka:us-east-1:123456789012:cluster/my-cluster",
  "mskAuthentication": "SASL_IAM"
}
'

200

{
  "status": 200,
  "requestId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "result": {
    "description": "My reverse private endpoint",
    "type": "VPC_ENDPOINT_SERVICE",
    "vpcEndpointServiceName": "com.amazonaws.vpce.us-east-1.vpce-svc-12345678901234567",
    "vpcResourceConfigurationId": "rcfg-12345678901234567",
    "vpcResourceShareArn": "arn:aws:ram:us-east-1:123456789012:resource-share/share-12345678901234567",
    "mskClusterArn": "arn:aws:kafka:us-east-1:123456789012:cluster/my-cluster",
    "mskAuthentication": "SASL_IAM",
    "id": "12345678-1234-1234-1234-123456789012",
    "serviceId": "12345678-1234-1234-1234-123456789012",
    "endpointId": "vpce-12345678901234567",
    "dnsNames": [
      "<string>"
    ],
    "privateDnsNames": [
      "<string>"
    ],
    "status": "Ready"
  }
}

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 organization that owns the service.

serviceId · string<uuid> · required

ID of the service that owns the Reverse Private Endpoint.

Body

application/json

description · string

Reverse private endpoint description. Maximum length is 255 characters.

Example:

"My reverse private endpoint"

type · enum<string>

Reverse private endpoint type.

Available options: VPC_ENDPOINT_SERVICE, VPC_RESOURCE, MSK_MULTI_VPC

Example:

"VPC_ENDPOINT_SERVICE"

vpcEndpointServiceName · string | null

VPC endpoint service name.

Example:

"com.amazonaws.vpce.us-east-1.vpce-svc-12345678901234567"

vpcResourceConfigurationId · string | null

VPC resource configuration ID. Required for VPC_RESOURCE type.

Example:

"rcfg-12345678901234567"

vpcResourceShareArn · string | null

VPC resource share ARN. Required for VPC_RESOURCE type.

Example:

"arn:aws:ram:us-east-1:123456789012:resource-share/share-12345678901234567"

mskClusterArn · string | null

MSK cluster ARN. Required for MSK_MULTI_VPC type.

Example:

"arn:aws:kafka:us-east-1:123456789012:cluster/my-cluster"

mskAuthentication · enum<string> | null

MSK cluster authentication type. Required for MSK_MULTI_VPC type.

Available options: SASL_IAM, SASL_SCRAM

Example:

"SASL_IAM"

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