v1

latestOpenAPI 3.0.02026-07-1738124256.1 KB

Connections

Get Connection

Retrieves a specific ClickHouse connection by ID. Passwords are never returned.

get/api/v2/connections/{id}

Path parameters

idstring required

Connection ID

Response

Successfully retrieved 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"
  }
}