Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

  • hostname: the URI for the up.time Uptime Infrastructure Monitor Controller installation
  • port: the up.time Uptime Infrastructure Monitor Controller listener port, typically 9997
  • api_version: the version of the API to run commands against (see Version Control below)
  • end_point: the type of object you want to work with in up.time Uptime Infrastructure Monitor (see Endpoints below)
  • id: the numerical ID of the object you are interested in
  • task: where supported, specific tasks to be executed against the provided object

...

Authentication to the API is based on the basic HTTP basic authentication template: each request to the API must provide a username and password pair. To safeguard this information, all requests to the up.time Uptime Infrastructure Monitor API must use SSL communication.

Each user in up.time Uptime Infrastructure Monitor has access to the API. User-visibility and role-based permissions are applied to each API call, ensuring users are only able to access and modify the same information they would be able to access from the up.time Uptime Infrastructure Monitor UI.

Version Control

The version of the API you wish to access is embedded directly into the URL. Bug fixes and non-breaking feature changes are made without changing the version number. Major feature changes or breaking changes introduce a new version number. Backward support for previous API version is currently not defined.

...

Endpoints define the different types of up.time Uptime Infrastructure Monitor objects that you can work with using the API. The currently supported endpoints include the following:

/elementsup.time Uptime Infrastructure Monitor Elements
/monitors – up.time Uptime Infrastructure Monitor service monitors
/groupsup.time Uptime Infrastructure Monitor Element groups

The following is a summary of presently available resources:

...