Specifying gateway and portal settings

Define general configuration settings for your API.

About this task

Note: This task relates to configuring an OpenAPI 2.0 API definition. For details on how to configure an OpenAPI 3.0 API definition, see Editing an OpenAPI 3.0 API definition.

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 that corresponds to the design form in the user interface by clicking the Source icon OpenAPI Source icon. To return to the design form, click the Form icon Form icon.


  1. Open the required API for editing, as described in Editing an OpenAPI 2.0 API definition.
  2. Select the Gateway tab, then click Gateway and portal settings.
  3. Provide the following information:
    • 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.
    • 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.
    • 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.
    • Gateway: For details, see Specifying the gateway type for an API definition.
    • Application Authentication: Enable application authentication to protect your API with a certificate. For details, see Configuring application authentication for an API.
    • Application Authentication Source: If application authentication is enabled, specify how the client certificate is sent to the gateway. For details, see Configuring application authentication for an API.
    • Activity Log: Configure your logging preferences for the API activity that is stored in Analytics. For details, see Configuring activity logging.
    • Compatibility: For details, see Configuring v5 compatibility options.
    • Html Page: For a GraphQL API, the HTML page with which the API responds to an initial GraphiQL editor request. Currently, the only option is store:///graphiql.html. For more information, see Enabling the GraphiQL editor for a GraphQL API.
    • Graphql Schema: For a GraphQL API, the name of the schema definition that references the imported GraphQL schema. For information on uploading a schema during GraphQL API creation, see Creating a GraphQL proxy API. For information on replacing the schema for an existing GraphQL API, see Using the GraphQL schema editor.
    • Exxtensions: Extensions added to the API to extend the OpenAPI specification. For details, see Adding an OpenAPI extension to an API.