JSON objects
SearchCriteria
The name, operator and value fields must be used together.
The junction and elements fields must be used together and are used to create more complex queries.
| Name | Required | Type | Default value | Description |
|---|---|---|---|---|
| name | No | String | The Event field you want to search for. Allowed values : action, certificateOrganization, context, creatorIpv4, creatorIpv6, creatorLogin, domain, state, user, zoneExample: domain | |
| operator | No | String | EQUALS | The search operator. Allowed values : EQUALS, NOT_EQUALS, EQUALS_CASE_INSENSITIVE, STARTS_WITH, ENDS_WITH, CONTAINS, IN, GREATER_THAN, LESS_THAN, GREATER_THAN_OR_EQUALS, LESS_THAN_OR_EQUALS |
| value | No | String, String[], Integer, Integer[] | The value of the name field.Examples :
| |
| junction | No | String | AND | Logical operator used with the elements field.Allowed values : AND, OR |
| elements | No | List of SearchCriteria | A list of SearchCriteria which will be used with the junction logical operator |
SearchResult
| Name | Type | Default value | Description |
|---|---|---|---|
| total | Integer | Total number of events matching the search criteria | |
| limit | Integer | 100 | Number of events returned |
| offset | Integer | 0 | Offset used |
| results | List of Event | List of events matching the search criteria |
Event
| Name | Type | Default value | Description |
|---|---|---|---|
| id | String | Event identifier | |
| date | String | 100 | Datetime of the event |
| context | String | Context of the event Possible values are :
| |
| action | String | Action of the event Possible values are :
| |
| state | String | State of the event Possible values are :
| |
| customerId | Integer | The customer identifier of the event creator | |
| creatorLogin | String | The login of the event creator | |
| creatorIpv4 | String | IPv4 of the event creator | |
| creatorIpv6 | String | IPv6 of the event creator | |
| user | String | The user targeted by the event | |
| domain | String | The domain targeted by the event | |
| zone | String | The DNS zone targeted by the event | |
| certificateOrganization | String | The certificate organization targeted by the event | |
| payload | Object | Payload data of the event |