Standalone Deployment

The standalone deployment of the REST API can work with UCMDB Server 10.10 and later versions.

You can obtain the WAR file for the REST API from the following locations:

  • ITOM Marketplace

  • UCMDB installation folder: <UCMDB_Server_Home>/tools/rest-api-standalone.war

Follow these steps to deploy the REST API on a separate Tomcat server:

Note Tomcat is the only supported servlet container.

  1. Copy the WAR file to the webapps directory of your Tomcat installation.

    Note It is recommended that you rename the WAR file to rest-api.war if you use the WAR file from the UCMDB installation folder.

  2. Create a rest_credentials.txt file under $CATALINA_HOME/conf/, and then specify the system administrator credentials of the UCMDB Server. For example:

    username=sysadmin
    password=Sysadmin_123
        
  3. Restart the Tomcat server.

Note In the standalone deployment:

  • The $CATALINA_HOME/conf/rest_jwt.bin file contains REST authorization information. If you remove this file, all authorization tokens created from server startup will be invalidated.

  • If you want to change the credentials that you specified during the deployment, delete the $CATALINA_HOME/conf/rest_credentials.bin file, and then redo Step 2 and Step 3.