Skip to content

Document the audit log export API endpoint - #2765

Open
Pierrci wants to merge 4 commits into
mainfrom
audit-log-api-export
Open

Document the audit log export API endpoint#2765
Pierrci wants to merge 4 commits into
mainfrom
audit-log-api-export

Conversation

@Pierrci

@Pierrci Pierrci commented Sep 5, 2026

Copy link
Copy Markdown
Member

Context

Adds a subsection to the Audit Logs doc under Accessing Audit Logs documenting the programmatic export endpoint GET /api/organizations/{org}/audit-log/export — it exists (requires a paid plan and the org.auditLog.write token permission) but was undocumented.

Changes

  • New Export via API subsection: endpoint URL, required permission (org.auditLog.write, user or service-account token), JSON response, and note that the API call is itself logged as org.audit_log.export.

Note

Generated with Claude Code (GLM-5.3-Flash) acting for @Pierrci.


Note

Low Risk
Documentation-only change with no runtime or security behavior impact.

Overview
Adds an Export via API subsection under Accessing Audit Logs in docs/hub/audit-logs.md, describing programmatic export via GET /api/organizations/{org}/audit-log/export.

The new text covers authentication (user or service-account token with org.auditLog.write), that the response matches the settings-page JSON download, that exports are logged as org.audit_log.export, and links to the OpenAPI reference for the same route.

Reviewed by Cursor Bugbot for commit b98f759. Bugbot is set up for automated code reviews on this repo. Configure here.

Co-Authored-By: Claude Code (GLM-5.3-Flash) <noreply@anthropic.com>
@HuggingFaceDocBuilderDev

Copy link
Copy Markdown

The docs for this PR live here. All of your documentation changes will be reflected on that endpoint. The docs are available until 30 days after the last update.

Pierrci and others added 2 commits September 4, 2026 20:23
Co-Authored-By: Claude Code (GLM-5.3-Flash) <noreply@anthropic.com>
Co-Authored-By: Claude Code (GLM-5.3-Flash) <noreply@anthropic.com>
@Pierrci
Pierrci marked this pull request as ready for review September 5, 2026 00:26
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.

5 participants