Skip to main content
Version: GuardMode 2023.2

Configuring Event Reports

See also.

Event Reports configuration uses GuardMode Agent's REST API. For a full list of available commands, see REST API documentation.

Configuring Event Reports is available through the Agent’s REST API (accessible from http://localhost:5000/swagger).

Viewing Event Reports configuration​

To view the current Event Reports configuration, send a GET request to /settings/reports/file-event-report:

GET "/settings/reports/file-event-report"

By default, Event Reports use the following settings:

  • enabled: false
  • Time zone: UTC
  • Reporting time: 08:00 AM

Listing time zones​

To get the list of available time zones, send a GET request to /settings/reports/file-event-report/timezones.

GET "/settings/reports/file-event-report/timezones"

Listed time zones include offset, which accounts for daylight saving time.

Modifying Event Reports configuration​

You can enable Event Reports and set the time zone using a PUT request to /settings/reports/file-event-report:

PUT "/settings/reports/file-event-report"

For example, to enable Event Reports and set the time zone to Europe/Warsaw:

{
    "enabled": true,
    "timeZone": "Europe/Warsaw",
}

Adding Event Reports reporting hours​

To add new Event Reports reporting time, send a POST request to /settings/reports/file-event-report/hours with the time in HH:MM:SS format.

POST "/settings/reports/file-event-report/hours"

For example, to add 8 AM and noon as reporting hours:

{
    "enabled": true,
    "timeZone": "Europe/Warsaw",
    "scheduledHours": [
        "08:00:00",
        "12:00:00"
    ]
}

Deleting Event Reports reporting hours​

You can remove reporting hours using a DELETE request to /settings/reports/file-event-report/hours with the time you want to remove in HH:MM:SS format.

DELETE "/settings/reports/file-event-report/hours"
Tip.

Event Reports require at least one reporting hour to work. Trying to remove the only remaining reporting hour will result in an error.

For example, to remove 8 AM from the reporting hours:

{
    "enabled": true,
    "timeZone": "Europe/Warsaw",
    "scheduledHours": [
        "08:00:00",
    ]
}