Versions Compared

Key

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

All Access all API commands can be accessed using this the following general format:

 

Code Block
https://<hostname>:<port>/api/<api_version>/<end_point>/<id>/<task>

 

...

All returned results are provided in JSON format. Successfully completed requests will return an HTTP code in the 200 range.

...

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

...

If the provided command produces an error, an HTTP status in the 400 range will be 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:

...