Adding tags to an API

You can include tags in API definition. Such tags are added to the OpenAPI definition of the API but are not used by API Connect for any indexing.

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 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 3.0 API definition.
  2. Expand the General then, if there already one or more tags defined, expand Tags.
  3. To add a new tag, click the add icon OpenAPI 3.0 API add icon alongside Tags in the navigation pane. To edit an existing tag, click the tag name in the navigation pane.
  4. Provide the following information:
    • Name (required): The name of the tag.
    • Description: An optional description of the tag. You can use CommonMark syntax for rich text representation.
    • External Docs > URL (available when editing an existing tag): The URL for target documentation that describes this tag.
    • External Docs > Description (available when editing an existing tag): An optional description of the target documentation.
  5. If you are creating a new tag, click Create.
    The tag details are displayed for further editing as described in step 4.
  6. Click Save when done.