Audit log
The audit log records who did what on the site: sign-ins, failed sign-ins and sign-outs, user and role changes, password changes and resets, alert triage, and changes to cameras, zones, detection profiles, workflows, event types, notification channels, organizations, edge nodes and retention. See Audit log.
Entries never contain passwords, camera credentials or notification channel secrets. A failed sign-in is recorded the same way whether or not the email has an account.
Every endpoint on this page needs the admin role.
List entries
GET
/audit-logLists entries, newest first. All filters are optional.
Query parameters
entity_typestringoptionalOnly entries about this kind of item, such as
alert, camera, user or workflow. See List entity types.entity_idstringoptionalOnly entries about this item. Use it with
entity_type.actor_emailstringoptionalOnly entries by this user. Not case-sensitive.
sincestringoptionalOnly entries at or after this time, in ISO 8601.
untilstringoptionalOnly entries at or before this time, in ISO 8601.
limitintegeroptionalThe most entries to return, from
1 to 1000. Defaults to 100.offsetintegeroptionalHow many entries to skip, for paging. Defaults to
0.Response fields
An array of entries:
idintegeroptionalThe entry ID.
actor_user_idinteger or nulloptionalThe user who acted, or
null for a failed sign-in.actor_emailstringoptionalThe user's email, or the email typed at a failed sign-in.
actionstringoptionalWhat happened, such as
login_succeeded, login_failed, logout, user_created, user_role_changed, user_deactivated, user_sessions_revoked, password_changed, alert_acknowledged, alert_resolved, alert_reopened, camera_updated, zone_created or workflow_deleted.entity_typestringoptionalThe kind of item.
entity_idstringoptionalThe item's ID, or empty.
detailobject or nulloptionalDetails of the change, such as old and new values, a note or the client address.
created_atstringoptionalWhen it happened.
Responses
200
The entries.
401
You are not signed in.
403
You are not an admin.
List actors
GET
/audit-log/actorsLists every email that appears as an actor in the log, sorted. Use it to fill a filter.
Responses
200
An array of email addresses.
403
You are not an admin.
List entity types
GET
/audit-log/entity-typesLists every entity type that appears in the log, sorted.
Responses
200
An array of entity types.
403
You are not an admin.
Was this page helpful?