ClickHouse Cloud: Clickhouse Click Pipe Reverse Private Endpoint Create

Create a reverse private endpoint so ClickPipes on a ClickHouse service can reach a source in your private network.

Tool ID: clickhouse_click_pipe_reverse_private_endpoint_create

Run this action

Use the TypeScript SDK for one call. Use ctx.tools.execute(...) inside a Play for durable calls, scheduled calls, or CSV processing.

import { Deepline } from 'deepline';

const deepline = await Deepline.connect();
const result = await deepline.tools.execute(
  'clickhouse_click_pipe_reverse_private_endpoint_create',
  {
    "organizationId": "123e4567-e89b-42d3-a456-426614174000",
    "serviceId": "123e4567-e89b-42d3-a456-426614174000"
  },
);

console.log(result.toolResponse.raw);

CLI

deepline tools execute clickhouse_click_pipe_reverse_private_endpoint_create --input '{
  "organizationId": "123e4567-e89b-42d3-a456-426614174000",
  "serviceId": "123e4567-e89b-42d3-a456-426614174000"
}' --json

Example response

The SDK returns this shape at result.toolResponse.raw. The example values illustrate the response.

{
  "data": {
    "status": 123,
    "requestId": "123e4567-e89b-42d3-a456-426614174000",
    "result": {
      "description": "Example description",
      "type": "VPC_ENDPOINT_SERVICE",
      "vpcEndpointServiceName": "Example"
    }
  }
}

Use deepline describe clickhouse_click_pipe_reverse_private_endpoint_create --json for the latest machine-readable contract.

Input reference

Create a new reverse private endpoint.

Name	Type	Required	Default	Details
`payload.organizationId`	`string`	Yes	—	ID of the organization that owns the service. Format: `uuid`.
`payload.serviceId`	`string`	Yes	—	ID of the service that owns the Reverse Private Endpoint. Format: `uuid`.
`payload.description`	`string`	No	—	Reverse private endpoint description. Maximum length is 255 characters.
`payload.type`	`"VPC_ENDPOINT_SERVICE" \| "VPC_RESOURCE" \| "MSK_MULTI_VPC" \| "GCP_PSC_SERVICE_ATTACHMENT"`	No	—	Reverse private endpoint type. Allowed: `VPC_ENDPOINT_SERVICE`, `VPC_RESOURCE`, `MSK_MULTI_VPC`, `GCP_PSC_SERVICE_ATTACHMENT`.
`payload.vpcEndpointServiceName`	`string`	No	—	VPC endpoint service name.
`payload.vpcResourceConfigurationId`	`string`	No	—	VPC resource configuration ID. Required for VPC_RESOURCE type.
`payload.vpcResourceShareArn`	`string`	No	—	VPC resource share ARN. Required for VPC_RESOURCE type.
`payload.mskClusterArn`	`string`	No	—	MSK cluster ARN. Required for MSK_MULTI_VPC type.
`payload.mskAuthentication`	`"SASL_IAM" \| "SASL_SCRAM"`	No	—	MSK cluster authentication type. Required for MSK_MULTI_VPC type. Allowed: `SASL_IAM`, `SASL_SCRAM`.
`payload.gcpServiceAttachment`	`string`	No	—	Private Preview. GCP PSC service attachment URI. Required for GCP_PSC_SERVICE_ATTACHMENT type. Format: projects/{project}/regions/{region}/serviceAttachments/{name}.
`payload.customPrivateDnsMappings`	`array`	No	—	Optional private DNS names for Reverse Private Endpoint. Can be used as data source destination address. Must be unique across the ClickHouse service. Generally available for Google Private Service Connect (PSC). For AWS PrivateLink (VPC endpoint service and VPC resource), available in Private Preview. contact ClickHouse support to enable it for your service. Not supported for MSK multi-VPC. Supports exact names and leading wildcard names such as *.example.com

Output reference

Standard tool result payload.

Name	Type	Required	Default	Details
`result.data`	`object`	Yes	—	Provider response payload.
`result.data.status`	`number`	No	—	HTTP status code.
`result.data.requestId`	`string`	No	—	Unique id assigned to every request. UUIDv4 Format: `uuid`.
`result.data.result`	`object`	No	—	—
`result.data.result.description`	`string`	No	—	Reverse private endpoint description. Maximum length is 255 characters.
`result.data.result.type`	`"VPC_ENDPOINT_SERVICE" \| "VPC_RESOURCE" \| "MSK_MULTI_VPC" \| "GCP_PSC_SERVICE_ATTACHMENT"`	No	—	Reverse private endpoint type. Allowed: `VPC_ENDPOINT_SERVICE`, `VPC_RESOURCE`, `MSK_MULTI_VPC`, `GCP_PSC_SERVICE_ATTACHMENT`.
`result.data.result.vpcEndpointServiceName`	`string \| null`	No	—	VPC endpoint service name.
`result.data.result.vpcResourceConfigurationId`	`string \| null`	No	—	VPC resource configuration ID. Required for VPC_RESOURCE type.
`result.data.result.vpcResourceShareArn`	`string \| null`	No	—	VPC resource share ARN. Required for VPC_RESOURCE type.
`result.data.result.mskClusterArn`	`string \| null`	No	—	MSK cluster ARN. Required for MSK_MULTI_VPC type.
`result.data.result.mskAuthentication`	`"SASL_IAM" \| "SASL_SCRAM"`	No	—	MSK cluster authentication type. Required for MSK_MULTI_VPC type. Allowed: `SASL_IAM`, `SASL_SCRAM`.
`result.data.result.gcpServiceAttachment`	`string \| null`	No	—	Private Preview. GCP PSC service attachment URI. Required for GCP_PSC_SERVICE_ATTACHMENT type. Format: projects/{project}/regions/{region}/serviceAttachments/{name}.
`result.data.result.customPrivateDnsMappings`	`array`	No	—	Optional private DNS names for Reverse Private Endpoint. Can be used as data source destination address. Must be unique across the ClickHouse service. Generally available for Google Private Service Connect (PSC). For AWS PrivateLink (VPC endpoint service and VPC resource), available in Private Preview. contact ClickHouse support to enable it for your service. Not supported for MSK multi-VPC. Supports exact names and leading wildcard names such as *.example.com
`result.data.result.customPrivateDnsMappings[].privateDnsName`	`string`	No	—	Optional private DNS names for Reverse Private Endpoint. Can be used as data source destination address. Must be unique across the ClickHouse service. Generally available for Google Private Service Connect (PSC). For AWS PrivateLink (VPC endpoint service and VPC resource), available in Private Preview. contact ClickHouse support to enable it for your service. Not supported for MSK multi-VPC. Supports exact names and leading wildcard names such as *.example.com
`result.data.result.id`	`string`	No	—	Reverse private endpoint ID. Format: `uuid`.
`result.data.result.serviceId`	`string`	No	—	ClickHouse service ID reverse private endpoint is associated with. Format: `uuid`.
`result.data.result.endpointId`	`string`	No	—	Reverse private endpoint endpoint ID.
`result.data.result.dnsNames`	`array`	No	—	Reverse private endpoint internal DNS names.
`result.data.result.privateDnsNames`	`array`	No	—	Reverse private endpoint private DNS names.
`result.data.result.status`	`"Unknown" \| "Provisioning" \| "Deleting" \| "Ready" \| "Failed" \| "PendingAcceptance" \| "Rejected" \| "Expired"`	No	—	Reverse private endpoint status. Allowed: `Unknown`, `Provisioning`, `Deleting`, `Ready`, `Failed`, `PendingAcceptance`, `Rejected`, `Expired`.
`result.meta`	`object`	No	—	Additional response metadata (status, paging).

Deepline cost

Pricing model: fixed (per call).
Estimated Deepline credits: 0 per pricing unit.
Provider-native pricing may still exist outside Deepline credit billing.

​Run this action

​CLI

​Example response

​Input reference

​Output reference

​Deepline cost

​Related documentation

Run this action

CLI

Example response

Input reference

Output reference

Deepline cost

Related documentation