List all collectors

Returns a paginated list of collectors accessible by the authenticated user.

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

Query parameters

page
1 integer
per_page
50 integer
name
string
team_name
string

Headers

Authorization
required string
200

Response body

{
  "data": [
    {
      "id": "1",
      "type": "collector",
      "attributes": {
        "name": "Production Kubernetes",
        "platform": "kubernetes",
        "note": "Main cluster for production services.",
        "status": "online",
        "secret": "collector-secret-goes-here",
        "team_id": 123,
        "team_name": "My Team",
        "data_region": "a3",
        "logs_retention": 30,
        "metrics_retention": 90,
        "configuration": {
          "components": {
            "ebpf_metrics": true,
            "logs_kubernetes": true
          },
          "logs_sample_rate": 100,
          "traces_sample_rate": 100,
          "vrl_transformation": null,
          "disk_batch_size_mb": 256,
          "memory_batch_size_mb": 10,
          "when_full": "drop_newest"
        },
        "proxy_config": null,
        "user_vector_config": null,
        "ingesting_paused": false,
        "source_vrl_transformation": null,
        "pinged_at": "2023-10-27T10:00:00.000Z",
        "created_at": "2023-10-26T10:00:00.000Z",
        "updated_at": "2023-10-26T10:00:00.000Z",
        "custom_bucket": null
      }
    }
  ],
  "pagination": {
    "first": "https://telemetry.betterstack.com/api/v1/collectors?page=1&per_page=1",
    "last": "https://telemetry.betterstack.com/api/v1/collectors?page=2&per_page=1",
    "prev": null,
    "next": "https://telemetry.betterstack.com/api/v1/collectors?page=2&per_page=1"
  }
}
401

Example Request

cURL
curl -L -H "Authorization: Bearer $TOKEN" \
     "https://telemetry.betterstack.com/api/v1/collectors?name=Production"