HYhyperdxio
Connections

Update Connection

Changed on

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}

Request

  • Base URL
    / (relative, and the document was published on a file host, not at the API’s origin)
  • URL
    /api/v2/connections/{id}
  • Auth
    HTTP bearer

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

  • a4888dfe2491Revision changes
    • warning

      removed the request property

    • warning

      removed the optional property / from the response with the status

    • info

      added the new optional request property

    • info

      added the optional property / to the response with the status

  • 93cfcaa1a7daRevision changes
    • info

      endpoint added