HookSniffAPI.Api.AuditLog (HookSniff v0.3.0)

Copy Markdown View Source

API calls for all endpoints tagged AuditLog.

Summary

Functions

audit_log_get(connection, opts \\ [])

List audit log entries

audit_log_id_get(connection, id, opts \\ [])

Get audit entry detail

Functions

audit_log_get(connection, opts \\ [])

@spec audit_log_get(
  Tesla.Env.client(),
  keyword()
) :: {:ok, nil} | {:error, Tesla.Env.t()}

List audit log entries

Parameters

  • connection (HookSniffAPI.Connection): Connection to server
  • opts (keyword): Optional parameters
    • :page (integer()):
    • :action (String.t):

Returns

  • {:ok, nil} on success
  • {:error, Tesla.Env.t} on failure

audit_log_id_get(connection, id, opts \\ [])

@spec audit_log_id_get(Tesla.Env.client(), String.t(), keyword()) ::
  {:ok, nil} | {:error, Tesla.Env.t()}

Get audit entry detail

Parameters

  • connection (HookSniffAPI.Connection): Connection to server
  • id (String.t):
  • opts (keyword): Optional parameters

Returns

  • {:ok, nil} on success
  • {:error, Tesla.Env.t} on failure