Configure API Server Options

You can adjust the Server Backup Manager settings used for API Server HTTP and HTTPS connections.

Follow the instructions below to configure the API Server options in the Backup Manager.

1. In the Main menu, click Configuration. Server Backup Manager displays the Configuration window.

2. In the Configuration menu, click API Server Options. SBM displays the API Server Options window as shown in the following image.

3. You can define the following options:

Enabled. Select the checkbox to enable HTTP for API Server.
Port. Enter the port that the API HTTP Server will listen on in the provided text box. Default port is 9080.
Max Connections. Define the largest simultaneous number of API connections via HTTP protocol. Default value is 100.

Enabled. Select the checkbox to enable the HTTPS connection for the API Server.
Port. Enter the port the API HTTPS server will listen on in the text box. Default port is 9443.
Max Connections. Define the largest simultaneous number of API connections via HTTPS protocol. Default value is 100.
Keystore Path. Contains the full path to the file with the SSL key. Example: /usr/sbin/r1soft/bin/../conf/keystore.

4. Click Save. SBM displays the Restart Web Server window, as shown in the following image.

Changing the API server options requires the Web Server to be restarted.

Notice
Restarting will not interrupt any running tasks.

5. Click Yes to restart the Web Server.

Notes

If you change your port number, browse to the new URL manually.
If you disabled a protocol, you will need to switch to the other protocol manually. Otherwise, the page automatically redirects you when the server resumes.
If the Web Server does not restart in about 30 seconds, check server logs for errors.
Release 5.12.0+ support only TLSv1.2 for SSL by default. In 5.12.1 you may downgrade the API TLS version by specifying "api-tls-version" in the api.properties file of your Backup Manager. The following case sensitive values can be used: TLSv1, TLSv1.1, and TLSv1.2. If a different value is used, the server will fallback to "TLSv1.2".