Excluding Paths From Event Reports

The Excluded Paths allow excluding specific paths from appearing in Event Reports, providing more focused monitoring. It also allows you to specify a user to exclude their action within a directory from a report.

Viewing Event Reports excluded paths

To see the current list of excluded paths (empty by default), send a GET request to /settings/reports/file-event-report/excluded-paths:

get
Authorizations
AuthorizationstringRequired

Basic Authorization header

Header parameters
api-versionstringRequired
Responses
get
/settings/reports/file-event-report/excluded-paths
200

Success

Each entry has a unique ID, path, and user.

Adding Event Reports excluded paths

To add paths to the exclusion list, Send a POST request to /settings/reports/file-event-report/excluded-paths:

post
Authorizations
AuthorizationstringRequired

Basic Authorization header

Header parameters
api-versionstringRequired
Body
pathstring · min: 1Required

Path to exclude

userstring | nullableOptional

Username for which the path should be excluded from monitoring

Responses
post
/settings/reports/file-event-report/excluded-paths

Make sure to include the absolute path and an associated user in the body of your request, for example:

To exclude the path for all users, leave the user key empty or set it to null.

Deleting Event Reports excluded paths

To remove a path from exclusions, send a DELETE request to /settings/report/file-event-report/excluded-paths/{id}:

delete
Authorizations
AuthorizationstringRequired

Basic Authorization header

Path parameters
idstring · uuidRequired
Header parameters
api-versionstringRequired
Responses
204

No Content

No content

delete
/settings/reports/file-event-report/excluded-paths/{id}

No content

Tip. You can get the ID of a path using a GET request to the same endpoint.

Last updated