Update Domino REST API to the latest release version

About this task

The procedure guides you on how to update your installed Domino REST API to the latest release version. It's recommended to always update to the latest release version to take advantage of the new features and improvements of Domino REST API.

Prerequisite

• When updating installed Domino REST API on Linux, Mac, or Windows, download the latest release version of the Domino REST API multi-platform installer.

• When updating Domino REST API running with Docker image:

  • Download the docker image of the latest release version of Domino REST API .

  OR

  • Take note of the latest Docker image version for docker compose .env file from Harbor in What’s New.

Procedure

Follow the procedure based on the installation option you used when installing the existing version of your Domino REST API.

Note

For more information on the parameters used for updating Domino REST API in Linux, Mac, and Windows, see Explanation of parameters.

Docker

1. Remove the existing docker container.

2. If using the docker image from HCL Software License and Download Portal (Flexnet) or My HCLSoftware Portal, load the docker image using the following command:

   docker load -i [name_of_tar_file].tar
   

   Note

   • Make sure you extract the tar.gz file first.
   • This step isn't applicable if using the docker image from Harbor.

3. Take note of the image name.

   • When using the docker image from HCL Software License and Download Portal (Flexnet) or My HCLSoftware Portal, take note of the image name that was output after being loaded. The image name is also indicated in the What’s New for each version of the Domino REST API and marked Docker image version for docker compose .env file (CONTAINER_IMAGE).

     Example loaded image name

     • From earlier releases: docker.qs.hcllabs.net/hclcom/projectkeep-r12:1.10.0
     • Starting v1.0.7 release: domino-rest-api:1.0.7

   • When using the docker image from HCL Container Repository (Harbor), take note of the latest Docker image version for docker compose .env file from Harbor indicated in What’s New.

     Example image version name

     hclcr.io/domino/restapi:1.0.6

4. Update the value of the CONTAINER_IMAGE variable in your existing .env file with the noted Docker image name.

   Note

   It's recommended to use your existing .env file, but you can also use a new .env file. If you use a new .env file, make sure to update the variable values as needed.

5. Run the following command in the directory where you stored the server.id and docker-compose.yml files, which you used in your initial installation.

   docker-compose up
   

   Note

   If prompted for access to HCL Container Repository (Harbor), obtain your HCL Container Repository username and password, and then sign-in using docker login hclcr.io command and the obtained credentials.

6. Validate that an instance is successfully running on a container.

Linux

Note

• Don't install using the java executable in /opt/hcl/domino/bin/.
• If your system doesn't have Java installed, you can use the java executable in the /opt/hcl/domino/notes/latest/linux/jvm/bin/ directory.

To update to the latest release version, run the following command:

Important

• Starting Domino REST API version 1.0.7, the installer jar filename now includes the Domino version, for example, restapiInstall-r12.jar.
• Starting Domino REST API version 1.0.9, there will be two installer jar files:
  • For Domino 14, use restapiInstall-r14.jar.
  • For Domino 12, use restapiInstall-r12.jar.

sudo java -jar restapiInstall.jar \ 
 -d="/local/notesdata" \ 
 -i="/local/notesdata/notes.ini" \ 
 -r="/opt/hcl/restapi" \ 
 -p="/opt/hcl/domino/notes/latest/linux" \ 
 -u \
 -a

Mac

To update to the latest release version, run the following command:

Important

• Starting Domino REST API version 1.0.7, the installer jar filename now includes the Domino version, for example, restapiInstall-r12.jar.
• Starting Domino REST API version 1.0.9, there will be two installer jar files:
  • For Domino 14, use restapiInstall-r14.jar.
  • For Domino 12, use restapiInstall-r12.jar.

java -jar restapiInstall.jar \ 
 -d="/Users/[your user name]/Library/Application Support/HCL Notes Data" \ 
 -i="/Users/[your user name]/Library/Preferences/Notes Preferences" \ 
 -r="/Users/[your user name]/Applications/restapi" \ 
 -p="/Applications/HCL Notes.app" \ 
 -u \
 -a

Note

For more information on the installation-related support and limitations to client use, see Install on Mac.

Windows

To update to the latest release version, run the following command:

Note

Domino REST API installer needs to be run as administrator.

Important

• Starting Domino REST API version 1.0.7, the installer jar filename now includes the Domino version, for example, restapiInstall-r12.jar.
• Starting Domino REST API version 1.0.9, there will be two installer jar files:
  • For Domino 14, use restapiInstall-r14.jar.
  • For Domino 12, use restapiInstall-r12.jar.

For Windows Domino Server

java -jar restapiInstall.jar ^ 
 -d="C:\Program Files\HCL\Domino\Data" ^ 
 -i="C:\Program Files\HCL\Domino\notes.ini" ^ 
 -p="C:\Program Files\HCL\Domino" ^ 
 -r="C:\Program Files\HCL\Domino\restapi" ^ 
 -u ^
 -a

For Windows Notes Client

java -jar restapiInstall.jar ^
 -d="C:\Program Files\HCL\Notes\Data" ^
 -i="C:\Program Files\HCL\Notes\notes.ini" ^
 -r="C:\Program Files\HCL\Notes\restapi" ^
 -p="C:\Program Files\HCL\Notes" ^
 -u ^
 -a

When running the command for Windows Notes Client, the installer creates a runrestapi.cmd script in the Domino REST API installation directory. Run it to launch the Domino REST API.

Note

For more information on the installation-related support and limitations to client use, see Install on Windows.