HookSniffAPI.Api.Health (hooksniff v1.0.0)

API calls for all endpoints tagged Health.

Summary

Functions

endpoint_health_get(connection, opts \\ [])

List endpoint health statuses

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

Get specific endpoint health

status_get(connection, opts \\ [])

System status (public)

Functions

endpoint_health_get(connection, opts \\ [])

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

List endpoint health statuses

Parameters

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

Returns

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

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

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

Get specific endpoint health

Parameters

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

Returns

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

status_get(connection, opts \\ [])

@spec status_get(
  Tesla.Env.client(),
  keyword()
) :: {:ok, HookSniffAPI.Model.SystemStatus.t()} | {:error, Tesla.Env.t()}

System status (public)

Parameters

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

Returns

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