Publish the audit-logs API endpoint
- Dominant language
- Python
- Stars
- 44.8k
- Forks
- 4.9k
- Avg merge
- 21h 10m
- Merged PRs (30d)
- 635
Description
The `GET /api/0/organizations/{org_slug}/audit-logs/` endpoint exists and is functional, but is currently marked as `ApiPublishStatus.EXPERIMENTAL` and is not publicly documented.
## Current behavior
- It is not listed in the public API docs, so customers cannot discover it without internal guidance (or by sniffing network requests within in-product audit-logs view).
## Gap
Enterprise prospects with security compliance requirements need to consume management plane audit logs into their own SIEM/monitoring systems. Without public documentation, sales and security teams must field these questions ad-hoc, and customers cannot self-serve integration work.
This has come up in active procurement/legal review where a prospect specifically asked about API access to audit logs.
## Suggested scope
- Promote the endpoint from `EXPERIMENTAL` to `PUBLIC`.
- Add it to the public API documentation on `docs.sentry.io`.
- Document supported query parameters and response schema.
Action taken on behalf of Neil Manvar.
Contributor guide
Research direction
Start by locating the existing GET /api/0/organizations/{org_slug}/audit-logs/ endpoint and its ApiPublishStatus setting, then find how public API documentation is organized on docs.sentry.io. Confirm the supported query parameters and response schema from the implementation. Done means the endpoint is marked PUBLIC and its usage and schema are discoverable in the public API docs.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- python
- Domain
- api, documentation
- Issue type
- Feature
- Difficulty
- 4/5
- Estimated time
- 3-5 days
- Activity status
- Active
- Clarity
- Mostly clear
- Newbie friendliness
- 64/100