Skip to main content

         This documentation site is for previous versions. Visit our new documentation site for current releases.      

OpenAPI tab

Updated on April 6, 2022

Use the OpenAPI tab to view the auto-generated OpenAPI Specification (OAS) documentation that describes the REST services that are included in your service package. The OpenAPI tab displays the REST services in YAML and Swagger.

The OpenAPI tab is available in both REST service rule forms and service package rule forms:

  • In REST service rule forms, use the OpenAPI tab to view the OAS documentation that was generated for an individual REST service rule.
  • In service package rule forms, use the OpenAPI tab to view the OAS documentation for all the service REST rules included in a specific service package.
  • When you select Swagger on the OpenAPI tab, the Server field is displayed. This field lists the application alias URLs for the applications to which the logged-in user has access. To view the Swagger document for the REST services and service packages that belong to an application, select the application alias URL in the Server field. The UI displays the application alias URL, the application server, and the application alias, if applicable.
  • Previous topic Automatically purging invocation history
  • Next topic Creating a REST integration by using the Create REST integration wizard

Have a question? Get answers now.

Visit the Support Center to ask questions, engage in discussions, share ideas, and help others.

Did you find this content helpful?

Want to help us improve this content?

We'd prefer it if you saw us at our best. is not optimized for Internet Explorer. For the optimal experience, please use:

Close Deprecation Notice
Contact us