v1

latestOpenAPI 3.0.02026-07-2681914.7 KB
Events

Get a page of events

Retrieves a paginated list of events, which can be filtered by various parameters.

get/events

Query parameters

pageinteger

The page number of results to return (zero-based).

sizeinteger

The number of results to return per page.

sortstring
Example:timestamp_occured,asc

The parameter and direction to sort results by.

account_namestring required

The account name.

suppressedboolean

Filter events by the suppressed flag.

pluginstring

The plugin name.

event_namestring

The name of the event.

source_namestring

The source name.

sensor_uuidstring uuid

The UUID of the sensor.

source_usernamestring

The username of the person that triggered the event.

timestamp_occured_gteinteger

Filter for events that occurred at or after this timestamp (epoch milliseconds).

timestamp_occured_lteinteger

Filter for events that occurred at or before this timestamp (epoch milliseconds).

Response

A paginated list of events.