Skip to content
Ask A Question
  • There are no suggestions because the search field is empty.

Accessing Help Documentation for the Configuration API

How do I find the help reference documentation for the TOP Server Configuration API?

The help reference documentation for the TOP Server Configuration API can be accessed through TOP Server Administration Settings, by doing the following:
  1. In your Windows system tray, right-click on the TOP Server Administration icon and select "Settings".
  2. Go to the "Configuration API Service" section.
  3. Make sure the setting "Enable" is set to Yes.
  4. Further down in the same section, find "View in browser" and click the displayed hyperlink to launch in a web browser (default URL is "http://127.0.0.1:57418/config" - for HTTPS or if the port has been changed, this will be different depending on the changes applied).
  5. Once you've click the link, your default web browser should launch and access the documentation for the Configuration API REST interface, sourced from the local web service that TOP Server exposes for the Configuration API.
  6. Here you can access the following:
    1. Click on the "Supported Drivers" link to access the listed of supported drivers for API operations including all relevant information regarding their supported properties.
    2. Click on the "API Documentation" link to access quick reference documentation for more server-level (non-driver-specific) details on supported endpoints and actions for those endpoints.