Get Connection

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

GET /api/v2/connections/{id}

Error

A valid request URL is required to generate request examples

200

{
  "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": "Unauthorized access. API key is missing or invalid."
}

{
  "message": "Connection not found"
}

Autorisations

Authorization · string · header · requis

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Paramètres de chemin

id · string · requis

Connection ID

Réponse

200

application/json

Successfully retrieved connection

data · object

The connection object.

Show child attributes