latestOpenAPI 3.1.02026-08-2284340459.3 KB

cd4c91e0e6c2

Audit Events

List Audit Events

Authorization scope: audit:list

List audit events

get/v1/accounts/{account_id}/environments/{environment_id}/audit_events

Path parameters

account_idstring required

environment_idstring required

Query parameters

start_timestring date-time nullable

The start UTC date time. Time format YYYY-MM-DDTHH:MM:SS or YYYY-MM-DDTHH:MM:SS.mmmmmm

Example:2020-01-01T12:00:00

The start UTC date time. Time format YYYY-MM-DDTHH:MM:SS or YYYY-MM-DDTHH:MM:SS.mmmmmm

end_timestring date-time nullable

The end UTC date time. Time format YYYY-MM-DDTHH:MM:SS or YYYY-MM-DDTHH:MM:SS.mmmmmm If end_time is supplied without start_time the start_time will be the previous day of the end_time

Example:2020-01-01T12:00:00

The end UTC date time. Time format YYYY-MM-DDTHH:MM:SS or YYYY-MM-DDTHH:MM:SS.mmmmmm If end_time is supplied without start_time the start_time will be the previous day of the end_time

user_idstring[] nullable

A list of users id's who initiated the event

event_typeAuditEventTypeEnum[] nullable

A list of entity types

entity_typeAuditEntityTypeEnum[] nullable

A list of event types

entity_logical_keystring nullable

A unique logical identifier of an entity, usually the cross_id

Example:5eda28ee6b028e1ce7a2b5ec

A unique logical identifier of an entity, usually the cross_id

Response

Successful Response

next_pagestring nullable

The next page URL

previous_pagestring nullable

The previous page URL

Example response

{
  "items": [
    {
      "event_id": "eac285a5a9ae4ada9ccd49889a651e16",
      "event_initiator": "UI",
      "event_datetime": "2022-08-02T13:38:44.054000",
      "event_result_status": 200,
      "event_name": "update:rivers:without_version",
      "entity_logical_key": "5eda28ee6b028e1ce7a2b5ec",
      "account_id": "5ebec4ca6b028e2da4191dde",
      "environment_id": "5ebec4ca6b028e2da4191de1",
      "user_id": "60d08931f5682c0d9fa24890",
      "user_name": "Rivi Ee",
      "entity_name": "My First River",
      "entity_subtype": "src_to_trgt",
      "additional_info": "{\"version_id\": \"637582d3c32287000fc1d69f\"}"
    }
  ]
}