NodePing Elixir v1.1.4 NodePing.Checks View Source

Create, read, update, and delete NodePing checks for your account and subaccounts

Link to this section Summary

Functions

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

Create a new check for your NodePing account or subaccount

Create a new check for your NodePing account or subaccount

Delete a check present on your NodePing account or specified subaccount

Delete a check present on your NodePing account or specified subaccount

Disable a check present on your NodePing account or specified subaccount

Disable a check present on your NodePing account or specified subaccount

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

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

Get information about a NodePing check

Get information about a NodePing check

Get all checks present on your NodePing account or specified subaccount

Get all checks present on your NodePing account or specified subaccount

Get all disabled checks present on your NodePing account or subaccount

Get all disabled checks present on your NodePing account or subaccount

Get all failing checks present on your NodePing account or subaccount

Get all failing checks present on your NodePing account or subaccount

Get the last result for a specified check

Get the last result for a specified check

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

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

Get all passings checks present on your NodePing account or subaccount

Get all passings checks present on your NodePing account or subaccount

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

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

Link to this section Functions

Link to this function

check_exists?(token, id, customerid \\ nil)

View Source

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
Link to this function

create_check(token, checktype_struct, args, customerid \\ nil)

View Source

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)
Link to this function

create_check!(token, checktype_struct, args, customerid \\ nil)

View Source

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)
Link to this function

delete_check(token, id, customerid \\ nil)

View Source

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)
Link to this function

delete_check!(token, id, customerid \\ nil)

View Source

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)
Link to this function

disable_all_checks(token, disableall, opts \\ [])

View Source

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)
Link to this function

disable_all_checks!(token, disableall, opts \\ [])

View Source

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)
Link to this function

find_by_id(check_map, id)

View Source

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
Link to this function

find_by_state(check_map, status \\ :passing)

View Source

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
Link to this function

get_by_id(token, id, opts \\ [])

View Source

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
Link to this function

get_by_id!(token, id, opts \\ [])

View Source

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
Link to this function

get_checks(token, opts \\ [])

View Source

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}])
Link to this function

get_checks!(token, opts \\ [])

View Source

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}])
Link to this function

get_disabled_checks(token, opts \\ [])

View Source

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
Link to this function

get_disabled_checks!(token, opts \\ [])

View Source

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
Link to this function

get_failing_checks(token, opts \\ [])

View Source

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)
Link to this function

get_failing_checks!(token, opts \\ [])

View Source

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)
Link to this function

get_last_result(token, id, opts \\ [])

View Source

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
Link to this function

get_last_result!(token, id, opts \\ [])

View Source

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
Link to this function

get_many(token, checkids, opts \\ [])

View Source

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}])
Link to this function

get_many!(token, checkids, opts \\ [])

View Source

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}])
Link to this function

get_passing_checks(token, opts \\ [])

View Source

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}])
Link to this function

get_passing_checks!(token, opts \\ [])

View Source

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}])
Link to this function

update_check(token, id, checktype_struct, args, customerid \\ nil)

View Source

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)
Link to this function

update_check!(token, id, checktype_struct, args, customerid \\ nil)

View Source

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)