Viewing API list and API details

Edit online

View the list of registered APIs and their details on the Manage APIs page.

About this task

You can activate, delete, or view analytics of a specific API in the Manage APIs page. In addition, you can view API details, modify API details, activate, and deactivate an API in the API details page.

Note: If you encounter any problem in viewing the API details with a message that says API loading is failed, this failure might be because the property watt.server.http.information. The property is set to a value that is not parsed (the default value), which webMethods API Gateway does not support.

Procedure

  1. Open the menu options and select APIs.
    A list of all registered APIs appears. The APIs are sorted based on their names. When there is more than one API with same name, they are sorted based on their system versions. The Date field next to the Version field displays the API creation date. You can also perform the following operations in the Manage API page.
    • Filter APIs by Type, Activation status, or Team.
      Note: The Team filter is applicable only if you enable the Teams feature.
    • Activate an API by clicking the toggle button that denotes a deactivated state. After you activate an API, the Gateway endpoint is available which the API consumers can use.
    • Delete an API by clicking the Delete icon.
    • View API analytics by clicking the Analytics icon.
    • Publish an API by clicking the Publish icon
    • Unpublish an API by clicking the Unpublish icon.
  2. Click an API to view API details.
    The API details page displays the basic information, technical information, resources and methods, and the specification for the selected API. You can edit some of the API details, activate or deactivate an API. Also, you can export, enable or disable mocking, update, and create new version of the API.

    You can view the total number of registered applications in a list that is sorted by name in ascending order. If the list of registered applications is long, then the applications are distributed in more than one page. You can navigate between the pages by selecting the page numbers in the pagination display.

    Note: The link that is provided in the Documentation section of the API details page can be accessed by using webMethods API Gateway internal users credentials. The link cannot be accessed by using SSO user credentials.