Specifying the gateway type for a Product

You can edit the Product configuration to specify a gateway type.

Before you begin

IBM® API Connect supports two gateway types: DataPower® Gateway (v5 compatible) and DataPower API Gateway.

DataPower Gateway (v5 compatible) has been available with IBM API Connect for a number of years. The DataPower API Gateway is a new gateway that has been designed with APIs in mind, and with the same security focus as DataPower Gateway (v5 compatible).

For more information on how to choose which gateway type to use, see API Connect gateway types.

About this task

You can complete this task either by using the API Designer UI application, or by using the browser based API Manager UI.

You can specify the gateway type for a Product.

Products can use only one type of gateway, and the APIs in the Product must use the same type of gateway.

When you create a new Product, or import a Product definition that has no gateway type configured, the gateway type defaults according to the gateway types of the gateway services that are enabled in your Sandbox Catalog, as indicated in the following table.

Table 1. Default gateway type for a new Product
Gateway Service enablement in Sandbox Catalog Default gateway type for new Product
No gateway services enabled DataPower API Gateway
At least one gateway service of each type enabled DataPower API Gateway
One or more gateway services only of type DataPower API Gateway enabled DataPower API Gateway
One or more gateway services only of type DataPower Gateway (v5 compatible) enabled DataPower Gateway (v5 compatible)
If you import a Product definition that already has a gateway type configured, that gateway type is retained.

For details of how to enable gateway services in a Catalog, see Creating and configuring Catalogs.


To specify the gateway type for a Product, complete the following steps:

  1. Ensure that you know the type of gateway that your APIs are configured to use.
  2. In the navigation pane, click Develop icon in the API UI navigation paneDevelop, then select the Products tab.
  3. Click the title of the Product you want to update.
  4. On the Product Setup page, go to the Gateway Type section. Select the gateway type for your Product:
    • DataPower Gateway (v5 compatible)
    • DataPower API Gateway
  5. Click Save to retain your changes.