Get Logs v3.2

Last Update

07/27/2021

Authentication

YES

HTTP Method

POST

Content Type

application/json

Rate limited

YES

Requests per rate limit

10/min

Response Format

JSON

Changes

Changes compared with v3.1

• Removed “page” parameter

• Added “token” parameter

• Support new event_category: device_report

access_token

string

URL

Yes

access token which archived from OAuth authentication step

event_category

string

Body

Yes

Specify what event logs you want to retrieve.

Possible values can be:

• device: Device event logs

• admin: Admin event logs

• webhook: webhook's event logs

• device_report_:_ Device report event log

limit

int

Body

Optional

Specify a maximum number of event logs will be returned in the response. The value should be in [1,100]. If there are more event logs than what the limit asks for, HTTP code in a response will be 406. Event logs in the response are sorted by timestamp.

20

token

string

Body

Optional

Specify a pagination token that event logs will be returned in. It can be used to return the next set of items in the list.

age

int

Body

Optional

Specify age of the information in seconds. Maximum value is 86400 (1 day)

For example: if you want to query event logs in last 5 minutes, you need set the "age" parameter to 300.

3600

start_time

long

Body

Optional

Specify a start time of the query's duration. The format should be Unix epoch time in milliseconds

end_time

long

Body

Optional

Specify an end time of the query's duration. The format should be Unix epoch time in milliseconds

filter

object

Body

Optional

Specify filter criteria

(does not apply to device_report event_category)

filter.events

string

Body

Optional

Specify which events you want to retrieve.

Values for admin event logs (event_category = admin) can be:

• cac_change: an admin changed configuration for Secure Access module

• config: an admin changed configuration

• failed_auth: an admin failed authenticate with OPSWAT SSO.

• login: an admin logged into MetaAccess console

• rev_mobile_code: an admin revoked a registration code

• submit_ticket: an admin summited a support ticket to OPSWAT through MetaAccess console

• whitelist: an admin updated allowlist settings for CVEs

Values for device event logs (event_category=device) can be:

• access_granted: a device was granted temporary access to a protected app

• access_revoked: a device was revoked a temporary access to a protected app

• added: a device was enrolled to an account

• added_duplicate_mac: a device was enrolled to an account with a duplicated MAC address.

• compliance_check: an admin performed an on-demand compliance check on the device

• compliant: a device was considered as COMPLIANT

• deleted: a device was deleted by an admin

• deleted_user: OPSWAT Client was uninstalled by a local user on a device

• exempt_all: an admin exempted a device

• fetch_log: an admin fetched the OPSWAT Client's log remotely

• noncompliant: a device was considered as NON-COMPLIANT

• scan_threat: an admin requested an on-demand malware scan on a device

• unexempt: an admin unexempted a device

• unseen: a device was deleted by Lost Devices feature

Values for category webhook can be:

• added: a device was enrolled to an account

• deleted: a device was deleted

• status_changed_to_compliant: a device was considered as COMPLIANT

• status_changed_to_exempted: a device was exempted

• status_changed_to_non_compliant: a device was considered as NON-COMPLIANT

filter.agent_types

array<int>

Body

Optional

Only valid for device event logs (event_category = device).

To filter event logs by an agent type.

Values can be:

• 0: OPSWAT Client

• 2: OPSWAT Domain Controller Client

filter.search

string

Body

Optional

Only valid for device event logs (event_category = device or event_category=device_report) or webhook event logs (event_category = webhook)

Search by device name, device id.

data

array<object>

Admin event logs

data.timestamp

string

timestamp when the event occurs

data.event

string

Event text

data.details

string

Event details

data.admin_name

string

Name of an admin who is related to the event

data.admin_email

string

Email of an admin who is related to the event

token

string

A pagination token

data

array<object>

Device event logs

data.timestamp

string

timestamp when the event occurs

data.event

string

Event text

data.details

string

Event details

data.device_id

string

Device id of a device that the event occurred on

data.device_name

string

Device name that the event occurred on

data.device_username

string

User logged-in ID who logged into a device when the event occurred

data.device_group

string

A device's group name

token

string

A pagination token

data

array<object>

Webhook event logs

data.timestamp

string

timestamp when the event log occurs

data.event

string

Event text

data.details

string

Event details

data.device_id

string

Device id of a device that the event occurred on

data.device_name

string

Device name that the event occurred on

data.response_code

string

Response code from a webhoook API

data.response_body

string

Response body from a webhoook API

token

string

A pagination token

v3.1

Get Logs v3.1

v3.0

Get Logs v3.0

v2.0

Get Logs v2.0