Skip to content

What's new for Domino REST API v1.1.8

Release date: September 14, 2026

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

Note

Entries highlighted in red indicate changes that may impact your applications. Review these changes before upgrading.

Experimental features

The Domino REST API introduces experimental support for new APIs that extend integration capabilities with Domino applications and data. The new APIs provide additional ways to work with calendar data, contacts, and Domino design elements.

  • The CalDAV Extension APIs enable calendar interoperability by allowing clients to access and manage Domino calendar data using the CalDAV protocol.

  • The CardDAV Extension APIs provide standards-based access to Domino contacts and address book information.

  • The DXL Extension APIs extend Domino design management capabilities by enabling programmatic access to Domino design elements through DXL-based operations. For more information, see the DXL Extension API section.

Important

  • These APIs are available as experimental features and are provided for users to try and evaluate. They are not yet supported for production use. These APIs are disabled by default. To enable any or all of them, see Enable CalDav, CardDav, and DXL extension APIs.

  • The CalDAV Extension APIs and CardDAV Extension APIs have been tested only with Mozilla Thunderbird1.

    Currently, questions and issues are only supported for scenarios involving Mozilla Thunderbird1.

For any feedback, questions, or issues, you may post them in the OpenNTF Discord channel link image.

New features

  • Added the GET pim-v1/attachmentnames/{unid} endpoint to retrieve a list of all attachments on a mail document. The endpoint supports query parameters that allow applications to return protocol URLs for attachments with supported file extensions, include attachment metadata, and discover embedded files in Rich Text fields by returning their paths.

    Tip

    You can use the path returned for a discovered embedded file as the value of the attachmentName parameter in the GET pim-v1/attachments/{unid}/{attachmentName} endpoint to download the file.

  • Added the POST pim-v1/calendarprofile endpoint to create or update an authenticated user’s calendar profile document.

  • Added the PATCH pim-v1/calendarprofile endpoint to update individual settings in the authenticated user’s calendar profile document.
  • Added a Light/Dark/System mode theme switch to the login page and side navigation pane of the Admin UI, allowing users to switch between light, dark, and system themes for a more comfortable and customizable user experience.
  • Added the Diff View mode to the Source tab of the Schema Management page in the Admin UI. The Diff View mode lets users compare the current saved database schema with their in-progress edits while modifying the schema. For more information, see Edit database schema JSON.

Improvements

  • Enhanced the GET v1/info endpoint to include the Domino server canonical name in the API response.
  • Enhanced the GET v1/lists/{name} endpoint to return the correct document results for categorized views when using the key parameter together with the scope=documents query parameter, even for large views exceeding 500 documents.
  • Improved processing speed when retrieving form field values, especially when working with large numbers of documents.
  • Updated relevant endpoints, making sure that the richTextAs query parameter defaults to HTML output instead of MIME when no parameter value is assigned.
  • Updated the POST v1/query/qrp/json endpoint so that the forms array is now a required request property.
  • Enhanced console visibility by showing top-level messages on the Domino console for ERROR and FATAL messages. This helps administrators more easily monitor and manage the environment.
  • Enhanced the GET setup-v1/dxl endpoint to improve the reliability of the DXL export. This is achieved by skipping design elements that cannot be processed due to corruption, access restrictions, or other exceptions, logging the issue to the domino-keep.log, and continuing with the processing of the remaining elements.
  • Enhanced the POST v1/query endpoint by improving query handling for soft-deleted documents that might still appear in view indexes. This is achieved by skipping them during processing to minimize request failures and improve the overall query reliability.

  • Added the computeTotalCount query parameter to the GET v1/lists/{name} endpoint to control whether to compute the x-total-count header and return it with the result. The query parameter is set to true by default. Setting the value of the query parameter to false significantly improves processing time by avoiding the computation of the x-total-count header and its subsequent return with the result.

    You can also configure the value of the computeTotalCount query parameter in a configuration file in keepconfig.d. For more information see, Configure computeTotalCount query parameter.

  • Improved notes.ini update handling of the Domino REST API installer to accurately preserve existing ACL rights when updating notes.ini, and prevent loss of access control settings that could affect Domino service startup after an installation or upgrade.

  • Updated the serialization of the checkAccess query parameter values so that multiple values are now passed as a comma-separated list, as required by the GET v1/userinfo endpoint.
  • Enhanced several error messages with better wording and context to help users better understand and resolve issues.
  • Domino REST API now standardizes nsfPath values internally to use forward slashes across all supported platforms. This improves cross-platform compatibility and ensures consistent NSF database path resolution when moving or replicating configurations between Windows and Linux environments.
  • Specifying the date, time zone, and duration is now required when creating or updating a calendar entry via PUT. When updating via PATCH, if you update any of the date, time zone, or duration fields, you must include all three fields in the payload.
  • Enhanced the PIM APIs to be able to open a user’s mail file from an available cluster member when the user’s primary mail server is unavailable. This improves API availability in clustered Domino environments.
  • Improved calendar time zone handling in the PIM APIs, as APIs now use the Windows Time Zone Index from the StartTimeZone field when available, improving accuracy when processing calendar entries.
  • Modified the GET pim-v1/calendar/profile endpoint to GET pim-v1/calendarprofile endpoint and ensured that it no longer creates or accesses a secondary mail database when not required.
  • Enhanced the POST pim-v1/search endpoint to support optional boolean parameters, ftRefresh and viewRefresh, that control whether the corresponding full-text index and view index are refreshed before a DQL-based search. This ensures that recently added or modified data is available to the search before the query is executed.
  • Refreshed the Domino REST API Admin UI to provide a cleaner, more consistent look and feel throughout the administration experience.
  • Added the Consents Management - OAUTH dashboard card to the Admin UI Overview page, providing another way to easily access the OAUTH Consents page.
  • In the Admin UI, added a confirmation dialog to the Form Schema page that prompts you to save when there are unsaved changes, and you leave the Form Schema page, create a new form mode, or switch to a different form mode.
  • Provided direct access to the Domino REST API home page from the Admin UI by clicking the Domino REST API icon at the top of the side navigation panel.
  • Implemented functional improvements across all PIM Calendaring endpoints.

Resolved issues

  • Fixed functional issues across all PIM Calendaring endpoints.
  • Fixed issues with key rotation for Keycloak and other OIDC providers.

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.8-r145
    • For Domino 14: domino-rest-api:1.1.8-r14
    • For Domino 12: domino-rest-api:1.1.8-r12

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

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

  1. Mozilla and Thunderbird are trademarks of the Mozilla Foundation in the U.S. and other countries. ↩↩