HYhyperdxio
Connections

List Connections

Changed on

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

get/api/v2/connections

Request

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

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

  • a4888dfe2491Revision changes
    • warning

      removed the optional property // from the response with the status

    • info

      added the optional property // to the response with the status

  • 93cfcaa1a7daRevision changes
    • info

      endpoint added