audit

list audit logs (requires admin privilege)

Changed on
get/w/{workspace}/audit/list

Request

  • Base URL: /api (relative, and the document was published on a file host, not at the API’s origin)
  • URL: /api/w/{workspace}/audit/list
  • Auth: one of:
    • HTTP bearer
    • API key in cookie token

Path parameters

workspacestring required

Query parameters

pageinteger

which page to return (start at 1, default 1)

per_pageinteger

number of items to return for a given page (default 30, max 100)

beforestring date-time

filter on started before (inclusive) timestamp

afterstring date-time

filter on created after (exclusive) timestamp

usernamestring

filter on exact username of user

operationstring

filter on exact or prefix name of operation

operationsstring

comma separated list of exact operations to include

exclude_operationsstring

comma separated list of operations to exclude

resourcestring

filter on exact or prefix name of resource

action_kind'Create' | 'Update' | 'Delete' | 'Execute'

filter on type of operation

before_idinteger

only return logs with an id strictly lower than this one. Logs are ordered by descending id, so this is a keyset cursor to stream a page in several batches without paying a growing offset.

all_workspacesboolean

get audit logs for all workspaces

Response

a list of audit logs

workspace_idstring required
idinteger required
timestampstring date-time required
usernamestring required
operation'jobs.run' | 'jobs.run.script' | 'jobs.run.preview' | 'jobs.run.flow' | 'jobs.run.flow_preview' | 'jobs.run.script_hub' | 'jobs.run.dependencies' | 'jobs.run.identity' | 'jobs.run.noop' | 'jobs.flow_dependencies' | 'jobs' | 'jobs.cancel' | 'jobs.force_cancel' | 'jobs.run_now' | 'jobs.disapproval' | 'jobs.delete' | 'account.delete' | 'ai.request' | 'resources.create' | 'resources.update' | 'resources.delete' | 'resource_types.create' | 'resource_types.update' | 'resource_types.delete' | 'resource_types.sync' | 'schedule.create' | 'schedule.setenabled' | 'schedule.edit' | 'schedule.delete' | 'scripts.create' | 'scripts.update' | 'scripts.archive' | 'scripts.delete' | 'users.create' | 'users.delete' | 'users.update' | 'users.login' | 'users.login_failure' | 'users.logout' | 'users.accept_invite' | 'users.decline_invite' | 'users.token.create' | 'users.token.delete' | 'users.add_to_workspace' | 'users.add_global' | 'users.setpassword' | 'users.impersonate' | 'users.leave_workspace' | 'oauth.login' | 'oauth.login_failure' | 'oauth.signup' | 'variables.create' | 'variables.delete' | 'variables.update' | 'flows.create' | 'flows.update' | 'flows.delete' | 'flows.archive' | 'apps.create' | 'apps.update' | 'apps.delete' | 'folder.create' | 'folder.update' | 'folder.delete' | 'folder.add_owner' | 'folder.remove_owner' | 'group.create' | 'group.delete' | 'group.edit' | 'group.adduser' | 'group.removeuser' | 'igroup.create' | 'igroup.delete' | 'igroup.adduser' | 'igroup.removeuser' | 'instance_groups.jit_adduser' | 'instance_groups.jit_removeuser' | 'variables.decrypt_secret' | 'workspaces.read_encryption_key' | 'workspaces.edit_command_script' | 'workspaces.edit_deploy_to' | 'workspaces.edit_auto_invite_domain' | 'workspaces.edit_webhook' | 'workspaces.edit_copilot_config' | 'workspaces.edit_error_handler' | 'workspaces.create' | 'workspaces.update' | 'workspaces.archive' | 'workspaces.unarchive' | 'workspaces.delete' required
action_kind'Created' | 'Updated' | 'Delete' | 'Execute' required
resourcestring
parametersobject
spanstring

Changes

  • b82c5a6dc1feRevision changes
    • warning

      added the new resource_types.sync enum value to the / response property for the response status

  • a5de5437b6e7Revision changes
    • warning

      added the new jobs.run_now enum value to the / response property for the response status