Create a 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

source_group_id

integer

The ID of the source group this source belongs to

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

data_region

string

Data region or private cluster name to create the source in.
Permitted values for most plans are: us_east, us_west, germany, singapore.

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.

custom_bucket.name

string

Configure a custom S3-compatible bucket to host data from this source. This should be the name of the bucket.

E.g. storage-bucket.

custom_bucket.endpoint

string

The full URL endpoint of the S3-compatible bucket.

E.g. https://s3.us-east-1.amazonaws.com/storage-bucket.

custom_bucket.access_key_id

string

The Access Key ID of the key-pair that has permissions to access this bucket.

custom_bucket.secret_access_key

string

The Secret Access Key of the key-pair that has permissions to access this bucket.

200

The source was created

Response body

{
  "id": "95",
  "type": "source",
  "attributes": {
    "team_id": 123,
    "team_name": "Test team",
    "name": "Nginx",
    "source_group_id": 572,
    "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}",
    "custom_bucket": {
      "name": "storage-bucket",
      "endpoint": "https://s3.us-east-1.amazonaws.com/storage-bucket",
      "access_key_id": "AKIAIOSFODNN7EXAMPLE"
    },
    "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"
  ]
}

Explore documentation

Example cURL