Skip to content

Configure ports in production

Domino REST API uses ports which have different purposes. Each of these ports have a default port number. For example, the main API port has a default port number of 8880 and the port for Prometheus metrics has a default port number of 8890.

About this task

The procedure guides you on how to create a new configuration setting to change the default port number of the ports.

Before you begin

Check the configuration parameters to learn the parameters and allowed port numbers to use in the new configuration setting.

Procedure

  1. Create a JSON file using a text editor.

  2. Add a JSON object to the JSON file. The JSON object includes the parameter corresponding to the port to be configured and the new port number.

    For example:

    {
"PORT": 8857,
"MANAGEMENTPORT": 9000
}

    The example JSON object will change the port number of the main API port from 8880, which is the default, to 8857. The example will also change the port number of the port for accessing the Management Console from 8889, which is the default, to 9000.

  3. Save the JSON file in the keepconfig.d directory.

    Tip

    Use a filename for the JSON file that reveals its purpose. To learn more on how JSON files in keepconfig.d are processed, see Understanding configuration.

  4. Restart Domino REST API on all servers.