Skip to content

Export the ledger (cef|leef|syslog|otlp|otlp_envelope|otlp_log_record|ocsf)

GET
/v1/audit/export
curl --request GET \
--url 'https://example.com/v1/audit/export?format=cef' \
--header 'Authorization: Bearer <token>'

Streams the tenant ledger in the requested format, carrying the chain-integrity fields so an external archive or SIEM holds an independently verifiable copy. The export is itself recorded in the ledger.

X-Olivares-Tenant
string format: uuid

Target tenant id; required when the principal can act in more than one tenant.

format
string
default: cef
Allowed values: cef leef syslog otlp otlp_envelope otlp_log_record ocsf

Export format.

Exported ledger stream (format-dependent text or NDJSON)

string
Example generated
example

Bad request

Media type application/json
object
error
required
object
code
required
string
message
required
string
Example generated
{
"error": {
"code": "example",
"message": "example"
}
}

Unauthenticated

Media type application/json
object
error
required
object
code
required
string
message
required
string
Example generated
{
"error": {
"code": "example",
"message": "example"
}
}

Forbidden

Media type application/json
object
error
required
object
code
required
string
message
required
string
Example generated
{
"error": {
"code": "example",
"message": "example"
}
}

Not found

Media type application/json
object
error
required
object
code
required
string
message
required
string
Example generated
{
"error": {
"code": "example",
"message": "example"
}
}

Conflict / setup required

Media type application/json
object
error
required
object
code
required
string
message
required
string
Example generated
{
"error": {
"code": "example",
"message": "example"
}
}

Rate limited

Media type application/json
object
error
required
object
code
required
string
message
required
string
Example generated
{
"error": {
"code": "example",
"message": "example"
}
}