Skip to main content
POST
Error

Autorizações

Authorization
string
header
obrigatório

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

Corpo

application/json
name
string
obrigatório

Display name for the connection.

Exemplo:

"Production ClickHouse"

host
string
obrigatório

ClickHouse HTTP endpoint URL.

Exemplo:

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

username
string
obrigatório

ClickHouse username.

Exemplo:

"default"

password
string
write-only

ClickHouse password. Never returned by the API.

Exemplo:

"my-secret-password"

hyperdxSettingPrefix
string | null

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

Exemplo:

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

Exemplo:

false

Resposta

Successfully created connection

data
object

The connection object.

Última modificação em 15 de julho de 2026