Skip to content

Create an export config (EDITOR; encrypts credentials at rest)

projectId
required
string
Media typeapplication/json
object
name
required
string
>= 1 characters <= 100 characters
enabled
boolean
default: true
provider
required
string
Allowed values: r2 s3 cos oss custom
endpoint
required
string format: uri
region
string
""
bucket
required
string
/^[a-zA-Z0-9._-]{1,255}$/
prefix
string
""
pathStyle
boolean
accessKeyId
required

Stored encrypted (AES-256-GCM).

string
>= 1 characters
secretAccessKey
required

Stored encrypted.

string
>= 1 characters
format
string
default: ndjson_gz
Allowed values: ndjson_gz
frequency
string
default: hourly
Allowed values: hourly daily
fieldSelection

Subset of exportable AE field names; timestamp/_sample_interval always included.

Array<string>
includeInternalEvents
boolean
excludeIp
boolean

{ config }

Media typeapplication/json
object
key
additional properties
any

Validation failed / bad field selection

Media typeapplication/json

Export route validation error; details carries formatted Zod issues.

object
error
required
string
details
Array<object>
object
key
additional properties
any
Examplegenerated
json
{
"error": "example",
"details": [
{}
]
}

EXPORT_CONFIG_ENC_KEY not configured

Media typeapplication/json
object
error
required

Human-readable error message.

string
message
string
Examplegenerated
json
{
"error": "example",
"message": "example"
}