Sign in
Connections

Create Connection

Creates a new ClickHouse connection

post/api/v2/connections

Request body

namestring required

Display name for the connection.

hoststring required

ClickHouse HTTP endpoint URL.

usernamestring required

ClickHouse username.

passwordstring

ClickHouse password. Never returned by the API.

hyperdxSettingPrefixstring nullable

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

isPrometheusEndpointboolean

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 request

{
  "name": "Production ClickHouse",
  "host": "https://clickhouse.example.com:8443",
  "username": "default",
  "password": "my-secret-password",
  "hyperdxSettingPrefix": "hyperdx_"
}

Response

Successfully created connection

Example response

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

Changes

Changed in 3 of the 60 revisions of this API.123

  • a4888dfe249122See the full diff
    • ●

      removed the request property prometheusEndpoint

      request-property-removed

    • ●

      removed the optional property data/prometheusEndpoint from the response with the 200 status

      response-optional-property-removed

    • ○

      added the new optional request property isPrometheusEndpoint

      new-optional-request-property

    • ○

      added the optional property data/isPrometheusEndpoint to the response with the 200 status

      response-optional-property-added

  • 93cfcaa1a7da1See the full diff
    • ○

      endpoint added

      endpoint-added

  • ed852374c4511See the full diff
    • ▲

      api path removed without deprecation

      api-path-removed-without-deprecation

    This revision also has 100 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog