TOP Server Configuration API

The Configuration API in TOP Server provides the ability to programmatically read and update the configuration in TOP Server from other software applications.  The configuration API allows you to read, create, update, and delete channels, devices, groups, meter groups, and tags.  Over time, the various optional plug-ins will also be configurable by the TOP Server API.


Typical use cases include:


  • Enterprise Users with large projects that are changing constantly, such as in upstream oil & gas where assets are constantly being added and removed or moved.
  • Enterprise Users with other software applications, including in-house applications or other configuration tools they would prefer to use to manage the TOP Server configuration and maintenance process.
  • Machine builders seeking to automate changing of machine configurations across different customers or markets.
  • System Integrators seeking to reduce engineering cost through automation of routine, repetitive configuration tasks
  • System integrators seeking to offer their users limited and simple access to certain routine configuration actions
  • Users that need to limit what certain users can do beyond the capabilities of the built-in TOP Server User Manager and want to limit even what the user can see, or present the configuration information in alternative formats that are more meaningful to their users.


The standard Configuration API is implemented as a RESTful web service and is built into TOP Server Version 6.0 and higher and included in all license purchases.

Key RESTful API Features:


  • Full Create, Update, and Delete operations (CRUD) on
    • Channels
    • Devices
    • Tag Groups
    • Meter groups (specific drivers)
    • Tags
    • Aliases
  • Object definition using JSON data format
  • Transaction logging with configurable levels of verbosity and retention and API access to the transaction log
  • Secure
    • Disabled by default
    • HTTPS endpoint support
    • HTTP endpoint disabled by default
    • TLS cipher support (TLS 1.0, 1.1 and 1.2)
    • SSL certificate support
    • Filtering by source domain
    • HTTP/HTTPS basic authentication
    • Integrated with TOP Server User Manager and Securities Policy Plug-In for granular rights control
  • Built-in documentation describing the endpoints and valid configuration properties.
  • Support for all drivers (some limitations may apply)
  • Currently Support for the following plug-ins (more to come in future releases)
    • Media Level Redundancy
    • Scheduler
    • EFM Exporter
    • Datalogger
  • Events/Error retrieval from event log via AP
  • Access/Modify User Manger users, groups and passwords via API

Support for retrieving TOP Server event log" then another bullet for "Support for configuring TOP Server project properties

Get More Info About TOP Server Standard Config API

.NET Configuration API


Coming soon.  Recognizing that many of our users are .NET developers, Software Toolbox will be offering an object oriented .NET wrapper for the RESTful API for users who develop in Visual Studio.NET and do not want to have to handle the management of the calls to the RESTful web service and serializing and de-serializing of the JSON packets.  The goal is to provide these developers a rapid development environment that allows them to focus on the configuration tasks, not the plumbing of implementation of the API.


Key .NET API Features


  • Single .NET namespace consumable in Winforms, WPF Forms, Console, Service, and ASP.NET applications or applications supporting .NET Framework 4.0 or higher.
  • Object-oriented operation treating configuration items as objects: channel, device, tag group, meter group and tags
  • Complete management of the web service connection and serializing, de-serializing of the JSON messages and objects
  • Simplified command set designed to reduce development time.

We are currently in early Beta on this offering.  If you’re interested in learning more, please contact us for a demonstration and evaluation of your beta request.

Get More Info About TOP Server .NET Config API


Click to verify BBB accreditation and to see a BBB report.




1-888-665-3678 (US)

+1-704-849-2773 (Global),