NodePing.Information (NodePing Elixir v1.7.1) View Source

Get information about NodePing probes and regions

Link to this section Summary

Functions

get_locations(token)

Get region location information, the region name and list of probe locations.

get_locations(token, loc)

Get region location information, the region name and list of probe locations.

get_locations!(token)

Get region location information, the region name and list of probe locations.

get_locations!(token, loc)

Get region location information, the region name and list of probe locations.

get_probe(token)

Get information about all active NodePing probes The returned value is a JSON object that is converted to a map of maps

get_probe(token, probe)

Get information about all active NodePing probes The returned value is a JSON object that is converted to a map of maps

get_probe!(token)

Get information about all active NodePing probes The returned value is a JSON object that is converted to a map of maps

get_probe!(token, probe)

Get information about all active NodePing probes The returned value is a JSON object that is converted to a map of maps

Link to this section Functions

get_locations(token)

Get region location information, the region name and list of probe locations.

Parameters

token - NodePing API token that is provided with account

Examples

iex> token = System.fetch_env!("TOKEN")
iex> {:ok, result} = NodePing.Information.get_locations(token)
iex> Map.keys(result)
["eao", "eur", "lam", "nam", "wlw"]

get_locations(token, loc)

Get region location information, the region name and list of probe locations.

Parameters

token - NodePing API token that is provided with account

Examples

iex> token = System.fetch_env!("TOKEN")
iex> {:ok, result} = NodePing.Information.get_locations(token, "nam")
iex> Map.keys(result)
["locations", "regionname"]

get_locations!(token)

Get region location information, the region name and list of probe locations.

Parameters

token - NodePing API token that is provided with account

Examples

iex> token = System.fetch_env!("TOKEN")
iex> result = NodePing.Information.get_locations!(token)
iex> Map.keys(result)
["eao", "eur", "lam", "nam", "wlw"]

get_locations!(token, loc)

Get region location information, the region name and list of probe locations.

Parameters

token - NodePing API token that is provided with account

Examples

iex> token = System.fetch_env!("TOKEN")
iex> result = NodePing.Information.get_locations!(token, "nam")
iex> Map.keys(result)
["locations", "regionname"]

get_probe(token)

Get information about all active NodePing probes The returned value is a JSON object that is converted to a map of maps

Parameters

token - NodePing API token that is provided with account

Examples

iex> token = Application.fetch_env!(:nodeping, :token)
iex> {:ok, result} = NodePing.Information.get_probe(token)
iex> is_map(result)
true

get_probe(token, probe)

Get information about all active NodePing probes The returned value is a JSON object that is converted to a map of maps

Parameters

token - NodePing API token that is provided with account
probe - The abbreviation for the region/location of probe. For example, nam for the NAM region or wa for the Washington server

Examples

iex> token = System.fetch_env!("TOKEN")
iex> NodePing.Information.get_probe(token, :de)

{:ok,
 %{
   "country" => "DE",
   "ipv4" => "54.36.110.96",
   "ipv6" => "2001:41d0:700:1360::10",
   "location" => "de",
   "locationname" => "Frankfurt, Germany",
   "region" => "eur",
   "regionname" => "Europe"
 }}

get_probe!(token)

Get information about all active NodePing probes The returned value is a JSON object that is converted to a map of maps

Parameters

token - NodePing API token that is provided with account

Examples

iex> token = Application.fetch_env!(:nodeping, :token)
iex> result = NodePing.Information.get_probe(token)
iex> is_map(result)
true

get_probe!(token, probe)

Get information about all active NodePing probes The returned value is a JSON object that is converted to a map of maps

Parameters

token - NodePing API token that is provided with account
probe - The abbreviation for the region/location of probe. For example, nam for the NAM region or wa for the Washington server

Examples

iex> token = System.fetch_env!("TOKEN")
iex> NodePing.Information.get_probe!(token, :de)
%{
  "country" => "DE",
  "ipv4" => "54.36.110.96",
  "ipv6" => "2001:41d0:700:1360::10",
  "location" => "de",
  "locationname" => "Frankfurt, Germany",
  "region" => "eur",
  "regionname" => "Europe"
}