The HCL Domino REST API provides the ability for external systems to securely access Domino application data. And, it allows a developer to use their preferred programming language, expanding the skill set required to interact with Domino. Ultimately, the Domino REST API enables extending, modernizing and transforming Domino applications.
While it holds true that the features provided by the Domino REST API are geared towards those focused on application development, Domino administrators need to understand this new addition, too. Administrators are tasked with protecting the service. Being that the Domino REST API runs on the Domino server, it becomes the administrator's responsibility to ensure it is properly installed, configured and monitored.
The Domino REST API runs on a Domino 12.0.2+ server running on Windows, Linux or Docker/Kubernetes container. As with other HCL software, visit the HCL License and Download Portal and download the HCL Domino REST API for your respective platform.
The download package is in a tar.gz format, which is a compressed file format. You will need to extract the files. For example, on a Windows OS using 7-Zip you will do the following.
- Open Windows Explorer
- Right mouse click on the downloaded file and select 7-Zip -> Extract files
- Update the dialog box options if needed and press OK
- Open the folder where the file was extracted
- For the extracted .tar file, repeat steps 2-3
The restapiInstall-r12.jar file is the installer file. Copy this file to the Domino server's program folder, meaning the folder where nserver.exe is located.
To install the Domino REST API on a Windows server run a Windows CMD prompt as administrator, change directories to the Domino program folder and run the following command.
java -jar c:\domino\restapiinstall-r12.jar -d="C:\Domino\Data" -i="C:\Domino\notes.ini" -r=
C:\Domino\restapi" -p="C:\Domino" -a
Note: you will change the paths listed above to be those on your Domino server. Refer to the following documentation for a list of all options.
The following are added to the Domino server as part of the install.
\Domino\restapi - folder containing the Domino REST API JAR files
The following three Domino databases and their respective templates are installed to the Domino Data folder.
Domino Keep Configuration (keepconfig.nsf)
Domino Keep Agent Schedule (keepagents.nsf)
Domino Keep OAuth (oauth.nsf)
Note: In the Domino REST API components, settings and logs, you will see a reference to KEEP.
KEEP was the original project name of the Domino REST API.
Additionally, the installer launches the Domino REST API, which runs as a task on the Domino server using nrestapi.exe.
As with other Domino server tasks, you can interact with the Domino REST API by issuing 'tell restapi action' at the Domino server console. For example, 'tell restapi help' will provide an output of available actions.
Issuing 'tell restapi status' writes to the server console information about the restapi task.
Hope you enjoyed this introduction and learning about the foundational components of the Domino REST API. Next article, you will learn what steps you need to take to properly configure and secure the Domino REST API.