The Events GET API provides read access to threat events available in ePO - SaaS.
GET request URL
Use this link if your account is the US region
https://arevents.manage.trellix.com/eventservice/api/v2/events?type=incidents
Use this link if your account is the EU region
https://areventsfrk.manage.trellix.com/eventservice/api/v2/events?type=incidents
Request Parameters
You can use these parameters in the Events API request.
Parameter | Description | Parameter type | Data type | Required | Default |
|---|---|---|---|---|---|
| Trellix IAM-based access token. The token must include one of these combinations of scopes:
| Header | String | True | N/A |
| Defines the type of events or incidents requested. The allowed values are:
| Query | String | True | N/A |
| The date and time of the earliest events or incidents to return with the response. | Query | Date | False | 1970-01-01T00:00:00.000Z |
| The date and time of the latest events or incidents to return with the response. | Query | Date | False | Current date and time when query is executed. |
| Retrieving events or incidents, sorted by date and time. Values can be | Query | String | False | desc |
| The maximum number of events or incidents returned in the response. Must be an integer value between 1–1000.
| Query | Number | False | 100 |
| A link returned in the HTTP header (rel=next), providing the cursor that points to the end of the page of data that has been returned. Used to get the next results, if available. Returns a time stamp value which is base64 encoded. Decode it to get actual stamp value and use it with | Query | String | False | N/A |
* For more information about using the after parameter, see Process incidents with the after parameter.
Sample GET request URL
https://arevents.manage.trellix.com/eventservice/api/v2/events?type=incidents
Sample cURL command
curl -X GET 'https://arevents.manage.trellix.com/eventservice/api/v2/events?since=<since_date>&until=<until_date>&sort=asc&limit=10' -H 'Authorization: Bearer <Access_Token>' -H 'cache-control: no-cache'
Response codes
These codes describe success or error messages in a response to Events API. HTTP 200 — Lists all threat events generated. For a sample response code, see Response code for Events API .
Status and error codes
List of HTTP status codes returned for the query.
Code | Description |
|---|---|
200 OK | Lists all threat events generated. |
400 Bad request | The request parameters or format might be invalid. |
401 Unauthorized | Unauthorized access. |
403 Forbidden | Forbidden. |