Skip to content

HTTPS clone URL

Subversion checkout URL

You can clone with
or
.
Download ZIP
A simple node.js API for uptime robot
JavaScript
Branch: master
Failed to load latest commit information.
test
.gitignore Release 0.0.1
LICENSE
README.md
index.js Use then-jsonp to handle jsonp
package.json

README.md

Uptime Robot

A simple node.js and browserify API for uptime robot

$ npm install uptime-robot

Currently, only some methods are implemented, but pull requests for the missing ones are welcome.

This library works in the browser using browserify. You can see a demo by cloning this repo and running npm run test-browser.

All methods also return a Promise if no callback is provided.

Example

var Client = require('uptime-robot');
var cl = new Client('api-key');
cl.getMonitors({customUptimeRatio: [1, 7, 30]}, function (err, res) {
  if (err) throw err;
  console.dir(res);
});

API

cl.getMonitors(options, fn(err, monitors))

options:

cl.newMonitor(options, fn(err))

options:

  • friendlyName - required
  • url - required
  • type - required (Default: 1)
  • subType - optional (required for port monitoring)
  • port - optional (required for port monitoring)
  • keywordType - optional (required for keyword monitoring)
  • keywordValue - optional (required for keyword monitoring)
  • httpUsername - optional
  • httpPassword - optional
  • alertContacts - optional (array of alert contact ids)
  • interval - optional (in minutes)

cl.deleteMonitor(id, fn(err))

Delete the monitor with the given id

cl.getAlertContacts(options, fn(err, alertContacts))

options:

  • alertContacts - optional (array of alert contact ids)
  • offset - optional (record to start paginating. Default: 0)
  • limit - optional (number of records to return. Default and max: 50)

cl.getAllAlertContactIds(fn(err, alertContacts))

  • alertContacts: array of all alert contact ids

License

MIT

Something went wrong with that request. Please try again.