> ## Documentation Index
> Fetch the complete documentation index at: https://deepline.com/docs/llms.txt
> Use this file to discover all available pages before exploring further.

# ClickHouse Cloud: Clickhouse Click Stack Create Connection

> ClickStack: Create Connection. Includes SDK V2 and CLI requests, input constraints, response fields, and Deepline credit cost.

ClickStack: Create Connection.

<Info>
  Tool ID: `clickhouse_click_stack_create_connection`
</Info>

## Run this action

Use the TypeScript SDK for a single call. Put `ctx.tools.execute(...)` inside a Play when the call should be durable, scheduled, or run across a CSV.

```ts theme={null}
import { Deepline } from 'deepline';

const deepline = await Deepline.connect();
const result = await deepline.tools.execute(
  'clickhouse_click_stack_create_connection',
  {
    "organizationId": "123e4567-e89b-42d3-a456-426614174000",
    "serviceId": "123e4567-e89b-42d3-a456-426614174000",
    "name": "Example",
    "host": "api.example.com",
    "username": "user@example.com"
  },
);

console.log(result.toolResponse.raw);
```

### CLI

```bash theme={null}
deepline tools execute clickhouse_click_stack_create_connection --input '{
  "organizationId": "123e4567-e89b-42d3-a456-426614174000",
  "serviceId": "123e4567-e89b-42d3-a456-426614174000",
  "name": "Example",
  "host": "api.example.com",
  "username": "user@example.com"
}' --json
```

## Example response

The SDK exposes this shape at `result.toolResponse.raw`. Values below are representative.

```json theme={null}
{
  "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 tools get clickhouse_click_stack_create_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: Creates a new ClickHouse connection

| 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.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. Never returned by the API. |
| `payload.hyperdxSettingPrefix` | `string` | No | — | Optional prefix for HyperDX-specific ClickHouse settings. Must only contain alphanumeric characters and underscores. |
| `payload.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. |

<details>
  <summary>Show raw input schema</summary>

  ### Input JSON Schema

  ```json theme={null}
  {
    "type": "object",
    "description": "**This endpoint is in beta.** API contract is stable, and no breaking changes are expected in the future. ClickStack: Creates a new ClickHouse connection",
    "properties": {
      "organizationId": {
        "type": "string",
        "description": "ID of the organization that owns the service.",
        "format": "uuid"
      },
      "serviceId": {
        "type": "string",
        "description": "ID of the ClickStack service.",
        "format": "uuid"
      },
      "name": {
        "type": "string",
        "description": "Display name for the connection."
      },
      "host": {
        "type": "string",
        "description": "ClickHouse HTTP endpoint URL."
      },
      "username": {
        "type": "string",
        "description": "ClickHouse username."
      },
      "password": {
        "type": "string",
        "description": "ClickHouse password. Never returned by the API."
      },
      "hyperdxSettingPrefix": {
        "type": [
          "string",
          "null"
        ],
        "description": "Optional prefix for HyperDX-specific ClickHouse settings. Must only contain alphanumeric characters and underscores."
      },
      "isPrometheusEndpoint": {
        "type": "boolean",
        "description": "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."
      }
    },
    "required": [
      "organizationId",
      "serviceId",
      "name",
      "host",
      "username"
    ],
    "additionalProperties": false
  }
  ```
</details>

## 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). |

<details>
  <summary>Show raw output schema</summary>

  ### Output JSON Schema

  ```json theme={null}
  {
    "type": "object",
    "description": "Standard tool result payload.",
    "properties": {
      "data": {
        "type": "object",
        "description": "Provider response payload.",
        "properties": {
          "status": {
            "type": "number",
            "description": "HTTP status code."
          },
          "requestId": {
            "type": "string",
            "description": "Unique id assigned to every request. UUIDv4",
            "format": "uuid"
          },
          "result": {
            "properties": {
              "id": {
                "type": "string",
                "description": "Unique connection ID."
              },
              "name": {
                "type": "string",
                "description": "Display name for the connection."
              },
              "host": {
                "type": "string",
                "description": "ClickHouse HTTP endpoint URL."
              },
              "username": {
                "type": "string",
                "description": "ClickHouse username."
              },
              "hyperdxSettingPrefix": {
                "type": [
                  "string",
                  "null"
                ],
                "description": "Optional prefix for HyperDX-specific ClickHouse settings. Must only contain alphanumeric characters and underscores."
              },
              "isPrometheusEndpoint": {
                "type": "boolean",
                "description": "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."
              },
              "createdAt": {
                "type": "string",
                "description": "Creation timestamp",
                "format": "date-time"
              },
              "updatedAt": {
                "type": "string",
                "description": "Last update timestamp",
                "format": "date-time"
              }
            },
            "required": [
              "id",
              "name",
              "host",
              "username"
            ],
            "additionalProperties": false
          }
        },
        "additionalProperties": false
      },
      "meta": {
        "type": "object",
        "description": "Additional response metadata (status, paging).",
        "additionalProperties": true
      }
    },
    "required": [
      "data"
    ],
    "additionalProperties": false
  }
  ```
</details>

## Deepline cost

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

## Related documentation

* [ClickHouse Cloud provider guide](/docs/providers/clickhouse/guide)
* [SDK V2 quickstart](/docs/sdk-v2/quickstart)
* [SDK reference](/docs/sdk-v2/sdk-reference)
* [Run tools across a CSV](/docs/sdk-v2/batch-csv)


This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.