List Connections

GET/api/v2/connections

Retrieves a list of all ClickHouse connections for the authenticated team. Passwords are never returned.

Authorizations

AuthorizationBearer API Keyheaderrequired
`Authorization: Bearer <token>`

Response

JSON

200

Successfully retrieved connections

JSON

dataoptionalarray ofobject
List of connection objects.
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"
metaoptionalobject
Present only when one or more stored connections could not be serialized and were omitted from data.
2 properties
- skippedoptionalinteger
  Number of connections omitted from the response because they failed serialization.
  
  Example: 1
- skippedIdsoptionalarray ofstring
  IDs of the connections that were omitted.
  
  Example: ["507f1f77bcf86cd799439012"]

List Connections

curl --request GET \
  --url /api/v2/connections \
  --header 'Authorization: Bearer <token>'

const url = '/api/v2/connections';
const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

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

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"
    }
  ],
  "meta": {
    "skipped": 1,
    "skippedIds": [
      "507f1f77bcf86cd799439012"
    ]
  }
}

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

{
  "message": "NOT_FOUND: Alert not found"
}

Authorizations

Response

200

401

403