Skip to content

Configuration parameters

Domino REST API is preconfigured with settings that allow you to get started right away. However, you should familiarize yourself with all configuration parameters and security settings before you deploy into a production environment.


  1. Log in into the Management console (Port 8889).

    Make sure that the administration location can only be accessed from a network that can be accessed by a your system administrator.

  2. Go to the keepconfig.d and open the config.json. The default configuration settings are here, config.json.

  3. Only copy the one where you need to modify your config.json values.


    Place your measurements behind a firewall that only your metric server can access. This ensures that only authorized users can access the data. If you don't use a metric server, the firewall should have its protection completely disabled.

  "metrics": {
    "enabled": false,
    "jvmMetricsEnabled": false
4. Click Save in .json format.

  1. Restart Domino REST API on all servers with this new configuration.

Understanding configuration

The configuration follows the concept of an Overlay File System. The base configuration is retrieved from the installation directory or jar files.

When jar files contain a resource /config/config.json, that configuration file is added to total configuration.

Then, it's overlaid with any JSON files in the keepconfig.d directory within the Notes data directory and then finally, with any environment parameters.


The call hierarchy

All files contribute JSON, which are overlaid on top of each other. JSON elements with same names get overwritten. Arrays are replaced and not overwritten.

The JSON files in keepconfig.d are processed in alphabetical order. Last entry wins. This processing order allows you, for example, to disable elements temporarily through settings in a z-final-words.json file without impacting the permanent configuration.