Troubleshooting
- Installer was not launched using “Run as Administrator”.
- Not enough user access rights provided during installation.
- Data entered during installation was not correct:
SQL connection string, Endpoint Security License, Endpoint Security user can be reconfigured in:
RESTAPIHost.exe.config
- Credentials used for installing/starting service can be fixed by executing RestAPiHost.exe from its installation location (default location C:\Program Files (x86)\HEAT Software\RESTApi). See http://docs.topshelf-project.com/en/latest/overview/commandline.html
REST API log
Name: HEAT.RESTAPIHost.RESTAPIHost.exe.log
Default location: C:\Program Files(x86)\HEAT Software\RESTApi\log
Installer Log
Name: RESTAPI_Install_Log.log
Default location: %temp% (C:\Users\[username]\AppData\Local\Temp)
PUT
Updates a resource and returns HTTP 200 on success.
DELETE
Deletes a resource and returns HTTP 200 on success.
How to upgrade a broken REST API Version 1.0 installation
You have two options:
Attempt to upgrade the v1.0 instance to make it uninstallable, then uninstall v1.0 and install REST API v2:
- Execute the v1.0.1 installer (Run as Administrator).
- Complete the upgrade wizard. There is no reconfiguration in an upgrade scenario, so faulty settings from the initial installation will still prevent the REST API service from starting. This step is required only to achieve a successful uninstallation.
- Open Control Panel > Programs and Features, then select HEAT RestAPI and uninstall it.
- Run the installer for REST API v2.
Manually fix the XML configuration file (RESTAPIHost.exe) then manually install and start the HEAT REST API service:
- Open a command prompt with Administrator privileges and navigate to the application installation folder.
- Run RESTAPIHost.exe uninstall (you might see errors, that is OK)
- Navigate to the location where the REST API was installed.
- Open the RESTAPIHost.exe.config XML file.
- Locate the tag <connectionStrings></connectionStrings> and enter the correct data for both Databases PLUSDatabase and UPCCommonDatabase (Data Source and Initial Catalog values).
- Locate the tag <appSettings></appSettings> and enter correct data for:
- SSL - true if SSL used false if SSL not used
- SSLCertPath - path to the certificate
- licensekey - license number for the Endpoint Security instance the REST API is going to point to
- port – port number used by REST service
- username – Endpoint Security username used as ContextID to access the Endpoint Security SQL database (Endpoint Security User)
- Open an elevated command line and run RESTAPIHost.exe. If all the data entered is correct the service will start from the command line and log to the console.
- Install the HEAT RestAPI application as a Windows service by running the following command:
- RESTAPIHost.exe install –networkservice (if using windows authentication)
- RESTAPIHost.exe install – username:DomainServiceAccount –password:password (if using SQL authentication)