Install Domino REST API

Guides you through the procedures for installing Domino REST API.

Installation steps

Check system requirements

Before starting the installation, make sure that you check the system requirements.
Download Domino REST API

Install Domino REST API on:
- Domino Server on Linux
- Domino Server or Notes Client on Windows
- Notes Client on macOS
- Domino Server on Docker

Additional references

The following references provide useful information necessary in the installation of Domino REST API.

Installation command parameters

The table shows the command parameters used when installing Domino REST API on Linux, Windows, or macOS. You can find the short and full versions of the parameters, their description, and whether they're mandatory or not.

Expand to see the explanation of the installation command parameters

Short	Full parameter	Description
`-d`	`--dataDir=<dataDir>`	Directory of your HCL Notes or Domino data. Mandatory
`-i`	`--ini=<notesIni>`	HCL Notes/Domino notes.ini file. Mandatory
`-r`	`--restapiDir=<restapiDir>`	Directory to install the Domino REST API files into. Mandatory
`-p`	`--programDir=<programDir>`	Directory where HCL Notes or Domino is installed. Mandatory
`-u`	`--upgrade`	Performs an upgrade from a previous version. Upgrade will remove known program files and libraries from the Domino REST API directory and install the new version into the same directory.
`-f`	`--forceUpgrade`	Performs an upgrade without regard to the previous version. If an unknown version or unexpected files are found in the Domino REST API directory, this option will delete the entire contents of the Domino REST API directory and subdirectories first before installing the new version.
`-a`	`--accept`	Automatically accepts terms & conditions.
`-h`	`--help`	Shows help message and exits.
`-n`	`--noIniUpdates`	Installs the files, shows updated ini entries, but doesn't write them out.
`-o`	`--oneTouchInstall`	If installing Domino REST API as part of a Domino One Touch Install, use this option to prevent checking for Notes / Domino directories and notes.ini.
`-y`	`--dryRun`	Doesn't actually copy or alter files and settings.
`-s`	`--skipDirectoryCheck`	Skips the checks if the program and data directories contain Notes or Domino.
`-V`	`--version`	Prints version information and exits.

Use of response file

Instead of providing all parameters on the command line, the Domino REST API installer can be called using a response file:

[sudo] java -jar restapiInstaller.jar @responses.txt

The file contains one parameter per line. Lines starting with # get ignored. Variables with \ need to be escaped \\:

# Sample of an installer response file
--dataDir=D:\\Domino\\data
--ini=D:\\Domino\\data\\notes.ini
--restapiDir=C:\\Program Files\\HCL\\restapi
--programDir=C:\\Program Files\\HCL\\Domino
--accept

Installation return codes

The table shows the installation return codes and their corresponding explanation.

Expand to see the installation return codes

Code	Explanation
0	Operation completed with no known error.
1	License not accepted.
2	Installation type could not be determined or is not supported.
3	Check for / creation of installation directories failed.
4	Extraction of Domino REST API binaries and JARs failed.
5	Creation of start script/cmd failed.
6	Update of `notes.ini` failed.
7	Upgrade aborted by user (missed the final A before proceeding with the upgrade). To address the issue, make sure to type A before pressing [Enter] to proceed with the upgrade.