Gateway configuration

Platform 6.4+

Use Gateway Configuration in Admin Essentials to configure how integrations execute through your customer-hosted Itential Automation Gateway 5 (IAG 5) deployment. Outbound API calls originate from your IAG 5 environment rather than from Itential’s cloud, so they pass through your existing network controls.

If your network requires outbound traffic to pass through a proxy server, you can configure it here once and all integrations inherit it by default.

Before you begin

At least one gateway cluster running IAG 5 version 5.4 or later must be registered in Gateway Manager. For information, see Gateway Manager overview and Create a gateway cluster.

Set the Platform default cluster

Use the Platform Default section to designate the default gateway cluster that all IAG 5-dependent features inherit when no feature-specific cluster is set.

Setting the Platform default cluster does not guarantee availability. If the cluster configured for a specific feature becomes unavailable, Platform returns an error — it does not fall back to the default.

To set the Platform default cluster:

In Admin Essentials, go to Gateway Configuration.

In the Platform Default section, select a Default Cluster from clusters registered in Gateway Manager.

Click Save.

Some considerations:

If the designated cluster is disconnected or becomes unavailable after you save, IAG 5-dependent features become inaccessible and you must reconfigure this setting.

Configure integration settings

Feature-Specific Execution Defaults lets you choose a different gateway cluster for a specific feature, such as integrations, and configure additional settings for it. These settings apply to all integrations by default. Individual integrations can override the cluster and proxy settings configured here. For more information, see Manage integrations.

Override the cluster for integration

By default, integrations use the Platform default cluster. To route integrations through a different cluster:

Under Integrations, select a cluster from the Default cluster dropdown.

Click Save. Integrations use this cluster instead of the Platform default.

Select a default execution mode

The Default Execution Mode setting controls how integration requests are routed. Each integration can override this setting from its own configuration page.

Select an execution mode

Under Integrations, select one of the following from the Default Execution Mode dropdown:

Execution mode	Description
Direct connection	Requests are executed from Platform without a cluster or proxy server. Use this for internal services that don’t require gateway routing.
Default cluster, no proxy	Requests are executed from the feature-level default cluster without a proxy server. Use this when gateway execution is required but your network doesn’t use a proxy.
Default cluster with proxy	Requests are executed from the feature-level default cluster and an outbound proxy server. Selecting this mode reveals proxy configuration fields.

Configure proxy settings (Default cluster with proxy only)

If you selected Default cluster with proxy, configure the following fields:

Platform supports HTTPS proxies only.

Field	Description
Hostname or IP address	The hostname or IP address of the proxy server.
Port	The port used to connect to the proxy server.
Proxy authentication type	The authentication method for the proxy server. Options: No authentication, Basic authentication, or Secrets manager.

For Proxy authentication type, configure one of the following:

Basic authentication: Enter a username and password.
Secrets manager: Enter the keys used to look up the proxy credentials. Platform retrieves the credentials at runtime. For supported systems and setup, see Secrets management overview.

Save

Click Save. Changes take effect immediately, without a Platform restart.