Guide

ClickHouse Endpoint

Source

ClickHouse endpoints connect Gateway to ClickHouse clusters for governed analytical queries, telemetry exploration, and high-volume operational analytics.

Endpoint Kind

Use clickhouse as the endpoint kind when creating this endpoint through the API or dashboard.

What Gateway Uses ClickHouse Endpoints For

  • Run governed analytical SQL against ClickHouse.
  • Expose operational and product analytics to AI Orchestration and approved tools.
  • Centralize credential handling for ClickHouse HTTP access.
  • Combine ClickHouse data with Datadog, PostHog, Snowflake, and LLM workflows.

Basic Endpoint Shape

json
{
  "endpoint": "clickhouse-prod",
  "kind": "clickhouse",
  "config": {
    "read_conn": {
      "host": "clickhouse.internal",
      "port": 8123,
      "user": "default",
      "password": "secret",
      "database": "default"
    }
  },
  "description": "Production ClickHouse analytics"
}

Create it with the endpoint API:

bash
curl -sS -X POST "$EDEN/endpoints" \
  -H "$AUTH_HEADER" \
  -H "Content-Type: application/json" \
  -d '{
    "endpoint": "clickhouse-prod",
    "kind": "clickhouse",
    "config": {
      "read_conn": {
        "host": "clickhouse.internal",
        "port": 8123,
        "user": "default",
        "password": "secret",
        "database": "default"
      }
    },
    "description": "Production ClickHouse analytics"
  }'

Configuration Fields

FieldPurpose
hostClickHouse host.
portHTTP interface port, usually 8123.
userUsername, often default in local setups.
passwordPassword.
databaseDefault database.

Operating Notes

  • Use query limits and read-only users for exploratory and agent-facing access.
  • Watch expensive scans, distributed query fanout, and memory settings.
  • Keep production telemetry endpoints separate from local development ClickHouse instances.
Help improve Eden Docs

Find something unclear or incomplete? Review the source and propose an update.

View on GitLab Updated August 2, 2026