Explore documentation
  1. Welcome to Telemetry 👋
  2. Quick start guide
  3. Wide events vs. time series
  4. Ingesting data
    1. Better Stack collector
    2. Vector
    3. OpenTelemetry
    4. Ingesting via HTTP API
    5. Ingesting metrics
    6. Ingesting logs
    7. Migrating to Better Stack
  5. Using the product
    1. Transforming ingested data
    2. Querying data
    3. Tracing
    4. Alerts
  6. Telemetry API
    1. Getting an API token
    2. Sources
    3. Metrics API
    4. Connections API
      1. List all connections GET
      2. Get a single connection GET
      3. Create a connection POST
      4. Remove a connection DELETE
    5. Query API ↗
  7. Alternative to
    1. Lightstep

List all connections

Returns a paginated list of ClickHouse connections. For extra details, such as individual data sources, see Get a single connection API.

GET https://telemetry.betterstack.com/api/v1/connections

Query parameters

page
integer

Page number for pagination

per_page
integer

Number of items per page (default: 50, max: 250)

Headers

Authorization
required string

Bearer $TOKEN

200

A paginated list of connections.

Response body

{
  "data": [
    {
      "id": "43700",
      "type": "connection",
      "attributes": {
        "id": 43700,
        "client_type": "clickhouse",
        "note": "My testing connection",
        "created_at": "2025-10-18T10:00:44.890Z",
        "valid_until": null,
        "host": "eu-nbg-2-connect.betterstackdata.com",
        "port": 443,
        "username": "uodjialjQXSPe66TePguwdE72Jjvn9DNy",
        "data_region": "eu-nbg-2",
        "ip_allowlist": [],
        "team_ids": [
          1234
        ],
        "team_names": [
          "My Team"
        ],
        "created_by": {
          "id": 456789,
          "email": "my@email.com"
        }
      }
    }
  ],
  "pagination": {
    "first": "https://telemetry.betterstack.com/api/v1/connections?page=1",
    "last": "https://telemetry.betterstack.com/api/v1/connections?page=1",
    "prev": null,
    "next": null
  }
}

This API requires a global API token for authentication, not a team-specific token. Include the token in the Authorization header.

Example cURL

Example
curl --request GET \
  --url https://telemetry.betterstack.com/api/v1/connections \
  --header "Authorization: Bearer $TOKEN"

Previous article

Remove a metric

Next article

Get a single connection