v1

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

Get provider events

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

get/events/provider

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

actionsProviderEventAction[]

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

object_namestring

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

object_typesProviderEventObjectType[]

the event object type 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

Admin 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

omit_object_databoolean

If enabled, returned events will not contain the object_data field

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'add' | 'update' | 'delete'
usernamestring
ipstring
object_type'user' | 'folder' | 'group' | 'admin' | 'api_key' | 'share' | 'event_action' | 'event_rule' | 'role'
object_namestring
object_datastring byte

base64 of the JSON serialized object with sensitive fields removed

rolestring
instance_idstring