Audit logs

Get an audit log entry

GET https://demo.notifuse.com/api/auditLogs.get

Returns one entry by id. In workspace scope an entry of another workspace is a 404, never a leak.

Authorizations

Authorization string header required

Bearer authentication header of the form Bearer <token>, where <token> is your API key.

Query Parameters

id string required
scope string
Default workspace Options workspace, deployment
workspace_id string

Required in workspace scope.

Response

200 The entry object
log object

One recorded control-plane action. workspace_id is absent for deployment-level entries (sign-ins, the licence, the system settings).

Show 21 child attributes Hide 21 child attributes
id string
Example 8b8dd285f6874c17b5edcb39ef3e0b8b
occurred_at string<date-time>
workspace_id string
Example ws_1234567890
action string

The RPC route that performed the action, verbatim.

Example workspaces.inviteMember
category string
Example members
outcome string
Options success, failure, denied
status_code integer
Example 200
actor_type string
Options user, api_key, system, anonymous
actor_id string
actor_email string
actor_name string
actor_role string
Options owner, member, root
auth_method string
Options session, api_key, magic_code, sso, root_password
target_type string
Example invitation
target_id string
target_name string
Example bob@example.com
ip_address string
Example 203.0.113.9
user_agent string
request_id string

Echoed on every API response as X-Request-ID.

changes map<string, object>
Show 2 child attributes Hide 2 child attributes
old any

The value before the action

new any

The value after the action

metadata object
403 Not allowed object
error string required

Error message

404 No such entry in this scope object
error string required

Error message