Configuring proxy server alias

For webMethods API Gateway to use a proxy server, you must define a proxy server alias. Proxy server alias names must be unique across protocols, that is, you cannot have proxy server aliases of the same name but of different protocols.

About this task

When webMethods API Gateway executes a request against a remote server, it issues an HTTP or HTTPS request to the specified target server. If your webMethods API Gateway instance is behind a firewall, and must route these HTTP or HTTPS requests through a third party proxy server, you can configure proxy servers to which webMethods API Gateway routes these requests.

For webMethods API Gateway to use a proxy server, you must define a proxy server alias. The proxy server alias identifies a proxy server and a port on the server through which you want to route requests. You can configure webMethods API Gateway to route requests to one or more proxy server aliases for each type of outbound requests (HTTP, HTTPS).

All the configured and available proxy server aliases are listed in a table with the corresponding details of the port being used, the host on which it is, the protocol used, and so on. To use a proxy server you have to enable it.

Note: Any modifications to the outbound proxy in Integration Server may not reflect in webMethods API Gateway UI. Hence, it is recommended to not configure or modify outbound proxy through Integration Server Administrator UI.

Procedure

  1. Expand the menu options and select Administration.
  2. Select General > Outbound proxies.
    This displays a list of available proxy server aliases and the corresponding details.
  3. Click Add proxy and provide the following information:
    Table 1. Proxy server details
    Field Description
    Alias The alias name of the proxy server.
    Username Optional. The username API must use when accessing this proxy server.
    Password Optional. A valid password associated with the username.
    Hostname or IP address The host name or IP address of the proxy server.
    Port number The port on which this proxy server listens for requests.
    Protocol The type of protocol (HTTP, HTTPS) to use for the host/port combination.
    Set as default Indicates whether this proxy server alias should be the default proxy server alias for its protocol type or not. Click Yes or No. Only one default proxy server alias can be set for each protocol type.
  4. Click Add.