Create Connection

Creates a new ClickHouse connection

POST /api/v2/connections

Error

A valid request URL is required to generate request examples

200

{
  "data": {
    "id": "507f1f77bcf86cd799439012",
    "name": "Production ClickHouse",
    "host": "https://clickhouse.example.com:8443",
    "username": "default",
    "hyperdxSettingPrefix": "hyperdx_",
    "isPrometheusEndpoint": false,
    "createdAt": "2025-01-01T00:00:00.000Z",
    "updatedAt": "2025-06-15T10:30:00.000Z"
  }
}

{
  "message": "Body validation failed: name: Required"
}

{
  "message": "Unauthorized access. API key is missing or invalid."
}

授权

Authorization · string · header · 必填

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

请求体

application/json

name · string · 必填

Display name for the connection.

示例:

"Production ClickHouse"

host · string · 必填

ClickHouse HTTP endpoint URL.

示例:

"https://clickhouse.example.com:8443"

username · string · 必填

ClickHouse username.

示例:

"default"

password · string · write-only

ClickHouse password. Never returned by the API.

示例:

"my-secret-password"

hyperdxSettingPrefix · string | null

Optional prefix for HyperDX-specific ClickHouse settings. Must only contain alphanumeric characters and underscores.

示例:

"hyperdx_"

isPrometheusEndpoint · boolean

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.

示例:

false

响应

200

application/json

Successfully created connection

data · object

The connection object.

Show child attributes