Monitis REST API Documentation

Why use Monitis REST API?

Monitis REST API makes it possible to access data and manage settings of your Monitis account without logging into dashboard thus allowing you to build your own application on top of Monitis. Suppose you’ve got a website which is being monitored in Monitis and you want to see the monitoring data in your admin panel. You can write a small script to retrieve the monitoring data via Monitis API and show it in your admin panel. Monitis Rest API is also a good solution in case you own a monitoring service and want to offer your users also monitors existing in Monitis.

Why use Monitis Custom Monitor REST API?

Monitis Custom Monitor REST API gives a unique ability to monitor anything that is changing during some period – parameters of a network object, page rank, ticket price, exchange rate, air temperature. Suppose you have some script that does monitoring – retrieve and/or calculates metrics you want to monitor. Using Monitis Custom Monitor API you can create a custom monitor and schedule your script to upload monitoring data to Monitis server. After then you can access the monitoring data both by the API and on Monitis dashboard. Plus you can define notification rules so that you are alerted in case any metric is changed.

Public keys

Public key is a new authentication mechanizm which makes it easier and safer making API requests. It's some kind of shortcut for request parameters.

Why Use Public Key

Using public key makes your API calls safer. This way you hide your Api key and Secret key from everyone. Besides the list of parameters required for an api call becomes shorter making your life easier.

Imagine we have 2 monitors and we want to make an API call with action "testresult". We would have to make API call using following parameters:

  • action=testresult
  • apikey=11ETMVREQT1RP3AMHDPI2ANHT6
  • locationIds=4,1
  • testId=86
  • timestamp=2012-04-26 15:12:50
  • timezone=0
  • version=2
  • checksum=pJpF2mkvwAfbb02parn4/aX7qi4=
BUT NOW we can add a public key for the specified monitor and action to decrease the list of parameters.

Add Public Key

At first we have to add a public key. We can do this by sending POST request to http://api.monitis.com/api with the following parameters:

  • action=addPublicKey
  • apikey=11ETMVREQT1RP3AMHDPI2ANHT6
  • params={action:\"testresult\", testId:[86,90]}
  • timestamp=2012-04-26 15:09:56
  • version=2
  • checksum=f0eZiAf06VoJZqJoy1/yxxYEN4o=

The response will be the generated public key:

{
 "status":"ok",
 "data":"2APSIBH5CU1108LTGEHME10HP5"
}
                            

After adding a public key we can make testresult API call with the following parameters:

  • publickey=2APSIBH5CU1108LTGEHME10HP5
  • locationIds=4,1
  • testId=86
  • timezone=0
  • version=2

If you specify any monitorId except 86 and 90, which were defined when creating the Public Key you will get an error in response. And if monitorId had only one available value say only 86 you could also skip this parameter.

The api allows also to edit or delete pubic keys.

Testing tool