SFTPGo Octri Preview
GET/events/fs

Get filesystem events

Returns filesystem events (uploads, downloads, deletes, etc.) matching the specified filters. Requires the "eventsearcher" plugin to be configured. Supports cursor-based pagination via the from_id parameter

17 parameters
start_timestampintegeroptional
the event timestamp, unix timestamp in nanoseconds, must be greater than or equal to the specified one. 0 or missing means omit this filter
Default:0
end_timestampintegeroptional
the event timestamp, unix timestamp in nanoseconds, must be less than or equal to the specified one. 0 or missing means omit this filter
Default:0
actionsarray<string>optional
the event action must be included among those specified. Empty or missing means omit this filter. Actions must be specified comma separated
usernamestringoptional
the event username must be the same as the one specified. Empty or missing means omit this filter
ipstringoptional
the event IP must be the same as the one specified. Empty or missing means omit this filter
ssh_cmdstringoptional
the event SSH command must be the same as the one specified. Empty or missing means omit this filter
fs_providerintegeroptional
the event filesystem provider must be the same as the one specified. Empty or missing means omit this filter
Allowed:01234567
bucketstringoptional
the bucket must be the same as the one specified. Empty or missing means omit this filter
endpointstringoptional
the endpoint must be the same as the one specified. Empty or missing means omit this filter
protocolsarray<string>optional
the event protocol must be included among those specified. Empty or missing means omit this filter. Values must be specified comma separated
statusesarray<integer>optional
the event status must be included among those specified. Empty or missing means omit this filter. Values must be specified comma separated
instance_idsarray<string>optional
the event instance id must be included among those specified. Empty or missing means omit this filter. Values must be specified comma separated
from_idstringoptional
the event id to start from. This is useful for cursor based pagination. Empty or missing means omit this filter.
rolestringoptional
User role. Empty or missing means omit this filter. Ignored if the admin has a role
csv_exportbooleanoptional
If enabled, events are exported as a CSV file
Default:false
limitintegeroptional
The maximum number of items to return. Max value is 1000, default is 100
Default:100
orderstringoptional
Ordering events by timestamp. Default DESC
Allowed:ASCDESC

6 status codes
200successful operation
actionstringoptional
Allowed:downloaduploadfirst-uploadfirst-downloaddeleterenamemkdirrmdirssh_cmd
bucketstringoptional
elapsedintegeroptional
elapsed time as milliseconds
endpointstringoptional
external_usernamestringoptional
external username, e.g. the email of a user who accessed a public share with email authentication
file_sizeintegeroptional
fs_pathstringoptional
fs_providerintegeroptional
Storage backends: the `FsProviders` values that configure an actual filesystem. See `FsProviders` for the meaning of each value.
Allowed:01234567
fs_target_pathstringoptional
idstringoptional
instance_idstringoptional
ipstringoptional
open_flagsstringoptional
protocolstringoptional
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
Allowed:SSHSFTPSCPFTPDAVHTTPHTTPShareDataRetentionEventActionOIDC
rolestringoptional
session_idstringoptional
ssh_cmdstringoptional
statusintegeroptional
Event status: * `1` - no error * `2` - generic error * `3` - quota exceeded error
Allowed:123
timestampintegeroptional
unix timestamp in nanoseconds
usernamestringoptional
virtual_pathstringoptional
virtual_target_pathstringoptional
400Bad Request
errorstringoptional
error description if any
messagestringoptional
message, can be empty
401Unauthorized
errorstringoptional
error description if any
messagestringoptional
message, can be empty
403Forbidden
errorstringoptional
error description if any
messagestringoptional
message, can be empty
500Internal Server Error
errorstringoptional
error description if any
messagestringoptional
message, can be empty
defaultUnexpected Error
errorstringoptional
error description if any
messagestringoptional
message, can be empty

Error handling

A 400 is returned: Bad Request. A 401 is returned: Unauthorized. A 403 is returned: Forbidden. A 500 is returned: Internal Server Error. Any other status is an error: Unexpected Error.