Audit logs mAPI reference
Complete reference documentation for the Audit logs resource.
Audit logs
#Audit logs record actions taken on your Knock account.
List entries across every environment and branch, including account-level entries that have no environment. The list includes user-visible changes and environment merges. Commits are returned by the commits endpoint.
Endpoints
List audit logs
#Returns a paginated list of audit log entries for the current account, across every environment and branch, including account-level entries that have no environment. Entries are ordered from most recent first.
The list includes user-visible changes and environment merges. Commits are returned by the commits endpoint. Entries outside the account's data retention window are omitted.
Endpoint
Query parameters
The environment slug. When omitted, the list is account-wide and does not use the account's default environment. When set, limits entries to that environment or branch and omits account-level entries.
Filter by action. Accepts one action or an array of actions, matched exactly.
Filter by the id of the user who performed the action. Accepts one id or an array of ids.
Filter by resource type. Accepts one type or an array of types. channel includes channel environment settings, and source includes source environment settings.
Only return entries inserted at or after this RFC 3339 timestamp.
Only return entries inserted at or before this RFC 3339 timestamp.
The cursor to fetch entries after.
The cursor to fetch entries before.
The number of entries to fetch per-page.
Returns
A paginated list of AuditLog. Contains a list of entries and page information.
A list of entries.
The action that was performed, such as workflow.updated or seat.removed.
The Knock user who performed the action.
The email address of the user.
The unique identifier for the user.
The name of the user.
The agent session that performed the action, when the source is an agent.
The slug of the environment or branch where the action happened. Null for account-level actions.
The unique identifier for the audit log entry.
The timestamp of when the action happened.
The IP address of the request that performed the action.
The location derived from the request IP address.
The city.
The country code.
The region code.
The project the action belongs to. Null for account-level actions.
The id of the request that performed the action.
Where the action originated.
The resource the action changed. type and identifier follow the commit resource for promotable resources, including reusable_request. identifier is null when the resource has no public handle or the row no longer exists.
The stored id of the resource. External user and object ids are not UUIDs.
The public handle for the resource, such as a key, slug, email, or locale/namespace for a translation.
The type of the resource.
The information about a paginated result.
The cursor to fetch entries after. Will only be present if there are more entries to fetch.
The cursor to fetch entries before. Will only be present if there are more entries to fetch before the current page.
The number of entries to fetch per-page.
AuditLog
#An account audit log entry. Commit rows are returned by the commits endpoint. The entry does not include the stored change diff.
Attributes
The action that was performed, such as workflow.updated or seat.removed.
The Knock user who performed the action.
The email address of the user.
The unique identifier for the user.
The name of the user.
The agent session that performed the action, when the source is an agent.
The slug of the environment or branch where the action happened. Null for account-level actions.
The unique identifier for the audit log entry.
The timestamp of when the action happened.
The IP address of the request that performed the action.
The location derived from the request IP address.
The city.
The country code.
The region code.
The project the action belongs to. Null for account-level actions.
The id of the request that performed the action.
Where the action originated.
The resource the action changed. type and identifier follow the commit resource for promotable resources, including reusable_request. identifier is null when the resource has no public handle or the row no longer exists.
The stored id of the resource. External user and object ids are not UUIDs.
The public handle for the resource, such as a key, slug, email, or locale/namespace for a translation.
The type of the resource.
AuditLogActor
#The Knock user who performed the action.
Attributes
The email address of the user.
The unique identifier for the user.
The name of the user.
AuditLogResource
#The resource the action changed. type and identifier follow the commit resource for promotable resources, including reusable_request. identifier is null when the resource has no public handle or the row no longer exists.
Attributes
The stored id of the resource. External user and object ids are not UUIDs.
The public handle for the resource, such as a key, slug, email, or locale/namespace for a translation.
The type of the resource.
AuditLogLocation
#The location derived from the request IP address.
Attributes
The city.
The country code.
The region code.