Defining parameters for an API

Parameters can specify variable elements of a URL path, query parameters, headers, or a request body.

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. If there already one or more parameters defined, expand Parameter Definitions.
  3. You can either create a new parameter, or edit any existing parameter.
    • To create a parameter, click the add icon OpenAPI 2.0 API add icon alongside Parameters, then refer to Creating a parameter.
    • To edit an existing parameter, click the parameter name in the navigation pane, then refer to Editing a parameter.