Skip to content

Retrieve an audit log export job

Request

Plans:Enterprise

Retrieve the status of an audit log export job. Poll this endpoint until status is COMPLETED, then download the file from the export results endpoint.

Security
ApiKey
Path
orgIdstring^org_[0-9abcdefghjkmnpqrstvwxyz]{26}$required
Organization ID.
Example:org_01h1s5z6vf2mm1mz3hevnn9va7
exportJobIdstring^exp_[0-9abcdefghjkmnpqrstvwxyz]{26}$required
Export Job ID.
Example:exp_01h1s5z6vf2mm1mz3hevnn9va7
Headers
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 GET \
  https://redocly.com/_mock/docs/platform/customization/reunite-api/openapi/orgs/org_01h1s5z6vf2mm1mz3hevnn9va7/audit-log-export-jobs/exp_01h1s5z6vf2mm1mz3hevnn9va7 \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>' \
  -H 'x-redocly-client: reunite-ui/0.92.1'

Responses

Export job.
Bodyapplication/json
idstring^exp_[0-9abcdefghjkmnpqrstvwxyz]{26}$read-onlyrequired

Unique identifier for the export job, prefixed with exp_.

Example:"exp_01hh1t9sa6gwfv5naz04gr7ehm"
statusstring(AuditLogExportStatus)required
Current status of the export job.
Enum:"IN_PROGRESS""COMPLETED""FAILED"
createdAtstring, (date-time)read-onlyrequired

Export job creation time (ISO 8601).

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