Versions Compared

Old Version 6

changes.mady.by.user Unknown User (npollard)

Saved on

compared with

New Version 7

changes.mady.by.user Unknown User (npollard)

Saved on

Key

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

Access all API commands using the following general format:

 

Code Block
https://<hostname>:<port>/api/<api_version>/<end_point>/<id>/<task>
 
  • hostname: the URI for the Uptime Infrastructure Monitor Controller installation
  • port: the 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 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
...
If the provided command produces an error, an HTTP status in the 400 range is returned including a specific status code and a message with further details about the error. All error messages are returned in JSON format and look like the following:
...
{
    "error" :  "Required field missing" , 
    "errorDescription" :  null
}