Sign in

v1

latestOpenAPI 3.0.3AGPL-3.0-only2026-07-17120116247.0 KB
events

Get filesystem events

Returns an array with one or more filesystem events applying the specified filters. This API is only available if you configure an "eventsearcher" plugin

get/events/fs

Query parameters

start_timestampinteger

the event timestamp, unix timestamp in nanoseconds, must be greater than or equal to the specified one. 0 or missing means omit this filter

end_timestampinteger

the event timestamp, unix timestamp in nanoseconds, must be less than or equal to the specified one. 0 or missing means omit this filter

actionsFsEventAction[]

the event action must be included among those specified. Empty or missing means omit this filter. Actions must be specified comma separated

usernamestring

the event username must be the same as the one specified. Empty or missing means omit this filter

ipstring

the event IP must be the same as the one specified. Empty or missing means omit this filter

ssh_cmdstring

the event SSH command must be the same as the one specified. Empty or missing means omit this filter

fs_provider0 | 1 | 2 | 3 | 4 | 5 | 6

Filesystem providers:

  • 0 - Local filesystem
  • 1 - S3 Compatible Object Storage
  • 2 - Google Cloud Storage
  • 3 - Azure Blob Storage
  • 4 - Local filesystem encrypted
  • 5 - SFTP
  • 6 - HTTP filesystem

the event filesystem provider must be the same as the one specified. Empty or missing means omit this filter

bucketstring

the bucket must be the same as the one specified. Empty or missing means omit this filter

endpointstring

the endpoint must be the same as the one specified. Empty or missing means omit this filter

protocolsEventProtocols[]

the event protocol must be included among those specified. Empty or missing means omit this filter. Values must be specified comma separated

statusesFsEventStatus[]

the event status must be included among those specified. Empty or missing means omit this filter. Values must be specified comma separated

instance_idsstring[]

the event instance id must be included among those specified. Empty or missing means omit this filter. Values must be specified comma separated

from_idstring

the event id to start from. This is useful for cursor based pagination. Empty or missing means omit this filter.

rolestring

User role. Empty or missing means omit this filter. Ignored if the admin has a role

csv_exportboolean

If enabled, events are exported as a CSV file

limitinteger

The maximum number of items to return. Max value is 1000, default is 100

order'ASC' | 'DESC'
Example:DESC

Ordering events by timestamp. Default DESC

Response

successful operation

idstring
timestampinteger

unix timestamp in nanoseconds

action'download' | 'upload' | 'first-upload' | 'first-download' | 'delete' | 'rename' | 'mkdir' | 'rmdir' | 'ssh_cmd'
usernamestring
fs_pathstring
fs_target_pathstring
virtual_pathstring
virtual_target_pathstring
ssh_cmdstring
file_sizeinteger
elapsedinteger

elapsed time as milliseconds

status1 | 2 | 3

Event status:

  • 1 - no error
  • 2 - generic error
  • 3 - quota exceeded error
protocol'SSH' | 'SFTP' | 'SCP' | 'FTP' | 'DAV' | 'HTTP' | 'HTTPShare' | 'DataRetention' | 'EventAction' | 'OIDC'

Protocols:

  • SSH - SSH commands
  • SFTP - SFTP protocol
  • SCP - SCP protocol
  • FTP - plain FTP and FTPES/FTPS
  • DAV - WebDAV
  • HTTP - WebClient/REST API
  • HTTPShare - the event is generated in a public share
  • DataRetention - the event is generated by a data retention check
  • EventAction - the event is generated by an EventManager action
  • OIDC - OpenID Connect
ipstring
session_idstring
fs_provider0 | 1 | 2 | 3 | 4 | 5 | 6

Filesystem providers:

  • 0 - Local filesystem
  • 1 - S3 Compatible Object Storage
  • 2 - Google Cloud Storage
  • 3 - Azure Blob Storage
  • 4 - Local filesystem encrypted
  • 5 - SFTP
  • 6 - HTTP filesystem
bucketstring
endpointstring
open_flagsstring
rolestring
instance_idstring