Specifying a gateway type for an API definition

An API definition is specific to one or other of the gateway types, DataPower® API Gateway or DataPower Gateway (v5 compatible). API definitions must specify which type of gateway the API uses.

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 must specify which type of gateway each API uses. APIs can use only one type of gateway.

When you modify your API definitions to use a specific gateway type, you must ensure that each policy and policy version in the API are supported by the gateway type. DataPower Gateway (v5 compatible) and DataPower API Gateway each support policies that the other gateway type does not. In some cases, the same policy is supported by both gateway types, but with a different version number.

For example, DataPower Gateway (v5 compatible) supports version 1.0.0 of the invoke policy, but DataPower API Gateway requires version 2.0.0.

For information on policies, see execute.

For information on policy versions, see the documentation for each individual policy. For example, to review the invoke policy, see invoke.


  1. Edit the API definition YAML file and add the gateway type. For example:
    • DataPower Gateway (v5 compatible):
      gateway: datapower-gateway
    • DataPower API Gateway
      gateway: datapower-api-gateway
    Note: If your API YAML file includes the gateway: property, the enforced: property must be set to true
  2. Ensure that the policies, including policy versions, in your APIs are supported by the gateway type. Review the list of policies on the execute page. If necessary, review the individual policy pages to determine the supported version number.
  3. Ensure that any Product that uses this API is configured to use the same gateway type. See Specifying a gateway type for your Product.