Discover APIs using APIs list

This page applies to Apigee and Apigee hybrid.

Preview — Apigee API hub

This feature is subject to the "Pre-GA Offerings Terms" in the General Service Terms section of the Service Specific Terms. Pre-GA features are available "as is" and might have limited support. For more information, see the launch stage descriptions.

The APIs list is the default page for API hub. It displays a subset of information about all APIs in API hub. The first time you view this page, there are no APIs listed. You must Register or import any APIs that you want to manage using API hub.

• Organization name: Define this displayed name in Settings, Display.
• Search box: Refine the APIs list view by typing search terms here.
• Filter list: Refine the APIs list view by selecting filter items.
• Register API: Enter information about APIs so they appear in the APIs list.
• API name: A list of registered APIs. Click the column head to sort.
• Lifecycle stage: Define the Lifecycle stages in Settings, Lifecycle stages. Select the Lifecycle stage when you register or edit an API.
• Business unit: Define the Business unit in Settings, Taxonomies. Select the Business unit when you register or edit an API.
• Team: Define the Team in Settings, Taxonomies. Select the Team when you register or edit an API.
• Documentation: Select the primary architectural style of the API and upload a description document when you register or edit an API. This button appears only if the API has a recommended deployment set, and that deployment has a version assigned.

To view details about an API, click an API row.

Refine the list of APIs displayed using one of the following options:

• Filter
• Pagination
• Search
• Sort

Filter

Note: The filter options available are configured by a user with administrator permissions. For more information, see Manage taxonomies and Manage lifecycle stages.

To specify filter options:

1. In the Google Cloud console, go to the API hub page.

   Go to API hub

   The APIs list page is displayed by default.

2. Click Filter. The Filter pane opens.
3. Specify or select filter options from the following:
   • Match type: Select to display APIs that Match all or Match any of the selected filters.
   • Lifecycle stages: The progressive phase of development of the API
   • Target users: The intended users (consumers) of an API
   • Style: The primary architectural style of the API
   • Team: The producing team responsible for an API
   • Business unit: The business unit responsible for an API
   Note: There may be additional custom options. For more information on predefined taxonomies, see Manage taxonomies.
4. Click Toggle panel to close the Filter pane.

5. The selected filter properties display the conditional logic (AND or OR) that the filter query is using as shown in the following example.

   
6. To clear an individual filter, click the X on the filter. To clear all filters, click Clear all in the Filter pane.

Pagination

When there are multiple APIs, they are displayed across multiple pages.

To navigate between pages:

1. In the Google Cloud console, go to the API hub page.

   Go to API hub

   The APIs list page is displayed by default.

2. From the APIs list, locate the pagination tools as shown below:

   
3. Select the number of APIs to display per page.
4. Click > Forward to go to the next page.
5. Click < Back to go to the previous page.

Search

Refine the list of APIs displayed to just the APIs that contain a specific search term. The term can be in the API name or API description text.

To search for APIs containing a specific term:

1. In the Google Cloud console, go to the API hub page.

   Go to API hub

   The APIs list page is displayed by default.

2. Type a term in the search box. The list of APIs is updated to display only the APIs that contain the specified term.
3. To clear the search text box, click Clear.

Sort

To reorder the list of APIs displayed:

1. In the Google Cloud console, go to the API hub page.

   Go to API hub

   The APIs list page is displayed by default.

2. From the APIs list page, locate the API name column heading.
3. The arrow indicates the current sort priority. A down arrow indicates descending order. An up arrow indicates ascending order.
4. Click API name to sort the APIs list by name.

What's next?

• APIs overview