> ## 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 Get Connection

> Get one ClickStack ClickHouse connection by its ID, without its password. Includes SDK V2 examples, input constraints, response fields, and Deepline cost.

Get one ClickStack ClickHouse connection by its ID, without its password.

> [!NOTE]
>
> Tool ID: `clickhouse_click_stack_get_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.

```ts theme={"languages":{"custom":["/languages/deepline-prompt.json"]}}
import { Deepline } from 'deepline';

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

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

### CLI

```bash theme={"languages":{"custom":["/languages/deepline-prompt.json"]}}
deepline tools execute clickhouse_click_stack_get_connection --input '{
  "organizationId": "123e4567-e89b-42d3-a456-426614174000",
  "serviceId": "123e4567-e89b-42d3-a456-426614174000",
  "clickStackConnectionId": "click_stack_connection_123"
}' --json
```

## Example response

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

```json theme={"languages":{"custom":["/languages/deepline-prompt.json"]}}
{
  "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_get_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: Retrieves a specific ClickHouse connection by ID. Passwords are never returned.

| 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 |

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

  ### Input JSON Schema

  ```json theme={"languages":{"custom":["/languages/deepline-prompt.json"]}}
  {
    "type": "object",
    "description": "**This endpoint is in beta.** API contract is stable, and no breaking changes are expected in the future. ClickStack: Retrieves a specific ClickHouse connection by ID. Passwords are never returned.",
    "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"
      },
      "clickStackConnectionId": {
        "type": "string",
        "description": "Connection ID"
      }
    },
    "required": [
      "organizationId",
      "serviceId",
      "clickStackConnectionId"
    ],
    "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={"languages":{"custom":["/languages/deepline-prompt.json"]}}
  {
    "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](https://deepline.com/docs/providers/clickhouse/guide.md)
* [SDK V2 quickstart](https://deepline.com/docs/sdk-v2/quickstart.md)
* [SDK reference](https://deepline.com/docs/sdk-v2/sdk-reference.md)
* [Run tools across a CSV](https://deepline.com/docs/sdk-v2/batch-csv.md)


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