HookSniffAPI.Api.APIKeys (HookSniff v0.3.0)

API calls for all endpoints tagged APIKeys.

Summary

Functions

api_keys_get(connection, opts \\ [])

List API keys

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

Delete (revoke) an API key

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

Rotate an API key

api_keys_post(connection, opts \\ [])

Create a new API key

Functions

api_keys_get(connection, opts \\ [])

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

List API keys

Parameters

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

Returns

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

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

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

Delete (revoke) an API key

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

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

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

Rotate an API key

Parameters

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

Returns

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

api_keys_post(connection, opts \\ [])

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

Create a new API key

Parameters

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

Returns

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