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}

Error

A valid request URL is required to generate request examples

200

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

{
  "message": "Body validation failed: host: Required"
}

{
  "message": "Unauthorized access. API key is missing or invalid."
}

{
  "message": "Connection not found"
}

التفويضات

Authorization · string · header · مطلوب

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

معلمات المسار

id · string · مطلوب

Connection ID

الجسم

application/json

name · string · مطلوب

Display name for the connection.

مثال:

"Production ClickHouse"

host · string · مطلوب

ClickHouse HTTP endpoint URL.

مثال:

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

username · string · مطلوب

ClickHouse username.

مثال:

"default"

password · string · write-only

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

مثال:

"my-new-secret-password"

hyperdxSettingPrefix · string | null

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.

مثال:

"hyperdx_"

isPrometheusEndpoint · boolean

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.

مثال:

false

الاستجابة

200

application/json

Successfully updated connection

data · object

The connection object.

Show child attributes