OpenAPI definitions and specifications
The Domino REST API is driven by multiple OpenAPI 3.0.2 specifications. Every Domino server is surfacing the specifications according to its configuration. Additionally each configured access to a database (referred to as scope) is available on your server.
The definitions below serve as reference and guide, so you can learn about the API without having the API installed.
API definitions are individual
Please note: depending on your server configuration, not all endpoints will be active. Custom access definitions are not visible here
The main API of the Domino REST API. It allows access to documents, views, folders, and agents. An external application will only need this specification.
Access to administrative functions allowing to manage:
- Access control lists (ACL)
The setup API provides endpoints to configure access to databases. You can specify what documents, views, folders, agents, and items are made available in the REST API. Requires designer access to databases and
PIM stands for "Personal Information Management" and includes access to mail, calendar, contacts, todos, and notebook. Access is based on users ownership of mail resources.
We named this API in honor of an Apache project that enables the access to Microsoft office formats.
The OpenAPI specification is extensible, for one you can define new data types beyond the default types and you can introduce new method attributes prefixed with
We added the following data types:
- Names : translate from/to a Domino names item
- Authors: translate from/to a Domino authors item
- Readers: translate from/to a Domino readers item
|active since which API version, governed by config.json
|In which mode client, server, light is this unavailable
|Is the endpoint available as preview only
|ANY, $SETUP -> scope requirements for endpoint
|specify content use (attachment vs. inline)
We really like to hear from you!
Your opinion matters. Let us know all your:
Join the OpenNTF Discord channel.