Sign in
Connections

Update Connection

Updates an existing ClickHouse connection.

Field semantics: if password is omitted or empty the existing password is kept. hyperdxSettingPrefix is cleared when set to null or an empty string, and prometheusEndpoint is cleared when set to null; both are kept unchanged when omitted.

put/api/v2/connections/{id}

Path parameters

idstring required

Connection ID

Request body

namestring required

Display name for the connection.

hoststring required

ClickHouse HTTP endpoint URL.

usernamestring required

ClickHouse username.

passwordstring

ClickHouse password. If omitted or empty, the existing password is kept.

hyperdxSettingPrefixstring nullable

Optional prefix for HyperDX-specific ClickHouse settings. Set to null or an empty string to clear the existing value. If omitted, the existing value is kept.

isPrometheusEndpointboolean

Optional. When true, host is treated as a Prometheus-compatible API endpoint. When false or omitted, host is a ClickHouse HTTP endpoint. Omit to keep the existing value unchanged.

Example request

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

Response

Successfully updated 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