Get Connection

GET

api

connections

{id}

Error

A valid request URL is required to generate request examples

{
  "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"
}

التفويضات

Authorization

string

header

مطلوب

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

معلمات المسار

string

مطلوب

Connection ID

الاستجابة

Successfully retrieved connection

data

object

The connection object.

Show child attributes

آخر تعديل في ١٥ يوليو ٢٠٢٦

Update ConnectionUpdates an existing ClickHouse connection. Field semantics: if `password` is omitted or empty the existing password is kept. `hyperdxSettingPrefix` is cleared when set to null or an empty string, and `prometheusEndpoint` is cleared when set to null; both are kept unchanged when omitted.

Error

A valid request URL is required to generate request examples

{
  "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"
}

الميزات

الأدلة

التفويضات

معلمات المسار

الاستجابة