Sign in
Connections

List Connections

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

get/api/v2/connections

Response

Successfully retrieved connections

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

Changes

Changed in 3 of the 60 revisions of this API.112

  • a4888dfe249111See the full diff
    • ●

      removed the optional property data/items/prometheusEndpoint from the response with the 200 status

      response-optional-property-removed

    • ○

      added the optional property data/items/isPrometheusEndpoint to the response with the 200 status

      response-optional-property-added

  • 93cfcaa1a7da1See the full diff
    • ○

      endpoint added

      endpoint-added

  • ed852374c4511See the full diff
    • ▲

      api path removed without deprecation

      api-path-removed-without-deprecation

    This revision also has 100 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog