Update Connection

View as MarkdownEdit this pageReport an issueSet up docs MCP

PUT/api/v2/connections/{id}

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.

Authorizations

AuthorizationBearer API Keyheaderrequired
`Authorization: Bearer <token>`

Path parameters

idstringrequired
Connection ID

Request bodyJSON

namestringrequired
Display name for the connection.

Example: "Production ClickHouse"
hoststringrequired
ClickHouse HTTP endpoint URL.

Example: "https://clickhouse.example.com:8443"
usernamestringrequired
ClickHouse username.

Example: "default"
passwordoptionalstring
ClickHouse password. If omitted or empty, the existing password is kept.

Example: "my-new-secret-password"
hyperdxSettingPrefixoptionalstringor 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.

Example: "hyperdx_"
isPrometheusEndpointoptionalboolean
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: false

Response

JSON

200

Successfully updated connection

JSON

dataoptionalobject
The connection object.
8 properties
- idstringrequired
  Unique connection ID.
  
  Example: "507f1f77bcf86cd799439012"
- namestringrequired
  Display name for the connection.
  
  Example: "Production ClickHouse"
- hoststringrequired
  ClickHouse HTTP endpoint URL.
  
  Example: "https://clickhouse.example.com:8443"
- usernamestringrequired
  ClickHouse username.
  
  Example: "default"
- hyperdxSettingPrefixoptionalstringor null
  Optional prefix for HyperDX-specific ClickHouse settings. Must only contain alphanumeric characters and underscores.
  
  Example: "hyperdx_"
- isPrometheusEndpointoptionalboolean
  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: false
- createdAtoptionalstring
  Creation timestamp
  
  format: date-time
  Example: "2025-01-01T00:00:00.000Z"
- updatedAtoptionalstring
  Last update timestamp
  
  format: date-time
  Example: "2025-06-15T10:30:00.000Z"

Update Connection

curl --request PUT \
  --url /api/v2/connections/string \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "name": "Production ClickHouse",
  "host": "https://clickhouse.example.com:8443",
  "username": "default",
  "password": "my-new-secret-password",
  "hyperdxSettingPrefix": "hyperdx_",
  "isPrometheusEndpoint": false
}
'

const url = '/api/v2/connections/string';
const options = {
  method: 'PUT',
  headers: {'Content-Type': 'application/json', Authorization: 'Bearer <token>'},
  body: JSON.stringify({
    name: 'Production ClickHouse',
    host: 'https://clickhouse.example.com:8443',
    username: 'default',
    password: 'my-new-secret-password',
    hyperdxSettingPrefix: 'hyperdx_',
    isPrometheusEndpoint: false
  })
};

fetch(url, options)
  .then(res => res.json())
  .then(json => console.log(json))
  .catch(err => console.error(err));

import requests

url = "/api/v2/connections/string"

payload = {
    "name": "Production ClickHouse",
    "host": "https://clickhouse.example.com:8443",
    "username": "default",
    "password": "my-new-secret-password",
    "hyperdxSettingPrefix": "hyperdx_",
    "isPrometheusEndpoint": False
}
headers = {
    "Content-Type": "application/json",
    "Authorization": "Bearer <token>"
}

response = requests.put(url, json=payload, headers=headers)

print(response.text)

Response example

{
  "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"
}