Skip to content

docs: add API audit logs and CSV export page#290

Open
mintlify[bot] wants to merge 1 commit into
mainfrom
mintlify/c3759f77
Open

docs: add API audit logs and CSV export page#290
mintlify[bot] wants to merge 1 commit into
mainfrom
mintlify/c3759f77

Conversation

@mintlify
Copy link
Copy Markdown
Contributor

@mintlify mintlify Bot commented May 26, 2026

Summary

Documents the new streaming CSV export for project API audit logs, plus the existing audit logs tab it lives on. Triggered by the upstream PR that adds an Export CSV button and a POST /api/v2/projects/{project_id}/api-audit-logs/export endpoint that streams a filtered CSV of audit activity.

Changes

  • New page security-and-compliance/api-audit-logs.mdx covering:
    • What gets recorded in API audit logs and when to use them (SOC 2 / HIPAA evidence, incident response, SIEM ingest).
    • How to filter the logs in the dashboard and export the filtered view as CSV.
    • The exported column schema, filename format, and UTC RFC 3339 timestamp convention.
    • Streaming behavior, the self-audit row each export emits, and the __porter_export_failed__ truncation sentinel.
    • A curl example for scripting recurring exports against the API, including the *_exclude filter variants.
  • Added the page to the Security and Compliance group in mint.json right after Role-based access control.

Context

Upstream feature: streaming CSV export for API audit logs. The handler streams keyset-paginated batches as text/csv, self-audits the export, and writes a sentinel footer row if the stream fails mid-response — all surfaced in the docs so users know how to interpret the file and when to retry.

@mintlify
Copy link
Copy Markdown
Contributor Author

mintlify Bot commented May 26, 2026

Preview deployment for your docs. Learn more about Mintlify Previews.

Project Status Preview Updated (UTC)
porter 🟢 Ready View Preview May 26, 2026, 9:03 PM

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

0 participants