ClickHouse Cloud: Clickhouse Click Stack Update Connection

Change a ClickStack ClickHouse connection’s name, host, username or password.

Tool ID: clickhouse_click_stack_update_connection

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_stack_update_connection',
  {
    "organizationId": "123e4567-e89b-42d3-a456-426614174000",
    "serviceId": "123e4567-e89b-42d3-a456-426614174000",
    "clickStackConnectionId": "click_stack_connection_123",
    "name": "Example",
    "host": "api.example.com",
    "username": "user@example.com"
  },
);

console.log(result.toolResponse.raw);

CLI

deepline tools execute clickhouse_click_stack_update_connection --input '{
  "organizationId": "123e4567-e89b-42d3-a456-426614174000",
  "serviceId": "123e4567-e89b-42d3-a456-426614174000",
  "clickStackConnectionId": "click_stack_connection_123",
  "name": "Example",
  "host": "api.example.com",
  "username": "user@example.com"
}' --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",
      "name": "Example",
      "host": "api.example.com",
      "username": "user@example.com"
    }
  }
}

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

Input reference

This endpoint is in beta. API contract is stable, and no breaking changes are expected in the future. ClickStack: Updates an existing ClickHouse connection. Field semantics: if password is omitted or empty the existing password is kept. hyperdxSettingPrefix is cleared when set to null or an empty string, and kept unchanged when omitted.

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 ClickStack service. Format: `uuid`.
`payload.clickStackConnectionId`	`string`	Yes	—	Connection ID
`payload.name`	`string`	Yes	—	Display name for the connection.
`payload.host`	`string`	Yes	—	ClickHouse HTTP endpoint URL.
`payload.username`	`string`	Yes	—	ClickHouse username.
`payload.password`	`string`	No	—	ClickHouse password. If omitted or empty, the existing password is kept.
`payload.hyperdxSettingPrefix`	`string`	No	—	Optional prefix for HyperDX-specific ClickHouse settings. Set to null or an empty string to clear the existing value. If omitted, the existing value is kept.
`payload.isPrometheusEndpoint`	`boolean`	No	—	Optional. When true, `host` is treated as a Prometheus-compatible API endpoint. When false or omitted, `host` is a ClickHouse HTTP endpoint. Omit to keep the existing value unchanged.

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`	Yes	—	Unique connection ID.
`result.data.result.name`	`string`	Yes	—	Display name for the connection.
`result.data.result.host`	`string`	Yes	—	ClickHouse HTTP endpoint URL.
`result.data.result.username`	`string`	Yes	—	ClickHouse username.
`result.data.result.hyperdxSettingPrefix`	`string \| null`	No	—	Optional prefix for HyperDX-specific ClickHouse settings. Must only contain alphanumeric characters and underscores.
`result.data.result.isPrometheusEndpoint`	`boolean`	No	—	Optional. When true, `host` is treated as a Prometheus-compatible API endpoint (e.g. Prometheus or Thanos) and PromQL queries are proxied to it. When false or omitted, `host` is a ClickHouse HTTP endpoint.
`result.data.result.createdAt`	`string`	No	—	Creation timestamp Format: `date-time`.
`result.data.result.updatedAt`	`string`	No	—	Last update timestamp Format: `date-time`.
`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