Skip to content
Documentation

Installing the HTTP API

There are two main ways to host the PowerTSM HTTP API on-premises:

  • Running the service directly
  • Running the service within a Docker container

In order to run the service, make sure that .NET is installed on the system: System Requirements.

  1. Locate the TSM HTTP API folder within the distributed zip file. This contains a folder Binaries/Framework Dependent.

  2. Extract the contents of this folder to a location of choice.

  3. Open the folder using a command prompt. On Microsoft Windows, use either powershell.exe or cmd.exe. On Linux, any available shell will do.

  4. Start the service. The folder contains two files that can be used to start the service:

    • HAKOM.TSM.Http.exe
    • HAKOM.TSM.Http.dll

    The former can be used on Windows only. The latter can be used on any system that supports .NET 8.

    Execute HAKOM.TSM.Http.exe.

In practice, the service can be run in the background instead of from a command prompt.

By adding a -s or --runAsService command line parameter when starting the HTTP API, the service will now allow being run in background.

A service can be created in Windows using:

sc.exe create "Your service name" binPath= "<path-to-http-api-bin-folder>/HAKOM.TSM.Http.exe -s" start= auto

Running the Service Within a Docker Container

Section titled “Running the Service Within a Docker Container”

In order to run the service within a Docker container, the host has to have Docker installed.

  1. Locate the TSM HTTP API folder within the distributed zip file. This contains a folder Docker.

  2. Extract the contents of this folder to a location of choice.

  3. Open the folder using a command prompt. On Microsoft Windows, use either powershell.exe or cmd.exe. On Linux, any available shell will do.

  4. Execute the following command:

    docker load --input HAKOM.TSM.Http_4.13.0.tar

In order to customize the Docker image (e.g., to include additional configuration files or libraries for extending the service’s functionality), extract the entire contents of the TSM HTTP API folder from the distributed zip file to the host.

Modify Docker/Dockerfile as needed.

Open the extracted folder in a command prompt and run:

docker build -f ./Docker/Dockerfile -t hakom.tsm.http:4.13.0 .
© 2026 Volue.Version v0.6.38017 November 2026