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

Authorizations

basic

AuthorizationstringRequired

Basic Authorization header

Header parameters

api-versionstringRequired

Responses

200

Success

text/plainapplication/jsontext/json

get

/settings/reports/file-event-report

HTTPcURLJavaScriptPython

GET /settings/reports/file-event-report HTTP/1.1
Host: 
Authorization: Basic username:password
api-version: text
Accept: */*

200

Success

{
  "enabled": true,
  "timeZone": "text",
  "scheduledHours": [
    "12:04:10"
  ]
}

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

Authorizations

basic

AuthorizationstringRequired

Basic Authorization header

Header parameters

api-versionstringRequired

Responses

200

Success

text/plainapplication/jsontext/json

get

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

HTTPcURLJavaScriptPython

GET /settings/reports/file-event-report/timezones HTTP/1.1
Host: 
Authorization: Basic username:password
api-version: text
Accept: */*

200

Success

[
  {
    "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

Authorizations

basic

AuthorizationstringRequired

Basic Authorization header

Header parameters

api-versionstringRequired

Body

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

enabledbooleanRequired

timeZonestring · min: 1Required

Responses

200

Success

text/plainapplication/jsontext/json

400

Bad Request

text/plainapplication/jsontext/json

put

/settings/reports/file-event-report

HTTPcURLJavaScriptPython

PUT /settings/reports/file-event-report HTTP/1.1
Host: 
Authorization: Basic username:password
api-version: text
Content-Type: application/json-patch+json
Accept: */*
Content-Length: 34

{
  "enabled": true,
  "timeZone": "text"
}

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

{
  "enabled": true,
  "timeZone": "text",
  "scheduledHours": [
    "12:04:10"
  ]
}

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

Authorizations

basic

AuthorizationstringRequired

Basic Authorization header

Header parameters

api-versionstringRequired

Body

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

hourstring · timeRequired

Responses

200

Success

text/plainapplication/jsontext/json

400

Bad Request

text/plainapplication/jsontext/json

409

Conflict

text/plainapplication/jsontext/json

post

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

HTTPcURLJavaScriptPython

POST /settings/reports/file-event-report/hours HTTP/1.1
Host: 
Authorization: Basic username:password
api-version: text
Content-Type: application/json-patch+json
Accept: */*
Content-Length: 19

{
  "hour": "12:04:10"
}

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

{
  "enabled": true,
  "timeZone": "text",
  "scheduledHours": [
    "12:04:10"
  ]
}

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

Authorizations

basic

AuthorizationstringRequired

Basic Authorization header

Query parameters

hourstring · timeOptional

Header parameters

api-versionstringRequired

Responses

200

Success

text/plainapplication/jsontext/json

400

Bad Request

text/plainapplication/jsontext/json

422

Client Error

text/plainapplication/jsontext/json

delete

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

HTTPcURLJavaScriptPython

DELETE /settings/reports/file-event-report/hours HTTP/1.1
Host: 
Authorization: Basic username:password
api-version: text
Accept: */*

{
  "enabled": true,
  "timeZone": "text",
  "scheduledHours": [
    "12:04:10"
  ]
}

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