Skip to content

Audit Log

The audit log API provides access to the server audit events. You must authenticate as an administrator to use this endpoint.

Get Audit Log

Gets the list of audit events that match filters. Output of this endpoint is paginated. The link to the next page of results is given in the response Link header. Events are sorted from newest to oldest.

GET /audit-log

Attribute Type Required Description

created_after (query) string no Include only events created after given timestamp created_before (query) string no Include only events created befor given timestamp target_type (query) string no Include only events for the given target type target_id (query) string no Include only events for the given target ID target_id (query) string no Include only events for the given autor ID per_page (query) integer no Number of results per page cursor (query) integer no Current page offset. You should get this from Link header

curl -H "Private-Token: <access token>" https://canvus.example.com/api/v1/audit-log

Export Audit Log as CSV

Exports the audit log as CSV file. Accepts the same set of filters as audit-log endpoint.

GET /audit-log

Attribute Type Required Description

created_after (query) string no Include only events created after given timestamp created_before (query) string no Include only events created befor given timestamp target_type (query) string no Include only events for the given target type target_id (query) string no Include only events for the given target ID target_id (query) string no Include only events for the given autor ID

curl -H "Private-Token: <access token>" https://canvus.example.com/api/v1/audit-log/export-csv