Get a single collector

Retrieves details for a single collector by its ID.

GET https://telemetry.betterstack.com/api/v1/collectors/{id}

URL parameters

id
required 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,
          "metrics_databases": true
        },
        "logs_sample_rate": 100,
        "traces_sample_rate": 100,
        "vrl_transformation": ".message = downcase!(.message)",
        "disk_batch_size_mb": 512,
        "memory_batch_size_mb": 20,
        "when_full": "block",
        "namespaces_options": {
          "kube-system": {
            "log_sampling": 0,
            "ingest_traces": false
          }
        },
        "services_options": {
          "api-service": {
            "log_sampling": 100
          }
        }
      },
      "proxy_config": null,
      "user_vector_config": "sources:\n  custom_input:\n    type: file\n    include:\n      - /var/log/custom.log",
      "ingesting_paused": false,
      "source_vrl_transformation": ".environment = \"production\"",
      "pinged_at": "2023-10-27T10:00:00.000Z",
      "created_at": "2023-10-26T10:00:00.000Z",
      "updated_at": "2023-10-27T09:30:00.000Z",
      "custom_bucket": {
        "name": "my-logs-bucket",
        "endpoint": "https://s3.us-east-1.amazonaws.com/my-logs-bucket",
        "access_key_id": "AKIAIOSFODNN7EXAMPLE",
        "keep_data_after_retention": false
      }
    }
  }
}
401
404

Example Request

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