MOmonta
Audit Log

Retrieve single audit event by id

Changed on

Required scope: audit-log:read

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

Request

  • Base URL
    https://partner-api.monta.com
  • URL
    https://partner-api.monta.com/api/v1/auditlog/events/{eventId}
  • Auth
    HTTP bearer

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, TRIGGER

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

operationstring nullable

The specific command that was issued, for actions that carry one (like TRIGGER). Values are open-ended, like REBOOT, UNLOCK, SYNC, FIRMWARE_UPDATE.

Example response

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

Changes

  • 0ca400461c52Revision changes
    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status