v1

latestOpenAPI 3.0.12026-07-243686491.1 MB

Audit Log

Retrieve single audit event by id

Required scope: audit-log:read

get/api/v1/auditlog/events/{eventId}

Path parameters

eventIdstring required

The id of the event to retrieve

Response

The requested event

idstring required

A unique identifier used for single retrieval and paging

timestampstring date-time required

The time (UTC) the action was taken

operatorIdinteger required

The operator under which the action was taken

userobject required

User details (at the time of the event) of the user that performed the action

teamIdinteger nullable

The team under which the action was taken, if any

actionstring required

The action (verb) that was performed, like CREATE, UPDATE, DELETE

entityIdstring required

The ID of the entity (subject) that the event applies to

entityTypestring required

The type of the entity (subject) that the event applies to, like Operator, Team, OperatorUser, TeamMember

metadataobject required

Additional data + context for the action taken

Example response

{
  "id": "MTcwNjYyMTcwMDEyM3xfTVF0eG8wQjVXRnNEN194ZC1uaw==",
  "timestamp": "2024-02-22T18:01:26.242Z",
  "operatorId": 1,
  "teamId": 1,
  "action": "UPDATE",
  "entityId": "1",
  "entityType": "Team"
}