Audit logs

Audit logs record the actions performed in your Redocly organization. Each event includes details such as who performed the action, what the action was, and when it happened.

Reunite has no audit logs page. Export the audit logs through the Reunite API as a JSON or CSV file, then load it into your Security Information and Event Management tools, or keep it as evidence for a compliance review. An export runs as a job: you start the job, check its status, then download the file.

Make sure you have the following:

• An organization on a plan that includes audit logs.
• An API key with the org.auditLogs.read permission. Organization owners have this permission by default.
• Your organization ID, which starts with org_. To find it, select General in the navigation menu on the left side of the page, and copy the value of the ID field. The organization ID differs from the organization slug that appears in the Reunite URL.

To export the audit logs for your organization, use the Replay consoles embedded on this page.

Each request in this guide sends the API key as a bearer token:

Authorization: Bearer <your-api-key>

1. 1

   In the environment selector, choose Production main server. If your organization is on app.cloud.eu.redocly.com, choose Production EU server.

2. 2

   Expand the Authorization section and paste your API key.

3. 3

   In the Path tab, set the orgId value to your organization ID.

Send a request to create the export job.

1. 1

   Set start and end to the time range you need, and format to json or csv. The range must not exceed 31 days. When you omit both dates, the export covers the last month.

2. 2

   To limit the export to specific event types, set filter to type: followed by one or more event types separated by commas, such as type:com.redocly.apiKey.created,com.redocly.apiKey.revoked. The Event types section lists every value the filter accepts. Omit the filter to export every type.

3. 3

   Send the request. The response returns the job id, which starts with exp_. Copy this value to use it in the next sections.

   Loading...

The export runs in the background.

1. 1

   Send the job id you received after starting the export job to check whether the file is ready.

   Loading...
2. 2

   Check the status field in the response, which returns one of three values:

   • IN_PROGRESS: the export is still running. Send the request again in a few seconds.
   • COMPLETED: the file is ready to download.
   • FAILED: the export did not finish. Start a new job, and contact support if the failure repeats.

1. 1

   After the status is COMPLETED, send the request to download the file.

   Loading...
2. 2

   The response body holds the events, newest first, in the format you chose in the Start an export job section. The Content-Disposition header suggests a file name. Until the job completes, this request returns 404.

Reference for the fields in each exported event and the event types the audit log records.

An event in an export can have the following fields.

The export includes the following event types. Use any of them as a value of the filter parameter in the Start an export job section.

• Manage API keys - Create the key that authenticates your audit log exports and set the permissions it grants
• Reunite API reference - Look up the audit log export operations, their parameters, and their response schemas
• Teams and users - Organize users into teams with role-based permissions for effective collaboration and access control
• Compliance reports - Download Redocly's SOC 2, penetration test, and CAIQ reports for your security reviews
• Roles and permissions - Review which role grants the permission to read audit logs