Update a source

Updates an existing source. Send only the parameters you wish to change (e.g. name )

PATCH https://logs.betterstack.com/api/v1/sources/{source_id}

URL parameters

id
required string

Body parameters

name
string
ingesting_paused
boolean
live_tail_pattern
string
logs_retention
integer
metrics_retention
integer
scrape_urls
array
scrape_frequency_secs
integer
scrape_request_headers
array
scrape_request_basic_auth_user
string
scrape_request_basic_auth_password
string
200

Response body

{
  "id": "95",
  "type": "source",
  "attributes": {
    "team_id": 123,
    "team_name": "Test team",
    "name": "Nginx",
    "table_name": "nginx",
    "platform": "nginx",
    "token": "FczKcxEhjEDE58dBX7XaeX1q",
    "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"
  }
}
404

Response body

{
  "errors": "Resource with provided ID was not found"
}
422

Response body

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