Skip to content

What's new for Domino REST API v1.1.7

Release date: April 7, 2026

If you are upgrading from Domino REST API v1.1.2 or an earlier version, refer to important information regarding CORS using Regex.

New features

  • Added the GET pim-v1/calendar/profile endpoint to retrieve an authenticated user’s calendar profile document. This document stores personal calendar and scheduling settings, such as work hours and days, default meeting duration, time zone, automatic processing options, free time display settings, and other scheduling defaults.

  • Added the POST pim-v1/pimitems/unread endpoint to check and optionally update the unread status of PIM items. The endpoint accepts a request object containing a required unids array of UNIDs and optional markRead: true or markUnread: true flags. It returns an object that maps each UNID to a boolean value, where true indicates unread status and false indicates read status.

  • Implemented the PUT pim-v1/message/{unid} endpoint to support updating fields on an email document identified by its UNID.

  • Added the console commands tell restapi jfr start for starting Java Flight Recorder (JFR) profiling and tell restapi jfr stop for stopping JFR profiling. For more information, see Domino REST API task.

  • Added the console command tell restapi jfr dump for writing dump files that contain detailed JFR profiling information. These dump files are useful for diagnosing, analyzing, and troubleshooting the behavior of Java applications and the JVM. For more information, see Domino REST API task.

Important

Only run the tell restapi jfr start, tell restapi jfr stop, and tell restapi jfr dump console commands when advised by the Support team, as these commands are intended for diagnostic purposes.

Improvements

  • The timeout for retrieving data from Domino has been increased from 30 seconds to 180 seconds (3 minutes) to give long-running operations, such as complex DQL queries, more time to complete before timing out. As a result, fewer timeout warnings are logged, and operations that previously failed due to the shorter timeout might now complete successfully, depending on their execution time.

    To change the timeout value, configure the setting in keepconfig.d by specifying the time in seconds using the httpIdleTimeOut parameter.

    For example, the following configuration changes the timeout to 240 seconds or 4 minutes:

    {
    "httpIdleTimeOut" : 240
}

    For more information, see Change timeout for retrieving data from Domino

  • After the installer completes successfully, the recommended next steps are displayed to guide the user. The information shown depends on the configuration settings across all JSON files in the keepconfig.d directory and may include reminders to complete CORS setup, functional user configuration, or TLS settings, along with relevant documentation links. If all configurations are properly set, only the link to the Domino REST API documentation is displayed. This approach ensures the Domino REST API is correctly configured to meet user requirements.

  • Optimized the process of accessing PIM endpoints on multiple servers.

  • Improved performance when reading calendar entries with an unbounded (open-ended) date range in high usage scenarios.

  • Enhanced the login experience by dynamically switching the login form in the Admin UI on your browser, depending on your selected login option.

  • Implemented updates allowing users with restricted access to a Domino database, such as those with No Access or Depositor access levels, to modify public documents when granted the optional Write public documents privilege. Expand the section below for more details.

Public access behavior via nHTTP for users with No Access or Depositor access levels
Access level w/ Optional privilege Access details
No access - Read public documents
- Write public documents		 Allows a user to:
- Read public views, while seeing only public documents (Author/Reader fields do not override).
- Read public documents, even if the form is not marked $PublicAccess.
- Create new public documents.
- Update existing public documents.

Restricts a user from:
- Reading non-public views.
- Reading non-public documents (Author/Reader fields do not override).
- Creating non-public documents, even when using a public form.

Summary:
Users can interact with public elements consistently, as if they're a separate layer of the Domino database.
No access Read public documents Allows a user to:
- Read public views, while seeing only public documents.
- Read public documents, even if the form is not marked $PublicAccess.

Restricts a user from:
- Reading non-public views.
- Reading non-public documents (Author/Reader fields do not override).
- Creating new public documents.
- Updating existing public documents.

Summary:
Users can interact with public elements consistently, as if they're a separate layer of the Domino database, but cannot write anything.
No access Write public documents Restricts a user from:
- Reading public and non-public views.
- Reading public documents.
- Reading non-public documents (Author/Reader fields do not override).
- Creating new public documents, even if the form is marked $PublicAccess.
- Updating existing public and non-public documents.

Summary:
Access configuration provides little benefit at the No Access level.
Depositor - Read public documents
- Write public documents		 Allows a user to:
- Read public and non-public views, while seeing only public documents (Author/Reader fields do not override).
- Read public documents, even if the form is not marked $PublicAccess.
- Create new public documents.
- Update existing public documents.

Summary:
Similar to the access privileges of the access level No Access, but allows reading non-public views and creating non-public documents.
Depositor Read public documents Allows a user to:
- Read public and non-public views, while seeing only public documents (Author/Reader fields do not override).
- Read public documents.
- Create new public and non-public documents.

Restricts a user from:
- Reading non-public documents (Author/Reader fields do not override).
- Updating existing public and non-public documents.

Summary:
Similar to the access privileges of the No Access access level, but with the added ability to create new public and non-public documents.
Depositor Write public documents Allows a user to:
- Read public and non-public views, but seeing no documents (Author/Reader fields do not override).
- Create new public and non-public documents.

Restricts a user from:
- Reading public documents.
- Reading non-public documents (Author/Reader fields do not override).
- Updating existing public and non-public documents.

Resolved issue

  • Fixed an issue where attachments with some special characters in the filename could not be downloaded using the GET v1/attachments/{unid}/{attachmentname} endpoint.

  • Fixed an issue where authentication using Microsoft Entra ID as an external identity provider (IdP) for the Admin UI and Office Round Trip Experience redirected users to an error page.

  • Fixed an issue where newly created meetings with participants were treated as broadcast calendar entries. This prevented invitees from accepting or declining meetings and organizers from receiving attendee responses.

Others

  • Installer jar files:

    • For Domino 14.5: restapiInstall-r145.jar
    • For Domino 14: restapiInstall-r14.jar
    • For Domino 12: restapiInstall-r12.jar

  • Docker image version for docker compose .env file (CONTAINER_IMAGE):

    • For Domino 14.5: domino-rest-api:1.1.7-r145
    • For Domino 14: domino-rest-api:1.1.7-r14
    • For Domino 12: domino-rest-api:1.1.7-r12

  • Docker image version for docker compose .env file from Harbor:

    • For Domino 14.5: hclcr.io/domino/restapi:1.1.7-r145
    • For Domino 14: hclcr.io/domino/restapi:1.1.7-r14
    • For Domino 12: hclcr.io/domino/restapi:1.1.7-r12