2.3 Manage APIs

Select Publisher

The Publisher provides a single location for you to manage the APIs hosted in Secure API Manager. There are several different management tasks you can perform in the Publisher. You can search for APIs and include the tags you specified when you created the API in the search parameters.

2.3.1 View APIs in the Publisher

The Publisher displays all of the APIs stored in Secure API Manager. It also provides different ways to view and search for the APIs.

To view the APIs:

  1. Access the Publisher.

  2. Select the appropriate API Gateway cluster to view the APIs associated with it.

  3. To search for a specific API, in the Search field, specify the name of the API to search for the API.

  4. To view the APIs, use one or more of the following options:

    1. In the upper right corner, click View deprecated APIs to view only the deprecated APIs.

    2. In the upper right corner, click View unsubscribed APIs to view only the unsubscribed APIs.

    3. In the upper right corner, click View table layout to view all of the APIs in a table layout.

    4. In the upper right corner, click View tile layout to view all of the APIs in a tile layout.

    5. In the upper right corner, in the Sort by field, click Name to sort the APIs by name in ascending or descending order.

    6. In the upper right corner, in the Sort by field, click Description to sort by the description in ascending or descending order.

2.3.2 Edit an API or View a Deprecated or Subscribed API

You can change any of the parameters, endpoints, or backend service information stored in an API. It allows you to update an API if the certificate changes or if the backend service changes.

You cannot edit an API if it has subscriptions or if it is deprecated. If an API has subscriptions, that means that the API is in use and you cannot make changes to it, otherwise the service the API provides would be disrupted. If an API is deprecated, it is no longer in use. You can view the details of these APIs but you cannot edit them.

The best practice for editing an API is to make a clone of the API and then make the appropriate changes to the clone. This results in a new API with a new version as well as no interruptions to currently in-use APIs.

To edit an API or view a deprecated or subscribed API:

  1. Select the API you want to edit.

  2. In the upper right corner of the API, click the Actions.

  3. Click Edit or click View.

    The Edit option appears if the API is not deprecated or does not subscriptions. The View option appears if the API is deprecated or has subscriptions.

  4. View the details of the API or change the appropriate items in the API.

2.3.3 Clone an API

Secure API Manager provides this cloning feature to simplify creating and deprecating APIs. The best practice for using cloning is to create a clone of an API you want to deprecate and then deprecate the first the API. Secure API Manager automatically increases the version number of the API for you when you clone an API. Cloning saves you time so that you do not have enter the same parameters again for a new version. After you clone the API, you modify the API.

IMPORTANT:Secure API Manager does not allow you to clone an API more than one time. If you need a new clone, clone the cloned API and deprecate the first clone.

To clone an API:

  1. Select the API you want to clone.

  2. In the upper right corner of the API, click the Actions.

  3. Click Clone.

  4. Make the appropriate changes to make a new API. Best practice is to update the description of the API to record what is different in the new API from the original API.

    NOTE:Secure API Manager does not allow you to change the version number of the cloned API. It automatically increments the version of the cloned API for you.

2.3.4 Deprecate an API

If you have created a new version of an API but you need to keep the older APIs for compliance or other reasons, you can deprecate these APIs. The deprecated APIs still appear in the Publisher but the Store does not display them.

To deprecate an API:

  1. In the Publisher, select the appropriate API to deprecate.

  2. In the upper right corner of the API, click the Actions.

  3. Click Deprecate. The API now contains an exclamation mark on it.

  4. (Conditional) If you need to make a deprecated API available again, click the Actions, then click Deprecate again. The exclamation mark is removed and anyone can access the API in the Store again.

2.3.5 Manage Multiple APIs

The Publisher allows you to delete or deprecate multiple APIs at the same time. This allows you to work more efficiently.

To manage multiple APIs:

  1. In the Publisher, select Edit in the top left corner.

  2. Click the APIs that you want to delete or deprecate.

  3. In the top left corner, click Delete or Deprecate, then click the confirmation message.

  4. In the top left corner, click Close to exit the editor.