Forward proxy settings for your API Gateway
Within the API Gateway settings page there are specific settings that enable you to set up a forward proxy for your API Gateway. To set up a forward proxy, you must set each of these settings within the settings of the API Gateway.
Properties panel, custom tab
You can use the Properties panel Custom tab to set container and system properties that are not shown on the Basic or Advanced tabs, to modify the configuration of an API Gateway. Only certain properties are available to view if the Gateway is offline.
Many properties require you to restart the Gateway after you set or change the property. Select the Restart on Save option before saving the properties. Only Gateway owners can restart them.
When you open the Properties panel, the properties that were in effect when the Gateway started are shown. If you modify the properties after the Gateway started, those changes will not take effect until you restart the Gateway.
We do not validate the properties that you set on the Custom tab.
Container properties
The <installation\_directory\>/conf/container.properties file stores container properties for an API Gateway. Although you can use a text editor to edit these properties in this file, We recommend editing the properties in the Properties panel instead.
Set the following custom container property as part of your forward proxy set up. This custom property is only available locally, remote access is not supported.
com.boomi.container.proxyPassword
Set this value to the clear-text value of your password.
If you use the ProxyUser property without setting the password, the API Gateway will not start. In this case, errors are not logged.
For information about other properties, refer to API Gateway settings.
System properties
The <installation\_directory\>/bin/atom.vmoptions file stores system properties for an API Gateway.
You must set one of the following two custom system properties if your forward proxy requires user authentication.
-Djdk.http.auth.tunneling.disabledSchemes=""
Set this property for secure (https) API Gateway connections.
-Djdk.http.auth.proxying.disabledSchemes=""
Set this property for unsecure (http) API Gateway connections.
Forward proxy settings panel
Use the Forward Proxy Settings panel to specify the forward proxy server settings for API executions. A forward proxy accepts requests sent from the API Gateway and forwards the requests to its desired destination. The forward proxy settings on the API Gateway apply to connections to the backend Atoms, runtime clusters, or Clouds, or to third-party services (such as an API Proxy). They also apply to connections to the Identity Provider with JWT Authentication.
Host Address
The IP address or DNS name associated with the forward proxy server.
Port Number
The Port number associated with the forward proxy server.
Proxy Type
The Proxy Type, HTTP or SOCKS5, associated with the forward proxy server’s port.
User Name
The user name associated with the forward proxy.
Password
The password associated with the user for the forward proxy.
