Skip to content

Document the audit log export API endpoint #2765

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
Pierrci wants to merge 4 commits into
base: main
Choose a base branch
from
Open

Document the audit log export API endpoint #2765

Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
16b3fe2
Document the audit log export API endpoint
Pierrci Sep 5, 2026
650e525
Link to OpenAPI reference from audit log export docs
Pierrci Sep 5, 2026
15d1475
Use full deep link to OpenAPI endpoint reference
Pierrci Sep 5, 2026
b98f759
Fix: replace markdown link with HTML anchor
alexpouliquen Sep 7, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
12 changes: 12 additions & 0 deletions docs/hub/audit-logs.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -30,6 +30,18 @@ Audit Logs are accessible through your organization settings. Each log entry inc

You can also download the complete audit log as a JSON file for further analysis.

### Export via API

Programmatic export is available at:

```
GET https://huggingface.co/api/organizations/{org}/audit-log/export
```

Authenticate with a user access token or service-account token that has the **Export the audit log** permission (`org.auditLog.write`) for the organization. The response is a JSON array of log entries, identical to the file downloaded from the settings page. Like the manual export, the API call is recorded as `org.audit_log.export`.

The endpoint is also documented in the <a href="https://huggingface.co/spaces/huggingface/openapi#tag/orgs/GET/api/organizations/%7Bname%7D/audit-log/export">OpenAPI reference</a>.

## What Events Are Tracked?

Each action has an **event name** in `scope.action` format (e.g. `repo.create`, `collection.delete`). This is the `type` field in each log entry and in the exported JSON—use it when searching or filtering logs.
Expand Down
Loading