Specs

check_exists?(
  token :: bitstring(),
  id :: bitstring(),
  customerid :: bitstring() | nil
) ::
  boolean()

Find whether a check exists or not. Returns true if present or false if nonexistent

• token - NodePing API token that is provided with account
• id - Check ID of the check you want to verify is present or not
• customerid - optional ID to access a subaccount

Specs

create_check(
  token :: bitstring(),
  checktype_struct :: struct(),
  args :: map(),
  customerid :: bitstring() | nil
) :: tuple()

Create a new check for your NodePing account or subaccount

Create any of the listed NodePing checks at: https://nodeping.com/docs-api-checks.html and view the "Fields by check type" section to see which checks accept what fields.

Parameters

• token - NodePing API token that is provided with account
• checktype_struct - the NodePing.Checktypes that defines the check you are trying to create
• args - non-default parameters you want to set for creating your check
• customerid - optional customerid for subaccount

Examples

iex> token = System.fetch_env!("TOKEN")
iex> checktype = NodePing.Checktypes.Ping
iex> args = %{label: "my label", target: "example.com", interval: 1, enabled: true}
iex> NodePing.Checks.create_check(token, checktype, args)

Specs

create_check!(
  token :: bitstring(),
  checktype_struct :: struct(),
  args :: map(),
  customerid :: bitstring() | nil
) :: map()

Create a new check for your NodePing account or subaccount

Create any of the listed NodePing checks at: https://nodeping.com/docs-api-checks.html and view the "Fields by check type" section to see which checks accept what fields.

Parameters

• token - NodePing API token that is provided with account
• checktype_struct - the NodePing.Checktypes that defines the check you are trying to create
• args - non-default parameters you want to set for creating your check
• customerid - optional customerid for subaccount

Examples

iex> token = System.fetch_env!("TOKEN")
iex> checktype = NodePing.Checktypes.Ping
iex> args = %{label: "my label", target: "example.com", interval: 1, enabled: true}
iex> NodePing.Checks.create_check!(token, checktype, args)

Specs

delete_check(
  token :: bitstring(),
  id :: bitstring(),
  customerid :: bitstring() | nil
) :: tuple()

Delete a check present on your NodePing account or specified subaccount

Parameters

• token - NodePing API token that is provided with account
• id - the check ID that you want to delete
• customerid - optional ID to access a subaccount

Examples

iex> token = System.fetch_env!("TOKEN")
iex> check_id = "201205050153W2Q4C-0J2HSIRF"
iex> {:ok, result} = NodePing.Checks.delete_check(token, check_id)

Specs

delete_check!(
  token :: bitstring(),
  id :: bitstring(),
  customerid :: bitstring() | nil
) :: map()

Delete a check present on your NodePing account or specified subaccount

Parameters

• token - NodePing API token that is provided with account
• id - the check ID that you want to delete
• customerid - optional ID to access a subaccount

Examples

iex> token = System.fetch_env!("TOKEN")
iex> check_id = "201205050153W2Q4C-0J2HSIRF"
iex> result = NodePing.Checks.delete_check!(token, check_id)

Specs

disable_all_checks(
  token :: bitstring(),
  disableall :: boolean(),
  opts :: list()
) :: tuple()

Disable a check present on your NodePing account or specified subaccount

Parameters

• token - NodePing API token that is provided with account
• id - the check ID that you want to delete
• customerid - optional ID to access a subaccount
• disableall - boolean value. true = disable all, false = re-enable those checks
• opts - a keyword list with keys of :type, :label, :target, :customerid as possible options

Examples

iex> opts = [{:type, "PING"}, {:target, "example.com"}]
iex> disableall = true
iex> {:ok, result} = NodePing.Checks.disable_all_checks(token, disableall, opts)

Specs

disable_all_checks!(
  token :: bitstring(),
  disableall :: boolean(),
  opts :: list()
) :: map()

Disable a check present on your NodePing account or specified subaccount

Parameters

• token - NodePing API token that is provided with account
• id - the check ID that you want to delete
• customerid - optional ID to access a subaccount
• disableall - boolean value. true = disable all, false = re-enable those checks
• opts - a keyword list with keys of :type, :label, :target, :customerid as possible options

Examples

iex> opts = [{:type, "PING"}, {:target, "example.com"}]
iex> disableall = true
iex> result = NodePing.Checks.disable_all_checks!(token, disableall, opts)

Specs

find_by_id(check_map :: map(), id :: bitstring()) :: list()

Find an already fetched map of NodePing checks for the one with a given ID

Parameters

• check_map - a map of checks already fetched from the NodePing API
• id - Check ID of the check you want to fetch information about

Specs

find_by_state(check_map :: map(), status :: atom()) :: list()

Find passing or failing checks in an already fetched map of NodePing checks

Parameters

• check_map - a map of checks already fetched from the NodePing API
• status - an atom with the values :passing or :failing

Specs

get_by_id(token :: bitstring(), id :: bitstring(), opts :: list()) :: tuple()

Get information about a NodePing check

Parameters

• token - NodePing API token that is provided with account
• id - Check ID of the check you want to fetch information about
• opts - Optional list of tuples to specify results

Opts - list of tuples

• customerid - optional ID to access a subaccount
• uptime - boolean - If this parameter is present the check's uptime will be added to the response

Specs

get_by_id!(token :: bitstring(), id :: bitstring(), opts :: list()) :: map()

Get information about a NodePing check

## Parameters

• token - NodePing API token that is provided with account
• id - Check ID of the check you want to fetch information about
• opts - Optional list of tuples to specify results

## Opts - list of tuples

• customerid - optional ID to access a subaccount
• uptime - boolean - If this parameter is present the check's uptime will be added to the response

Specs

get_checks(token :: bitstring(), opts :: list()) :: tuple()

Get all checks present on your NodePing account or specified subaccount

Parameters

• token - NodePing API token that is provided with account
• opts - Optional list of tuples to specify results.

Opts - list of tuples

• customerid - optional ID to access a subaccount
• uptime - boolean - If this parameter is present the check's uptime will be added to the response

Examples

iex> token = System.fetch_env!("TOKEN")
iex> customerid = System.fetch_env!("CUSTOMERID")
iex> {:ok, result} = NodePing.Checks.get_checks(token, [{:customerid, customerid}])

Specs

get_checks!(token :: bitstring(), opts :: list()) :: map()

Get all checks present on your NodePing account or specified subaccount

Parameters

• token - NodePing API token that is provided with account
• opts - Optional list of tuples to specify results.

Opts - list of tuples

• customerid - optional ID to access a subaccount
• uptime - boolean - If this parameter is present the check's uptime will be added to the response

Examples

iex> token = System.fetch_env!("TOKEN")
iex> customerid = System.fetch_env!("CUSTOMERID")
iex> result = NodePing.Checks.get_checks!(token, [{:customerid, customerid}])

Specs

get_disabled_checks(token :: bitstring(), opts :: list()) :: tuple()

Get all disabled checks present on your NodePing account or subaccount

Parameters

• token - NodePing API token that is provided with account
• opts - Optional list of tuples to specify results

Opts - list of tuples

• customerid - optional ID to access a subaccount
• uptime - boolean - If this parameter is present the check's uptime will be added to the response

Specs

get_disabled_checks!(token :: bitstring(), opts :: list()) :: map()

Get all disabled checks present on your NodePing account or subaccount

Parameters

• token - NodePing API token that is provided with account
• opts - Optional list of tuples to specify results

Opts - list of tuples

• customerid - optional ID to access a subaccount
• uptime - boolean - If this parameter is present the check's uptime will be added to the response

Specs

get_failing_checks(token :: bitstring(), opts :: list()) :: tuple()

Get all failing checks present on your NodePing account or subaccount

Parameters

• token - NodePing API token that is provided with account
• opts - Optional list of tuples to specify results

Opts - list of tuples

• customerid - optional ID to access a subaccount
• uptime - boolean - If this parameter is present the check's uptime will be added to the response

Examples

iex> token = System.fetch_env!("TOKEN")
iex> {:ok, failing_checks} = NodePing.Checks.get_failing_checks(token)

Specs

get_failing_checks!(token :: bitstring(), opts :: list()) :: tuple()

Get all failing checks present on your NodePing account or subaccount

Parameters

• token - NodePing API token that is provided with account
• opts - Optional list of tuples to specify results

Opts - list of tuples

• customerid - optional ID to access a subaccount
• uptime - boolean - If this parameter is present the check's uptime will be added to the response

Examples

iex> token = System.fetch_env!("TOKEN")
iex> failing_checks = NodePing.Checks.get_failing_checks!(token)

Specs

get_last_result(token :: bitstring(), id :: bitstring(), opts :: list()) ::
  tuple()

Get the last result for a specified check

Parameters

• token - NodePing API token that is provided with account
• id - Check ID of the check you want to fetch the last result for
• opts - Optional list of tuples to specify results

Opts - list of tuples

• customerid - optional ID to access a subaccount
• uptime - boolean - If this parameter is present the check's uptime will be added to the response

Specs

get_last_result!(token :: bitstring(), id :: bitstring(), opts :: list()) ::
  map()

Get the last result for a specified check

Parameters

• token - NodePing API token that is provided with account
• id - Check ID of the check you want to fetch the last result for
• opts - Optional list of tuples to specify results

Opts - list of tuples

• customerid - optional ID to access a subaccount
• uptime - boolean - If this parameter is present the check's uptime will be added to the response

Specs

get_many(token :: bitstring(), checkids :: list(), opts :: list()) :: tuple()

Get many checks at once on your NodePing account or specified subaccount

Parameters

• token - NodePing API token that is provided with account
• checkids - list of checkids that will be queried
• opts - Optional list of tuples to specify results

Opts - list of tuples

• customerid - optional ID to access a subaccount
• uptime - boolean - If this parameter is present, the checks uptimes wilwl be added to the response

Examples

iex> token = System.fetch_env!("TOKEN")
iex> checkids = ["201205050153W2Q4C-0J2HSIRF", "201205050153W2Q4C-4RZT8MLN"]
iex> {:ok, result} = NodePing.Checks.get_many(token, checkids, [{:uptime, true}])

Specs

get_many!(token :: bitstring(), checkids :: list(), opts :: list()) :: map()

Get many checks at once on your NodePing account or specified subaccount

Parameters

• token - NodePing API token that is provided with account
• checkids - list of checkids that will be queried
• opts - Optional list of tuples to specify results

Opts - list of tuples

• customerid - optional ID to access a subaccount
• uptime - boolean - If this parameter is present, the checks uptimes wilwl be added to the response

Examples

iex> token = System.fetch_env!("TOKEN")
iex> checkids = ["201205050153W2Q4C-0J2HSIRF", "201205050153W2Q4C-4RZT8MLN"]
iex> result = NodePing.Checks.get_many!(token, checkids, [{:uptime, true}])

Specs

get_passing_checks(token :: bitstring(), opts :: list()) :: tuple()

Get all passings checks present on your NodePing account or subaccount

## Parameters

• token - NodePing API token that is provided with account
• opts - Optional list of tuples to specify results

## Opts - list of tuples

• customerid - optional ID to access a subaccount
• uptime - boolean - If this parameter is present the check's uptime will be added to the response

Examples

iex> token = System.fetch_env!("TOKEN")
iex> passing_checks = NodePing.Checks.get_passing_checks(token, [{:uptime, true}])

Specs

get_passing_checks!(token :: bitstring(), opts :: list()) :: map()

Get all passings checks present on your NodePing account or subaccount

## Parameters

• token - NodePing API token that is provided with account
• opts - Optional list of tuples to specify results

## Opts - list of tuples

• customerid - optional ID to access a subaccount
• uptime - boolean - If this parameter is present the check's uptime will be added to the response

Examples

iex> token = System.fetch_env!("TOKEN")
iex> passing_checks = NodePing.Checks.get_passing_checks!(token, [{:uptime, true}])

Specs

mute_check(
  token :: bitstring(),
  id :: bitstring(),
  checktype_struct :: struct(),
  duration :: non_neg_integer() | boolean(),
  customerid :: bitstring() | nil
) :: tuple()

Mute all notifications for the specified check

Parameters

• token - NodePing API token that is provided with account
• id - the checkid that will be muted
• checktype_struct - the NodePing.Checktypes that defines the check you are trying to mute
• duration - duration in seconds that the check will be muted
• customerid - optional customerid for subaccount

Specs

mute_check!(
  token :: bitstring(),
  id :: bitstring(),
  checktype_struct :: struct(),
  duration :: non_neg_integer() | boolean(),
  customerid :: bitstring() | nil
) :: map()

Mute all notifications for the specified check

Parameters

• token - NodePing API token that is provided with account
• id - the checkid that will be muted
• checktype_struct - the NodePing.Checktypes that defines the check you are trying to mute
• duration - duration in seconds that the check will be muted
• customerid - optional customerid for subaccount

Specs

update_check(
  token :: bitstring(),
  id :: bitstring(),
  checktype_struct :: struct(),
  args :: map(),
  customerid :: bitstring() | nil
) :: tuple()

Update an existing check for your NodePing account or subaccount ## Parameters

• token - NodePing API token that is provided with account
• checktype_struct - the NodePing.Checktypes that defines the check you are trying to create
• args - non-default parameters you want to set for creating your check
• customerid - optional customerid for subaccount

Examples

iex> token = System.fetch_env!("TOKEN")
iex> check_id = "201205050153W2Q4C-0J2HSIRF"
iex> checktype = NodePing.Checktypes.Ping
iex> args = %{label: "my label", target: "example.com", interval: 1, enabled: true}
iex> NodePing.Checks.update_check(token, check_id, checktype, args)

Specs

update_check!(
  token :: bitstring(),
  id :: bitstring(),
  checktype_struct :: struct(),
  args :: map(),
  customerid :: bitstring() | nil
) :: map()

Update an existing check for your NodePing account or subaccount ## Parameters

• token - NodePing API token that is provided with account
• checktype_struct - the NodePing.Checktypes that defines the check you are trying to create
• args - non-default parameters you want to set for creating your check
• customerid - optional customerid for subaccount

Examples

iex> token = System.fetch_env!("TOKEN")
iex> check_id = "201205050153W2Q4C-0J2HSIRF"
iex> checktype = NodePing.Checktypes.Ping
iex> args = %{label: "my label", target: "example.com", interval: 1, enabled: true}
iex> NodePing.Checks.update_check!(token, check_id, checktype, args)