Explore documentation
  1. Welcome to Telemetry👋
  2. Quick start guide
  3. Ingesting data
    1. Vector (Recommended)
    2. OpenTelemetry
    3. Ingesting via HTTP API
    4. Ingesting metrics
    5. Ingesting logs
    6. Migrating to Better Stack
  4. Telemetry API
    1. Getting an API token
    2. Sources API
      1. List all sources GET
      2. Get a single source GET
      3. Create a source POST
      4. Update a source PATCH
      5. Remove a source DELETE
    3. Metrics API
    4. Query API
  5. Using the product
    1. Transforming ingested data
    2. Querying data
    3. Alerts

Create a source

Returns a newly created source.

POST https://telemetry.betterstack.com/api/v1/sources

Headers

Authorization
required string

Bearer $TOKEN

Body parameters

team_name
string

Required if using global API token to specify the team which should own the resource

name
required string

Source name

ingesting_paused
boolean

Enable or disable ingesting for this source

platform
required string

Source platform.
The currently supported platforms are:
- apache2
- aws_cloudwatch
- aws_ecs
- aws_elb
- aws_fargate
- cloudflare_logpush
- cloudflare_worker
- datadog_agent
- digitalocean
- docker
- dokku
- dotnet
- elasticsearch
- erlang
- filebeat
- flights
- fluentbit
- fluentd
- fly_io
- go
- haproxy
- heroku
- http
- java
- javascript
- kubernetes
- logstash
- minio
- mongodb
- mysql
- nginx
- open_telemetry
- php
- postgresql
- prometheus
- prometheus_scrape
- python
- rabbitmq
- redis
- render
- rsyslog
- ruby
- syslog-ng
- traefik
- ubuntu
- vector
- vercel_integration
- flights

live_tail_pattern
string

Live tail message format with columns wrapped in {column} brackets.
Example: "PID: {message_json.pid} {level} {message}".
For details, see Live tail docs.

logs_retention
integer

Data retention for logs in days. There might be additional charges for longer retention.

metrics_retention
integer

Data retention for metrics in days. There might be additional charges for longer retention.

scrape_urls
array

URLs to scrape by prometheus_scrape platform and similar.

scrape_frequency_secs
integer

How often to scrape the URLs for prometheus_scrape platform and similar. Permitted values are 15, 30, 60, 120 or 300.

scrape_request_headers
array

An array of request headers for prometheus_scrape platform and similar, with each object containing name and value fields.

scrape_request_basic_auth_user
string

Basic auth username for prometheus_scrape platform and similar.

scrape_request_basic_auth_password
string

Basic auth password for prometheus_scrape platform and similar.

200

The source was created

Response body

{
  "id": "95",
  "type": "source",
  "attributes": {
    "team_id": 123,
    "team_name": "Test team",
    "name": "Nginx",
    "table_name": "nginx",
    "platform": "nginx",
    "token": "FczKcxEhjEDE58dBX7XaeX1q",
    "ingesting_host": "s95.eu-nbg-2.betterstackdata.com",
    "ingesting_paused": false,
    "logs_retention": 7,
    "metrics_retention": 14,
    "live_tail_pattern": "{level} {host} {nginx.status} {nginx.method} {nginx.host} {nginx.path} {nginx.client} {nginx.agent} {message}",
    "created_at": "2021-05-27T12:30:41.695Z",
    "updated_at": "2021-06-11T14:00:50.756Z"
  }
}
422

Validation failed

Response body

{
  "errors": "Your plan doesn't support custom retention",
  "invalid_attributes": [
    "logs_retention",
    "metrics_retention"
  ]
}

Previous article

Get a single source

Next article

Update a source