Specifying gateway and portal settings

Define general configuration settings for your API.

About this task

  • This task relates to configuring an OpenAPI 3.0 API definition. For details on how to configure an OpenAPI 2.0 API definition, see Editing an OpenAPI 2.0 API definition.
  • OpenAPI 3.0 APIs are supported only with the DataPower® API Gateway, not with the DataPower Gateway (v5 compatible).
  • For details of current OpenAPI 3.0 support limitations, see OpenAPI 3.0 support in IBM® API Connect.

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

At any time, you can switch directly to the underlying OpenAPI YAML source by clicking the Source icon OpenAPI Source icon. To return to the design form, click the Form icon Form icon.


  1. Open the API for editing, as described in Editing an OpenAPI 3.0 API definition.
  2. Select the Gateway tab, then click Gateway and portal settings.
  3. Provide the following information:
    • Phase: The phase of the lifecycle that your API is in; select one of the following options:
      • Realized (default) - The API is in the implementation phase.
      • Identified - The API is in the early conceptual phase and is neither fully designed nor implemented.
      • Specified - The API has been fully designed and passed an internal milestone but has not yet been implemented.
    • Testable: Select this option to allow the API's operations to be tested using the test tool in the Developer Portal.
      Note: For the test tool to work, an API must be included in a Plan in a Product that is staged in a Catalog.
    • CORS: Enable and configure cross-origin resource sharing (CORS) support for your API. For details, see Enabling CORS support for an API.
    • Target Services: Define web services that you want to use in your API definition. For details, see Defining target services for an API.
    • Enforced: Select this option to enforce the API by using the DataPower API Gateway. Clear this option if you are managing the API on a gateway other than the DataPower API Gateway. Although not published to a gateway by API Connect, an unenforced API is still available in the Developer Portal for subscription by application developers.
    • Properties: Add properties that can be referenced in your API definition. For details, see Setting API properties.
    • Catalog Properties: Define property values that are specific to a particular Catalog. For details, see Defining Catalog specific property values.
    • Activity Log: Configure your logging preferences for the API activity that is stored in Analytics. For details, see Configuring activity logging.
    • Exxtensions: Extensions added to the API to extend the OpenAPI specification. For details, see Adding an OpenAPI extension to an API.