Skip to main content
POST
Error

Authorizations

Authorization
string
header
required

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

Body

application/json
name
string
required

Display name for the connection.

Example:

"Production ClickHouse"

host
string
required

ClickHouse HTTP endpoint URL.

Example:

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

username
string
required

ClickHouse username.

Example:

"default"

password
string
write-only

ClickHouse password. Never returned by the API.

Example:

"my-secret-password"

hyperdxSettingPrefix
string | null

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

Example:

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

Example:

false

Response

Successfully created connection

data
object

The connection object.

Last modified on July 15, 2026