NetXMS Wiki

Deploy NetXMS WebAPI using the WebUI Windows installer (Windows only!)

This Wiki is deprecated and we are are currrently migrating remaining pages into product documentation (Admin Guide, NXSL Guide)

This guide provides instructions on how to deploy the NetXMS WebAPI .war file, that can be downloaded at https://netxms.org/downloads, using the Jetty Runner that comes with the installation of the NetXMS WebUI. Windows only!

Requirements

The following prerequisites need to be set-up first:

  • A machine running windows.
  • A successfully installed and running NetXMS WebUI using the windows installer.

Steps

1. Navigate to the installation directory of the WebUI.

2. Create a folder named "WebAPI".

3. Create a file named "jetty-web.xml" in the newly created folder with the following content: 

<Configure class="org.eclipse.jetty.webapp.WebAppContext">
  <Set name="contextPath">/webapi</Set>
  <Set name="war"><SystemProperty name="jetty.home"/>\webapi\webapi.war</Set>
  <Set name="tempDirectory">webapi</Set>
</Configure>

4. Add the path to your 

jetty-web.xml

at the end of the registry 

HKEY_LOCAL_MACHINE\SOFTWARE\WOW6432Node\Apache Software Foundation\Procrun 2.0\nxWebUI\Parameters\Start\Params

5. Restart the NetXMS WebUI service and the WebAPI should be available at http://localhost:8080/webapi

Retrieved from "https://wiki.netxms.org/index.php?title=Deploy_NetXMS_WebAPI_using_the_WebUI_Windows_installer_(Windows_only!)&oldid=1803"