Deprecating a Product

You can deprecate a published Product by using the Manage Products page within a Catalog in API Manager. When you deprecate a Product, application developers that are already subscribed to the Product can continue to use it, but no new developers can subscribe to the Product. The syndication feature in IBM® API Connect means that you can also use the Manage Products page within a Space in a Catalog to deprecate a published Product.

Before you begin

The Product that you are deprecating must be in the Published state.

To complete the product management tasks that are described in this topic, you must either be the owner of the API provider organization, or be assigned Manage permission for products in the catalog that contains the product. If you have View permission for products, you have read-only access to the product management page. For information on configuring product management permissions for a catalog, see Creating and configuring catalogs.

The syndication feature in IBM API Connect means that products can be contained within a space in a catalog. In this case, to complete the product management tasks that are described in this topic, you must either be the owner of the API provider organization, or be assigned Manage permission for products in the space that contains the product. For information on configuring product management permissions for a space, see Managing user access in a space.

Procedure

To deprecate a Product, complete the following steps:

  1. In the navigation pane of the API Manager UI, click Manage icon in the API Manager UI navigation pane Manage catalogs, then select the catalog that you want to work with.
    The Products page of the catalog opens, and all of the products available in that catalog are displayed.
  2. If the product that you want to work with is contained within a space, select the required space by completing the following steps:
    1. Click the Spaces tab.
    2. Select the space that you want to work with.
    The Products page of the space opens, and all of the products available in that space are displayed.
  3. Alongside the Product version that you want to work with, click the options icon options icon, then click Deprecate.
    The Deprecate Product window opens.
  4. Click Confirm to deprecate the Product.
    If approval is required to deprecate Products in this Catalog, an approval request is sent, and the Product moves to the Pending state; the Product is deprecated when the request is approved. If approval is not required, the Product is deprecated immediately. For information on configuring Product lifecycle approvals for a Catalog, see Creating and configuring catalogs. For information on approving requests, see Approving Product lifecycle and subscription requests.
    Note:
    • Approval for product lifecycle state changes in a catalog is disabled by default. You must explicitly enable the product lifecycle state changes that you want to enforce.
    • Product lifecycle approvals can be configured only at the Catalog level. This feature is not available at the Space level.
    • To view the subscription tasks history, complete the following steps:
      • In the navigation pane of the API Manager UI, click Manage, then select the catalog that you want to work with.
      • Click Tasks tab.
      • Click Approvals history from the navigation pane.
    • You can view the history of Product lifecycle requests and approvals, by clicking the options icon options icon alongside the Product that you want to work with, and selecting View Approval History.

Results

Your Product is in the Deprecated state.