Defining Catalog specific property values

For any API property, you can define a value that is specific to a particular Catalog. For any API published to that Catalog, the API property assumes the Catalog specific value, overriding any default property value.

Before you begin

You must have previously created the API property that you now want to define a Catalog specific value for; see Setting API properties.

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.

Tip: If you add or change an API property on an API that is already staged or published, you must re-stage or re-publish the Product that contains the updated API for the change to take effect.


  1. Open the API for editing, as described in Editing an OpenAPI 3.0 API definition.
  2. Select the Gateway tab, expand Gateway and portal settings then, if there are already one or more Catalog specific property values defined, expand Catalog Properties.
  3. Configure a Catalog specific property value.
    • To define a new Catalog specific property value, complete the following steps:
      1. Click the add icon OpenAPI 3.0 API add icon alongside Catalog Properties in the navigation pane.
      2. Type the Catalog Name exactly as it displays in the name field for the selected Catalog.
        Tip: For the best result, manually type the catalog's name instead of selecting its title. Using the catalog name is safer than using its title, because the title might not be unique within the provider organization and might be modified later (which breaks the association between the property and the catalog). The catalog's name is always unique within the provider organization and cannot be changed.
      3. Click Create. The Catalog properties details for the specified catalog are displayed for further editing.
      4. Alongside Property Overrides, click Add.
      5. Provide the following information:
        • Property Name: Enter the name of the API property that you want to define a Catalog specific value for. The name must match the name of a previously defined API property; see Setting API properties.
        • Property Value: The Catalog specific property value. Leave blank if the property is to have a null value by default.
      6. Click Create.
    • To modify an existing Catalog specific property value, click the Catalog name in the navigation pane. You can then change the Catalog name, and add, modify, or delete property override settings.
  4. Click Save to save your changes.