---
title: "List Connections"
method: GET
path: "/api/v2/connections"
tags: ["Connections"]
---

# List Connections

`GET /api/v2/connections`

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

## Response `200`

Successfully retrieved connections

- ConnectionsListResponse
  - `data` Connection[] — List of connection objects.
    - `id` string, required — Unique connection ID.
    - `name` string, required — Display name for the connection.
    - `host` string, required — ClickHouse HTTP endpoint URL.
    - `username` string, required — ClickHouse username.
    - `hyperdxSettingPrefix` string, nullable — Optional prefix for HyperDX-specific ClickHouse settings. Must only contain alphanumeric characters and underscores.
    - `isPrometheusEndpoint` boolean — Optional. When true, `host` is treated as a Prometheus-compatible API endpoint (e.g. Prometheus or Thanos) and PromQL queries are proxied to it. When false or omitted, `host` is a ClickHouse HTTP endpoint.
    - `createdAt` string, date-time — Creation timestamp
    - `updatedAt` string, date-time — Last update timestamp
  - `meta` object — Present only when one or more stored connections could not be serialized and were omitted from `data`.
    - `skipped` integer — Number of connections omitted from the response because they failed serialization.
    - `skippedIds` string[] — IDs of the connections that were omitted.

## Other responses

- `401` — Unauthorized
- `403` — Forbidden

## Changes

- **2026-06-26** `a4888dfe2491` — 1 warning, 1 info
  - removed the optional property `data/items/prometheusEndpoint` from the response with the `200` status
  - added the optional property `data/items/isPrometheusEndpoint` to the response with the `200` status
- **2026-06-16** `93cfcaa1a7da` — 1 info
  - endpoint added
- **2026-01-30** `ed852374c451` — 1 breaking
  - api path removed without deprecation

[Change history](https://skmtc.dev/hyperdxio/apis/hyperdx-external-api/changes/api/v2/connections/get.md)

---

[API](https://skmtc.dev/hyperdxio/apis/hyperdx-external-api.md) · [All operations](https://skmtc.dev/hyperdxio/apis/hyperdx-external-api/llms.txt) · [OpenAPI document](https://skmtc-service-production.skmtc.workers.dev/v1/apis/hyperdxio/hyperdx-external-api/revisions/3399efdca551/schema)