HookSniffAPI.Api.Routing (hooksniff v1.0.0)

API calls for all endpoints tagged Routing.

Summary

Functions

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

Get endpoint health status

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

Get routing config for endpoint

endpoints_id_routing_put(connection, id, update_routing_request, opts \\ [])

Update routing config

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

Get endpoint health status

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

Get routing config for endpoint

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

Update routing config

Functions

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

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

Get endpoint health status

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

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

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

Get routing config for endpoint

Parameters

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

Returns

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

endpoints_id_routing_put(connection, id, update_routing_request, opts \\ [])

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

Update routing config

Parameters

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

Returns

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

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

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

Get endpoint health status

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

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

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

Get routing config for endpoint

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

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

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

Update routing config

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