Domino REST API gives other systems secure access to data in Notes databases over a modern REST API with JSON.
Domino REST API gives other systems secure access to data in Notes databases over a modern REST API with JSON. It is the most important new technology in HCL Domino for many years, and it opens the platform to modern development.
What can Domino REST API do?
The API, also known as DRAPI or Project Keep, runs as a separate process alongside the Domino server. It provides:
- CRUD on documents: create, read, update and delete over HTTP.
- Views as JSON lists with sorting and search.
- OpenAPI description, so developers can generate clients for C#, TypeScript or Python.
- OAuth and JWT login, so users can sign in with Microsoft Entra ID.
- Access control that respects the database ACL and reader fields, so nobody gets more access than in the Notes client.
Why does it matter?
Integration with Notes used to require either the Notes client, XPages or custom code in LotusScript. With the REST API, a web developer with no Notes knowledge can build a React app, a Power App or a Power Automate flow directly against Notes data. That makes it realistic to modernise the user interface without moving the data.
Typical uses
- A new web portal on top of an old Notes application.
- Synchronising customers or cases to a CRM or finance system.
- Power BI reports directly from Notes data.
- AI integration, where a language model reads and writes in Notes through the API.
- Gradual migration, where new systems read Notes data until it can be switched off.
Common questions about Domino REST API
Which Domino version is required?
Domino 12.0.2 or newer. We recommend Domino 14 or 14.5.
Does it cost extra?
No. It is included in the Domino licence.
Is it safe to open Notes to the web?
Yes, when set up correctly. The API should sit behind a reverse proxy with TLS, and each database must be explicitly enabled. We always do a security review before going live.
Help with the REST API
We set up Domino REST API and build integrations and modern frontends on top. Read about Notes development.
