Fixes #CS-1453 - Add Audit log REST API#876
Merged
Merged
Conversation
Add the REST-API reference page for the new audit-log feature so the
endpoint shows up under 'Administration via REST API' next to the other
admin endpoints (calendar, checklist, generic-cti, group, role, ...).
The new endpoint is read-only:
GET /api/v1/audit_logs
GET /api/v1/audit_logs/{id}
GET /api/v1/audit_logs/search
POST /api/v1/audit_logs/search
Required permission: admin.audit_log.
Examples (request payloads and JSON responses) are taken straight from
the model, the migration, the route definition, the controller
(reads/writes via model_index_render / model_show_render /
model_search_render) and the request spec, and were verified end-to-end
against a running zammad:develop instance (10 real entries; sort_by /
order_by / with_total_count behaviour confirmed).
Field reference covers every column on audit_logs (user_id /
user_fullname, action_type, auditable_id / auditable_type /
auditable_name, value_from / value_to, source_ip, preferences,
created_at / updated_at) and the lifecycle note documents the
12-month retention enforced by the 'Clean up AuditLog' scheduler.
Files:
- api/audit_log.rst: new (256 lines).
- index.rst: register /api/audit_log under the REST API toctree.
Refs zammad/zammad#CS-1453
ArtifactsProduced during runtime |
rolfschmidt
approved these changes
Jul 23, 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
2 participants
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.
No description provided.