Skip to main content
GET
/
events
Get a page of events
curl --request GET \
  --url https://your-subdomain.alienvault.cloud/api/2.0/events \
  --header 'Authorization: Bearer <token>'
{
  "_links": {
    "self": {
      "href": "<string>",
      "templated": true
    },
    "first": {
      "href": "<string>",
      "templated": true
    },
    "last": {
      "href": "<string>",
      "templated": true
    },
    "next": {
      "href": "<string>",
      "templated": true
    },
    "prev": {
      "href": "<string>",
      "templated": true
    }
  },
  "_embedded": {
    "events": [
      {}
    ]
  },
  "page": {
    "size": 123,
    "totalElements": 123,
    "totalPages": 123,
    "number": 123
  }
}

Authorizations

​
Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Query Parameters

​
page
integer

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

​
size
integer

The number of results to return per page.

​
sort
string

The parameter and direction to sort results by.

Example:

"timestamp_occured,asc"

​
account_name
string
required

The account name.

​
suppressed
boolean

Filter events by the suppressed flag.

​
plugin
string

The plugin name.

​
event_name
string

The name of the event.

​
source_name
string

The source name.

​
sensor_uuid
string<uuid>

The UUID of the sensor.

​
source_username
string

The username of the person that triggered the event.

​
timestamp_occured_gte
integer<int64>

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

​
timestamp_occured_lte
integer<int64>

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

Response

200 - application/json

A paginated list of events.

​
_links
object
required
​
_embedded
object
required
​
page
object
required