Events

List events

get/events

List events.

Request
query Parameters
cursor
string <byte>

An encoded value used to retrieve the next set of results for a query that returns more than limit results.

from
required
string

The start time of the query about the events in the format of RFC3339 timestamps.

Example: from=2021-01-01T10:00:00Z
hasError
boolean
Default: false

If true, return only events containing errors. If false, return only events not containing errors.

Example: hasError=true
limit
integer <= 30
Default: 30

The maximum number of records to return.

provider
string

Cloud provider. If this parameter is not provided, the query will return events for all cloud providers.

Enum: "aws" "azure" "gcp"
sort
string
Default: "time:desc"

The attribute to sort the responded objects with the specified order, asc or desc. Supported attributes: time. If this parameter is not provided, the query will sort events by time in descending order. If the order part is not provided, e.g. time, the events will be sorted in ascending order.

Example: sort=time:desc
storage
string

Cloud storage. If this parameter is not provided, the query will return events for all cloud storages.

to
required
string

The end time of the query about the events in the format of RFC3339 timestamps.

Example: to=2021-01-02T10:00:00Z
type
string

The type of the event. If this parameter is not provided, the query will return events of all types.

Value: "scan"
header Parameters
Api-Version
required
any

API version.

Example: v1
Responses
200

OK

400

Bad Request

401

Unauthorized

403

Forbidden

429

Too Many Requests

500

Internal Server Error

503

Service Unavailable

Response samples
application/json
{
  • "events": [
    ],
  • "next": "dGhpcyB2YWx1ZSBpcyBvcGFxdWUsIGRlY29kaW5nIGl0IHdvbid0IGJlIHVzZWZ1bAo="
}