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

마지막 수정일 2026년 7월 15일

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

기능

가이드

인증

경로 매개변수

응답