Retrieve audit logs

GET

https://api.detected.app/api/v2/public/audit-logs

Introduction

Retrieve audit log entries across all profiles for the current account. You can optionally filter by a specific profile using the profile_id parameter.

This endpoint is paginated.

order_bystringOrder results in ascending (<code>asc</code>) or descending (<code>desc</code>) order. This parameter only works when <code>sort_by</code> is specified.

sort_bystringThe <code>sort_by</code> parameter specifies the field to sort results by. This parameter works in conjunction with <code>order_by</code>. If <code>sort_by</code> is not specified, results default to descending by <code>actioned_at</code>. Currently, we support these fields: <ol> <li><code>id</code></li> <li><code>actioned_at</code></li> <li><code>action</code></li> <li><code>performed_by</code></li> </ol>

pagestringCurrent page number

profile_idstringThe <code>profile_id</code> parameter filters audit logs to a specific profile by its UUID

actionstringThe <code>action</code> parameter filters audit logs by the action performed (e.g. <code>created</code>, <code>updated</code>, <code>viewed</code>)

performed_bystringThe <code>performed_by</code> parameter filters audit logs by the name of the user or system that performed the action

acceptstringGenerated from available response content types

AuthorizationstringBearer token

200Ok

401Unauthorized

403Forbidden

429Too Many Requests

curl --request GET \
     --url https://api.detected.app/api/v2/public/audit-logs \
     --header 'accept: application/json'