Defining parameters for a path

Path parameters can specify variable elements of a URL path, query parameters, headers, or a request body. The parameters apply to all the operations defined under the path. A Path parameter can be overridden at the operation level but cannot be removed there.

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 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 2.0 API definition.
  2. Expand Paths.
  3. Expand the required Path, then, if there already one or more parameters defined, expand Path Parameters.
  4. 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 Path 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.