Link Search Menu Expand Document
Early Access
Still Bugs!


Download 12.0.1-EarlyAccess Beta3 .

What’s New

Here’s what’s new in 12.0.1-EarlyAccess Beta3:

  • Java based installer that works on all platforms (bugs fixed)
  • Docker container uses Domino 12.0.1 Beta
  • New endpoints
    • bulk/create
    • bulk/update
    • bulk/delete
    • vcalendar/{calid}/{unid}
  • Updated Postman test
  • Start script fixes
  • vert.x updated to 4.2.0
  • Dependencies updated
  • Reworked KEEP task (no more pipe errors)
  • Updated templates

Let’s get started

To get up and running quickly, you will need to:

  • Install KEEP on a Notes client or a Domino server.
  • Pick a database you want to work with (you could use demo.nsf).
  • Use the KEEP API to enable the database for REST access:
    • Pick the forms and fields to expose.
    • Pick the views you want to be REST accessible.
    • (Optional) pick the agents.
  • Try out the API.

You can use the built-in Swagger API, curl, or the KEEP Admin UI. To help you, use one of the following tutorials. We have a curl based keep shell script for you to play with.



The Postman collection has sample interactions with the local sample Demo.nsf, go check it out


Ensure your endpoints are secure. Bring up a browser and verify that you can hit these endpoints:

Endpoints Ports Details Webpages
KEEP API Home Page 8880 Start page StartPage
Live KEEP API 8880 Interact live with the API OpenAPI
Admin UI 8880 Login with an admin user. LocalDomainAdmin member Admin Login
Management API 8889 Access to the log and runtime info Server Info
Prometheus Metrics 8890 Performance info in Prometheus format. Protected with basic authentication (metrics/metrics)  
Auth 8880 The endpoint, [POST] http/s://${HOST}:8880/api/v1/auth, is the default end point to exchange Domino web credentials for a JWT access token. For example, use the token in Postman request headers as a Bearer authentication header. You also can use your own IdP to gain access tokens  

What’s next?

Based on your interest, start by exploring the following sections of this documentation: