Sign in

v51

OpenAPI 3.0.0raw.githubusercontent.com2026-07-1000256.1 KB
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"
  }
}