Document the audit log export API endpoint - #2765
Open
Pierrci wants to merge 4 commits into
Open
Conversation
Co-Authored-By: Claude Code (GLM-5.3-Flash) <noreply@anthropic.com>
|
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. |
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
marked this pull request as ready for review
September 5, 2026 00:26
Pierrci
requested review from
Charlie-Boyer,
Muhammadsaeed707 and
alexpouliquen
September 5, 2026 00:26
alexpouliquen
approved these changes
Sep 7, 2026
Charlie-Boyer
approved these changes
Sep 7, 2026
Muhammadsaeed707
approved these changes
Sep 8, 2026
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
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 theorg.auditLog.writetoken permission) but was undocumented.Changes
org.auditLog.write, user or service-account token), JSON response, and note that the API call is itself logged asorg.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 viaGET /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 asorg.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.