Documentation

uptimerobot - Pause and start Uptime Robot monitoring

New in version 1.9.

Synopsis

This module will let you start and pause Uptime Robot Monitoring

Requirements (on host that executes module)

  • Valid Uptime Robot API Key

Options

parameter required default choices comments
apikey
 yes
    Uptime Robot API key.
    monitorid
    		 yes
      ID of the monitor to check.
      state
      		 yes
      • started
      • paused
      Define whether or not the monitor should be running or paused.

      Examples

      # Pause the monitor with an ID of 12345.
- uptimerobot: monitorid=12345
           apikey=12345-1234512345
           state=paused

# Start the monitor with an ID of 12345.
- uptimerobot: monitorid=12345
           apikey=12345-1234512345
           state=started

      Notes

      Note

      Support for adding and removing monitors and alert contacts has not yet been implemented.

      This is an Extras Module

      For more information on what this means please read Extras Modules

      For help in developing on modules, should you be so inclined, please read Community Information & Contributing, Helping Testing PRs and Developing Modules.