PUT
/
forward-configs
/
{forwardId}
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
required

The ID of the config to update

Body

application/json
​
name
string
required

The name of the config

Required string length: 1 - 255
Example:

"Archive data to S3"

​
compression
enum<string>
default:ZSTD
required

The compression algorithm to use, to reduce the payload size (ZSTD recommended)

Available options:
ZSTD,
GZIP,
NONE
​
all_logs
boolean
required

True to forward all logs, logs created in future will be automatically forwarded

​
destination
object
required
​
description
string

Extra contextual information to add to the forward config.

Maximum length: 1000
Example:

"Sending data to S3 for long term store"

​
filter
string

Optional filter, to forward only some events and discard others

Maximum length: 255
Example:

"level='ERROR' or level='WARN'"

​
log_ids
string[]

The list of log ids to forward. Required if all_logs is set to false, ignored if all_logs is set to true

​
max_payload_size_bytes
number
default:10000000

The max size of the payload in bytes, before compression. Payload of smaller size can be delivered by the system

Required range: 1000000 <= x <= 1000000000
Example:

10000000

​
max_payload_size_events
number
default:1000000

The max number of log events in a payload. Payloads with less events can be delivered by the system

Required range: 1000 <= x <= 1000000000
Example:

1000

​
max_buffer_time_ms
number
default:300000

The maximum time waited by the system while buffering events to build a payload

Required range: 60000 <= x <= 86400000
Example:

300000

Response

200
application/json
Forward config is successfully updated
​
id
string
required

unique identifier for the config

​
name
string
required

The name of the config

Required string length: 1 - 255
Example:

"Archive data to S3"

​
compression
enum<string>
default:ZSTD
required

The compression to use to reduce the payload size

Available options:
ZSTD,
GZIP,
NONE
​
all_logs
boolean
required

True to forward all logs, logs created in future will be automatically forwarded

​
destination
object
required
​
created_at
integer
required

The timestamp when the config was created

Example:

1710948395538

​
description
string

Extra contextual information to add to the forward config.

Maximum length: 1000
Example:

"Sending data to S3 for long term store"

​
filter
string

Optional filter to forward only some events and discard others

Maximum length: 255
Example:

"level='ERROR' or level='WARN'"

​
log_ids
string[]

The list of log ids to forward. Required if all_logs is set to false, ignored if all_logs is set to true

​
max_payload_size_bytes
number
default:10000000

The max size of the payload in bytes, before compression. Payload of smaller size can be delivered by the system

Required range: 1000000 <= x <= 1000000000
Example:

10000000

​
max_payload_size_events
number
default:1000000

The max number of log events in a payload. Payloads with less events can be delivered by the system

Required range: 1000 <= x <= 1000000000
Example:

1000

​
max_buffer_time_ms
number
default:300000

The maximum time waited by the system while buffering events to build a payload.

Required range: 60000 <= x <= 86400000
Example:

300000