Audit logs
Review, export, and stream audit logs to Amazon S3 or Datadog to track deployments, configuration changes, and permission updates in your organization.
Use audit logs to monitor and track actions performed by members of your organization. Audit logs provide a record of activities for security, compliance, and troubleshooting purposes.
- Monitor security: Track authentication attempts and permission changes.
- Ensure compliance: Maintain records of all organizational activities.
- Troubleshoot issues: Investigate failed actions and their causes.
- Track changes: Review who made specific changes and when.
View audit logs
Section titled “View audit logs”Only organization admins can view and export audit logs.
Navigate to the Audit log page of your dashboard to view audit logs. Mintlify retains audit log entries for two years. Export logs to CSV to keep records for longer.
Click any log entry to expand it and view detailed information, including:
| Field | Description |
|---|---|
| Timestamp | Date and time when the action occurred |
| Actor | The email address of the user who performed the action |
| Action | What action the user performed |
| Category | Type of resource affected |
| Outcome | Whether the action succeeded or failed |
| Metadata | Additional context about the action |
Filter logs
Section titled “Filter logs”Filter audit logs to find specific activities.
Date range: Select a preset date range to view logs over a specific period.
Category: Filter logs by the type of action.
| Category | Description |
|---|---|
| Organization | Organization settings updates and deletion requests. |
| Member | Team member invitations, removals, role changes, and credential revocations. |
| Project | Project configuration changes including custom domains, authentication, Git sources, MCP client credentials, rollbacks, and build promotions. |
| Preview deployment | Preview deployment creation, updates, and authentication changes. |
| API key | API key and discovery API key creation and deletion. |
| Assistant | Assistant setting updates like deflection email, web search sites, and starter questions. |
| PDF export | PDF export generation and deletion. |
| Integration | GitHub and Slack installations and removals. |
| Billing | Subscription updates, add-on purchases, and invoice views. |
| Quota | Overage policy and alert configuration changes. |
| User | Individual user notification settings. |
| Automations | Automation configurations and repository management. |
| Audit log | Audit log views and exports. |
| Auth | Login attempts, logouts, session creations, and break-glass logins. |
| SSO | SSO connection changes, sign-in policy updates, break-glass access updates, and verified domain changes. |
| SCIM | Automated user provisioning, updates, and deprovisioning from your identity provider, and group role mapping changes. |
Stream audit logs
Section titled “Stream audit logs”Stream audit logs to Amazon S3 or Datadog in near real time. Use streaming to send audit events to your existing security monitoring and long-term retention systems without repeatedly exporting CSV files.
Organization admins can add multiple destinations and select which categories to send. By default, all categories stream, and the category selection applies to every configured destination.
Add a destination
Section titled “Add a destination”-
Navigate to the Audit log page of your dashboard.
-
In the Audit log streaming section, click Configure.
-
Click Add destination and select Amazon S3 or Datadog.
-
Enter an optional label to identify the destination, then provide the required connection details:
Destination Required details Optional details Amazon S3 Bucket, AWS region, access key ID, and secret access key Key prefix Datadog Datadog site and API key None -
Click Add destination.
Prepare Amazon S3 credentials
Create an IAM user (or role with programmatic access credentials) whose policy allows writing to the target bucket. At minimum, grant s3:PutObject on the bucket and key prefix that you plan to use. For example:
{
"Version": "2012-10-17",
"Statement": [
{
"Effect": "Allow",
"Action": ["s3:PutObject"],
"Resource": "arn:aws:s3:::your-bucket-name/audit-logs/*"
}
]
}Use the access key ID and secret access key from that IAM user when adding the destination. The key prefix is optional, and Mintlify prepends it to every object it writes.
Prepare Datadog credentials
Create a Datadog API key from Organization Settings > API Keys in your Datadog account. Do not use an application key.
Set the Datadog site to match the region where you host your Datadog account, for example datadoghq.com (US1), us3.datadoghq.com, us5.datadoghq.com, datadoghq.eu (EU1), ap1.datadoghq.com, or ddog-gov.com. Using the wrong site rejects the events.
To stop streaming to a destination, open the streaming configuration and click the remove icon next to the destination.
Select streamed categories
Section titled “Select streamed categories”- Navigate to the Audit log page of your dashboard.
- In the Audit log streaming section, click Configure.
- Under Streamed categories, select the categories that you want to send. Clear a category to exclude its events from the stream.
- Click Save changes.
Export audit logs
Section titled “Export audit logs”Export audit logs to CSV for analysis, compliance reporting, or long-term archival.
- Navigate to the Audit log page of your dashboard.
- Optionally, apply filters to narrow down the logs you want to export.
- Click Export CSV.
- Mintlify sends you an email with a download link when the export is ready.