HookSniffAPI.Api.Alerts (HookSniff v0.3.0)

API calls for all endpoints tagged Alerts.

Summary

Functions

alerts_get(connection, opts \\ [])

List alert rules

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

Delete alert rule

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

Get alert rule

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

Test an alert rule

alerts_post(connection, create_alert_request, opts \\ [])

Create alert rule

Functions

alerts_get(connection, opts \\ [])

@spec alerts_get(
  Tesla.Env.client(),
  keyword()
) :: {:ok, [HookSniffAPI.Model.AlertRule.t()]} | {:error, Tesla.Env.t()}

List alert rules

Parameters

connection (HookSniffAPI.Connection): Connection to server
opts (keyword): Optional parameters

Returns

{:ok, [%AlertRule{}, ...]} on success
{:error, Tesla.Env.t} on failure

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

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

Delete alert rule

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

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

@spec alerts_id_get(Tesla.Env.client(), String.t(), keyword()) ::
  {:ok, HookSniffAPI.Model.AlertRule.t()} | {:error, Tesla.Env.t()}

Get alert rule

Parameters

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

Returns

{:ok, HookSniffAPI.Model.AlertRule.t} on success
{:error, Tesla.Env.t} on failure

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

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

Test an alert rule

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

alerts_post(connection, create_alert_request, opts \\ [])

@spec alerts_post(
  Tesla.Env.client(),
  HookSniffAPI.Model.CreateAlertRequest.t(),
  keyword()
) ::
  {:ok, HookSniffAPI.Model.AlertRule.t()} | {:error, Tesla.Env.t()}

Create alert rule

Parameters

connection (HookSniffAPI.Connection): Connection to server
create_alert_request (CreateAlertRequest):
opts (keyword): Optional parameters

Returns

{:ok, HookSniffAPI.Model.AlertRule.t} on success
{:error, Tesla.Env.t} on failure