Working with APIs

For a specific Product, you can work with the APIs that are contained in the Plans in that Product.

Procedure

Note: In the The Help icon.Help page of the API Manager, and API Designer user interfaces, there's a Product information tile that you can click to find out information about your product versions, as well as Git information about the package versions being used. Note that the API Designer product information is based on its associated management server, but the Git information is based on where it was downloaded from.
To work with the APIs in a Product, complete the following steps:

  1. List the Plans in the Product:
    1. In the navigation pane of the API Manager UI, click Manage icon in the API Manager UI navigation pane Manage, then select the catalog that you want to work with.
    2. If spaces are enabled in the catalog, select the space that you want to work with by completing the following steps:
      1. Click the Spaces tab.
      2. Select the space that you want to work with.
    3. If the Products page is not already displayed, click the Products tab.
    4. Alongside the Product version that you want to work with, click the options icon options icon, then click View Plans.
      A window opens listing the Plans in the Product.
  2. Alongside the required Plan, click View APIs.
    A window opens listing the APIs in the Plan.
  3. Alongside the required API, click the options icon options icon.
    You can then select from the following options:
    • Take Offline: if you take an API offline, the API is no longer available to be called. When required, you can make the API available again by selecting Online.
    • View Products: a window opens listing all the Products that contain the API. If required, you can click the options icon options icon alongside a Product to work with that Product. For details of the available options, see Managing your Products.
    • View Plans: a window opens listing all Plans, across all Products, that contain the API. If required, you can click the options icon options icon alongside a Plan to work with that Plan. For details of the available options, see Working with Plans.