Endpoints

An endpoint is the address, port, and protocol a web service is exposed at. In short, the web service URL.

WebAPI

The HTTP WebAPI comes in two parts:

While the Agents WebAPI is the most complete of the two, the REST WebAPI covers the most common use cases and is easier to use and navigate.

Getting started

  • Get the version number and build date from the API endpoint: /api
  • Get a list of supported URLs using the version URL: /api/v1
🛈 Note
If your installation is protected from the internet by a reverse proxy, the URLs generated by the WebAPI will be wrong. For more info, see the IIS config section.

Authorization (WebAPI)

HTTP request headers

SOAP

Authorization (SOAP)