When integrating with the API, the following general programming rules should be noted:

  • fields will not always be returned in the same order; reference fields by name
  • fields will not always be returned; validate a field is available before using it
  • array results are not guaranteed to be sorted
  • date and time fields will always be returned in ISO 8601 format

Example API Calls and Helper Classes

The following examples and helper classes are available on GitHub. Helper classes allow you to make API calls, and assign them to objects, from various languages.

Implementation Examples

You can find examples of dashboards and gadgets that are built using the API on the uptime software Grid. These are also available as open-source projects on GitHub. These dashboards and gadgets are also ready to be installed on your Monitoring Station using the Extension Manager.

 

  • No labels