GET audit-events
GET {{baseUrl}}/api/v1/audit-events?filter=<string>&limit=<integer>&offset=<integer>&sort=<string>&select=<string>
returns the audit events
Request Params
| Key | Datatype | Required | Description |
|---|---|---|---|
filter | string | Filter criteria - e.g. state eq Failure and occurredAt gt 2020-09-08T16:51:33Z | |
limit | string | The number of results to return | |
offset | string | The number of results to skip | |
sort | string | A comma separated list of properties to sort by, followed by a direction | |
| indicator ("asc" or "desc"). If no direction indicator is specified the | |||
| default order is ascending. - e.g. state,version desc. Currently only support | |||
| sorting by 1 property per request | |||
select | string | A list of properties to include in the response. Currently only support | |
| returning of all fields. |
HEADERS
| Key | Datatype | Required | Description |
|---|---|---|---|
Accept | string |
RESPONSES
status: OK
{"items":[{"id":"\u003cstring\u003e","message":"\u003cstring\u003e","occurredAt":"\u003cstring\u003e","state":"\u003cstring\u003e","version":"\u003cinteger\u003e","associatedResource":{"id":"\u003cstring\u003e","name":"\u003cstring\u003e","type":"\u003cstring\u003e"},"code":"\u003cstring\u003e","contextId":"\u003cstring\u003e","customerId":"\u003cstring\u003e","permission":"\u003cstring\u003e","scope":"\u003cstring\u003e","source":"\u003cstring\u003e","sourceIpAddress":"\u003cstring\u003e","taskId":"\u003cstring\u003e","uniqueId":"\u003cstring\u003e","userEmail":"\u003cstring\u003e"},{"id":"\u003cstring\u003e","message":"\u003cstring\u003e","occurredAt":"\u003cstring\u003e","state":"\u003cstring\u003e","version":"\u003cinteger\u003e","associatedResource":{"id":"\u003cstring\u003e","name":"\u003cstring\u003e","type":"\u003cstring\u003e"},"code":"\u003cstring\u003e","contextId":"\u003cstring\u003e","customerId":"\u003cstring\u003e","permission":"\u003cstring\u003e","scope":"\u003cstring\u003e","source":"\u003cstring\u003e","sourceIpAddress":"\u003cstring\u003e","taskId":"\u003cstring\u003e","uniqueId":"\u003cstring\u003e","userEmail":"\u003cstring\u003e"}],"pageLimit":"\u003cinteger\u003e","pageOffset":"\u003cinteger\u003e","total":"\u003cinteger\u003e"}