Skip to main content

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-log

Lists entries, newest first. All filters are optional.

Query parameters​

entity_typestringoptional
Only entries about this kind of item, such as alert, camera, user or workflow. See List entity types.
entity_idstringoptional
Only entries about this item. Use it with entity_type.
actor_emailstringoptional
Only entries by this user. Not case-sensitive.
sincestringoptional
Only entries at or after this time, in ISO 8601.
untilstringoptional
Only entries at or before this time, in ISO 8601.
limitintegeroptional
The most entries to return, from 1 to 1000. Defaults to 100.
offsetintegeroptional
How many entries to skip, for paging. Defaults to 0.

Response fields​

An array of entries:

idintegeroptional
The entry ID.
actor_user_idinteger or nulloptional
The user who acted, or null for a failed sign-in.
actor_emailstringoptional
The user's email, or the email typed at a failed sign-in.
actionstringoptional
What 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_typestringoptional
The kind of item.
entity_idstringoptional
The item's ID, or empty.
detailobject or nulloptional
Details of the change, such as old and new values, a note or the client address.
created_atstringoptional
When it happened.

Responses​

200
The entries.
401
You are not signed in.
403
You are not an admin.

List actors​

GET/audit-log/actors

Lists 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-types

Lists 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?
On this page
Talk to our teamQuestions about licensing or sizing VoisX Argus for your site? We can help.Book a site assessment →