Viewing the APIs associated with a Runtime

Edit online

Before you begin

Make sure that you are assigned to the API platform providers, API product managers, or API Control Plane administrators user group.

About this task

To manage and monitor the APIs across runtimes efficiently, API Control Plane gives a consolidated view of the APIs associated with a specific runtime.

Procedure

  1. Click the Catalog > Runtimes tab.
    A list of all the available runtimes in API Control Plane appears.
  2. Select the Details option from the Action menu corresponding to the runtime for which you want to view the associated APIs.
    The runtime details page appears.
  3. Click the Relations tab.

    A list of all the APIs associated with the runtime appears.

    Next steps

    • The API Control Plane user can use the information that is displayed to view the status of APIs, gain insights of the API performance, monitor the API usage and performance of APIs.
    • API Control Plane provides an option to view the API details within the runtime through the Open in runtime option.
      • To view the APIs associated with IBM webMethods API Gateway within the runtime, make sure that the runtime's host field is either configured at the time of registration with API Control Plane or by updating the hostname by using the Edit runtime option in the API Control Plane UI.
      • To view the APIs associated with any other type of runtime, make sure that,
        • Runtime's host field is either configured at the time of registration with API Control Plane or by updating the hostname by using the Edit runtime option in the API Control Plane UI.
        • API's relativeWebUrl is configured with a deep link to its corresponding API details page in the runtime. The API's relativeWebUrl must be sent along with the API's details by the runtime agent during API publish or synchronization activity. For details, see API Management.
      For example, if the URL for an API is https://example-runtime.eu-west.org/api/catalogs/9447291d-09b7-43c0-bc21-dc7f77c5a1de/096880bc-d9e4-4e46-8e8a-1ec32a056ec1/apis/ff9b5d9e-5cce-4ed2-9a88-3f45dd5117d2, to make the Open in runtime work in API Control Plane, set the following for a runtime (during runtime registration) and for an API in the agent.
      • Runtime payload. Set the host field to https://example-runtime.eu-west.org
      • API payload. Set the relativeWebUrl to /api/catalogs/9447291d-09b7-43c0-bc21-dc7f77c5a1de/096880bc-d9e4-4e46-8e8a-1ec32a056ec1/apis/ff9b5d9e-5cce-4ed2-9a88-3f45dd5117d2
    • If the API is associated with just IBM webMethods Developer Portal runtime and not with any other runtimes, then the Open in runtime option is not applicable.