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

Header parameters

Response

200

Success

Body

text/plainapplication/jsontext/json

enabled*boolean

timeZone*string

scheduledHours*array of string (time)

Request

JavaScriptCurlPython

const response = await fetch('/settings/reports/file-event-report', {
    method: 'GET',
    headers: {
      "api-version": "text"
    },
});
const data = await response.json();

Response

200

{
  "enabled": false,
  "timeZone": "text",
  "scheduledHours": [
    "text"
  ]
}

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

Header parameters

Response

200

Success

Body

text/plainapplication/jsontext/json

id*string

offset*string (date-span)

Request

JavaScriptCurlPython

const response = await fetch('/settings/reports/file-event-report/timezones', {
    method: 'GET',
    headers: {
      "api-version": "text"
    },
});
const data = await response.json();

Response

200

[
  {
    "id": "text",
    "offset": "text"
  }
]

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

Header parameters

Body

application/json-patch+jsonapplication/jsontext/jsonapplication/*+json

enabled*boolean

timeZone*string

Response

200400

Success

Body

text/plainapplication/jsontext/json

enabled*boolean

timeZone*string

scheduledHours*array of string (time)

Request

JavaScriptCurlPython

const response = await fetch('/settings/reports/file-event-report', {
    method: 'PUT',
    headers: {
      "api-version": "text",
      "Content-Type": "application/json-patch+json"
    },
    body: JSON.stringify({
      "enabled": false,
      "timeZone": "text"
    }),
});
const data = await response.json();

Response

200400

{
  "enabled": false,
  "timeZone": "text",
  "scheduledHours": [
    "text"
  ]
}

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

Header parameters

Body

application/json-patch+jsonapplication/jsontext/jsonapplication/*+json

hour*string (time)

Response

200400409

Success

Body

text/plainapplication/jsontext/json

enabled*boolean

timeZone*string

scheduledHours*array of string (time)

Request

JavaScriptCurlPython

const response = await fetch('/settings/reports/file-event-report/hours', {
    method: 'POST',
    headers: {
      "api-version": "text",
      "Content-Type": "application/json-patch+json"
    },
    body: JSON.stringify({
      "hour": "text"
    }),
});
const data = await response.json();

Response

200400409

{
  "enabled": false,
  "timeZone": "text",
  "scheduledHours": [
    "text"
  ]
}

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

Query parameters

Header parameters

Response

200400422

Success

Body

text/plainapplication/jsontext/json

enabled*boolean

timeZone*string

scheduledHours*array of string (time)

Request

JavaScriptCurlPython

const response = await fetch('/settings/reports/file-event-report/hours', {
    method: 'DELETE',
    headers: {
      "api-version": "text"
    },
});
const data = await response.json();

Response

200400422

{
  "enabled": false,
  "timeZone": "text",
  "scheduledHours": [
    "text"
  ]
}

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",
    ]
}