Audit log exports

Start an audit log export job

Request

Plans:Enterprise

Creates an asynchronous audit log export job. Poll the job status endpoint until status is COMPLETED, then download from the export results endpoint.

Security

ApiKey

Path

orgIdstring^org_[0-9abcdefghjkmnpqrstvwxyz]{26}$required

Organization ID.

Example:org_01h1s5z6vf2mm1mz3hevnn9va7

Query

filterstring

Standard list filter query. Supported fields for audit exports:

type — Event type. When omitted, exports include events of all types. Values must be valid audit log event types. Unsupported values return 400.

Filter fields other than type are ignored.

Example:filter=type:com.redocly.apiKey.created

startstring, (date)

Start of the time range in YYYY-MM-DD format. When end is omitted, exports include events from start through start + 31 days.

Example:start=2026-01-01

endstring, (date)

End of the time range in YYYY-MM-DD format. When start is omitted, exports include events from end - 31 days through end. The time window between start and end must not exceed 31 days.

Example:end=2026-01-31

formatstring

Output file format for the generated download.

Default:"json"

Enum:"json""csv"

Example:format=json

x-redocly-clientstring^[a-z0-9-]{1,64}/[\w.+-]{1,32}$

Identifies the calling client as <name>/<version>, for example reunite-ui/0.92.1. Used for API consumer observability. Requests without it are attributed as unknown.

Example:reunite-ui/0.92.1

curl -i -X POST \
  'https://redocly.com/_mock/docs/platform/customization/reunite-api/openapi/orgs/org_01h1s5z6vf2mm1mz3hevnn9va7/audit-log-export-jobs?filter=type%3Acom.redocly.apiKey.created&start=2026-01-01&end=2026-01-31&format=json' \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>' \
  -H 'x-redocly-client: reunite-ui/0.92.1'

Responses

Export job created.

Bodyapplication/json

idstring^exp_[0-9abcdefghjkmnpqrstvwxyz]{26}$read-onlyrequired

Unique identifier for the export job, prefixed with exp_.

Example:"exp_01hh1t9sa6gwfv5naz04gr7ehm"

createdAtstring, (date-time)read-onlyrequired

Export job creation time (ISO 8601).

Response

{
  "id": "exp_01hh1t9sa6gwfv5naz04gr7ehm",
  "createdAt": "2024-01-15T12:00:00.000Z"
}