ClickHouse Cloud: Clickhouse Instance Private Endpoint Create

Add a private endpoint to a ClickHouse Cloud service and its organization.

Tool ID: clickhouse_instance_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_instance_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_instance_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": {
      "id": "id_123",
      "description": "Example description",
      "cloudProvider": "gcp"
    }
  }
}

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

Input reference

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

Name	Type	Required	Default	Details
`payload.organizationId`	`string`	Yes	—	ID of the requested organization. Format: `uuid`.
`payload.serviceId`	`string`	Yes	—	ID of the requested service. Format: `uuid`.
`payload.id`	`string`	No	—	Private endpoint identifier
`payload.description`	`string`	No	—	Description of private endpoint

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.id`	`string`	No	—	Private endpoint identifier
`result.data.result.description`	`string`	No	—	Description of private endpoint
`result.data.result.cloudProvider`	`"gcp" \| "aws" \| "azure"`	No	—	Cloud provider in which the private endpoint is lcoated Allowed: `gcp`, `aws`, `azure`.
`result.data.result.region`	`"ap-northeast-1" \| "ap-northeast-2" \| "ap-south-1" \| "ap-southeast-1" \| "ap-southeast-2" \| "ca-central-1" \| "eu-central-1" \| "eu-west-1" \| "eu-west-2" \| "il-central-1" \| "us-east-1" \| "us-east-2" \| "us-west-2" \| "us-east1" \| "us-central1" \| "europe-west2" \| "europe-west4" \| "asia-southeast1" \| "asia-northeast1" \| "eastus" \| "eastus2" \| "westus3" \| "germanywestcentral" \| "centralus"`	No	—	Region in which the private endpoint is located Allowed: `ap-northeast-1`, `ap-northeast-2`, `ap-south-1`, `ap-southeast-1`, `ap-southeast-2`, `ca-central-1`, `eu-central-1`, `eu-west-1`, `eu-west-2`, `il-central-1`, `us-east-1`, `us-east-2`, `us-west-2`, `us-east1`, `us-central1`, `europe-west2`, `europe-west4`, `asia-southeast1`, `asia-northeast1`, `eastus`, `eastus2`, `westus3`, `germanywestcentral`, `centralus`.
`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