Understanding the APIs List Page

The APIs List page displays all APIs created in the Management Portal.

Entries for APIs display the following information:

  • The name and version of the API.

  • The state of publication of the API: Published, Never Published, or Unpublished.

  • The state of the API: Alpha, Beta, Deprecated, Released, or Retired.

  • The description of the API.

  • The date and time the API was created and which user created it.

  • API Portal URL: If published, a link to the page on the Developer Portal is displayed. If not published, a Never Published label is displayed.

Note:

The information you see on this page, and the tabs for an API, depends on the grants that you have. For example, if you are an API Manager with the View Details Grant, you will only be able to view the Publication tab.

If you have a long list of items on the page, you can search or sort the list to find the item you want.

  • Sort: Use the Sort list to display the newest items first or display them in alphabetical order.

  • Search: Use the Search By Name field to do a simple search by entering the name of the item you want to find and pressing Enter. The search finds the text that you entered anywhere within the name, even within words. For example, if you enter product, it will find production as well.

  • Advanced Search: Use the Advanced link to create an advanced search query. The link displays a list of fields you can search which are appropriate for the page, such as Created By, Description, or Version. Enter text in the fields to search and click Apply to apply all the conditions.

  • Saving a Search: Once you have performed a search, the conditions you used for the search appear at the top of the list, along with Save and Clear links. To save the search, click the Save link and enter a name for the search. You can also choose to use it as the default search for the page. To use a saved search, click the list arrow next to the Search By Name field and select the search you want to apply.

    Note:

    If you set a search as a default for a page, the results of that default search appear when you navigate to that page. To view all items, you must clear the search.

  • Editing a Search: To edit the conditions that a search uses, apply the search, and then add or delete conditions as desired. Save the search with the same name.