ex_uptimerobot v0.4.0 ExUptimerobot.PSP

Interact with Public Status Page - related API methods.

Summary

Delete an existing public status page by given ID

Edit the public status page with given parameters

Get the list of public status pages

Create a new public status page with given parameters

delete_psp(id)

delete_psp(integer) :: tuple

delete_psp(String.t) :: tuple

Delete an existing public status page by given ID

iex> ExUptimerobot.PSP.delete_psp(1337)
{:ok, response}

edit_psp(params \\ [])

edit_psp([tuple]) :: tuple

Edit the public status page with given parameters.

Required: id. Optional: friendly_name, monitors, custom_domain, sort, hide_url_links, status.

iex> ExUptimerobot.PSP.edit_psp([id: 1337, friendly_name: "Edited PSP", monitors: "123-456"])
{:ok, response}

get_psps(params \\ [])

get_psps([tuple]) :: tuple

Get the list of public status pages

iex> ExUptimerobot.AlertContact.get_psps()
{:ok, results}

new_psp(params \\ [])

new_psp([tuple]) :: tuple

Create a new public status page with given parameters.

Required: friendly_name, monitors.

Optional: custom_domain, sort, hide_url_links, status.

iex> ExUptimerobot.PSP.new_psp([friendly_name: "New PSP", monitors: 0])
{:ok, response}