Skip to main content
PUT
/
forward-configs
/
{forwardId}
Update an existing forward config
curl --request PUT \
  --url https://api.eu.bronto.io/forward-configs/{forwardId} \
  --header 'Content-Type: application/json' \
  --header 'X-BRONTO-API-KEY: <api-key>' \
  --data '{
  "name": "Archive data to S3",
  "description": "Sending data to S3 for long term store",
  "filter": "level='\''ERROR'\'' or level='\''WARN'\''",
  "compression": "ZSTD",
  "all_logs": true,
  "log_ids": [
    "<string>"
  ],
  "max_payload_size_bytes": 10000000,
  "max_payload_size_events": 1000,
  "max_buffer_time_ms": 300000,
  "destination": {
    "destination_type": "S3",
    "bucket": "my-archive-bucket",
    "prefix": "bronto/archives/",
    "storage_class": "STANDARD"
  }
}'
{
  "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "name": "Archive data to S3",
  "description": "Sending data to S3 for long term store",
  "filter": "level='ERROR' or level='WARN'",
  "compression": "ZSTD",
  "all_logs": true,
  "log_ids": [
    "<string>"
  ],
  "max_payload_size_bytes": 10000000,
  "max_payload_size_events": 1000,
  "max_buffer_time_ms": 300000,
  "destination": {
    "destination_type": "S3",
    "bucket": "my-archive-bucket",
    "prefix": "bronto/archives/",
    "storage_class": "STANDARD"
  },
  "created_at": 1710948395538
}

Authorizations

​
X-BRONTO-API-KEY
string
header
required

Path Parameters

​
forwardId
string<uuid>
required

Body

application/json
​
name
string
required
Required string length: 1 - 255
Example:
​
compression
enum<string>
default:ZSTD
required
Available options:
ZSTD,
GZIP,
NONE
​
all_logs
boolean
required
​
destination
object
required
​
description
string
Maximum length: 1000
Example:
​
filter
string
Maximum length: 2000
Example:
​
log_ids
string[]
​
max_payload_size_bytes
number
default:10000000
Required range: 1000000 <= x <= 1000000000
Example:
​
max_payload_size_events
number
default:1000000
Required range: 1000 <= x <= 1000000000
Example:
​
max_buffer_time_ms
number
default:300000
Required range: 60000 <= x <= 86400000
Example:

Response

​
id
string<uuid>
required
​
name
string
required
Required string length: 1 - 255
Example:
​
compression
enum<string>
default:ZSTD
required
Available options:
ZSTD,
GZIP,
NONE
​
all_logs
boolean
required
​
destination
object
required
​
created_at
integer
required
Example:
​
description
string
Maximum length: 1000
Example:
​
filter
string
Maximum length: 2000
Example:
​
log_ids
string[]
​
max_payload_size_bytes
number
default:10000000
Required range: 1000000 <= x <= 1000000000
Example:
​
max_payload_size_events
number
default:1000000
Required range: 1000 <= x <= 1000000000
Example:
​
max_buffer_time_ms
number
default:300000
Required range: 60000 <= x <= 86400000
Example: