Lifecycle Management

Lifecycle Management of APIs and Packages

By default, all APIs and API packages are accessible by consumers as and when they are published to Developer Portal. But, as an API provider, you have a lot of APIs or API packages that are under construction or maintenance. You can only expose the assets that are mature, tested, or well-documented for consumers. In such cases, the API lifecycle feature in Developer Portal allows you to expose the APIs that are ready for consumption. You can enable or disable this feature as per your requirement.

An API undergoes a lot of stages before it is ready to be exposed. The following section quickly takes you through these stages and the states that you can assign to those APIs:

In general, API developers develop the skeleton of an API, start implementing, mock it for testing responses, and then activate the API and publish it to Developer Portal. After this, API providers can use the Enrich API feature in Developer Portal to include the required logo or localized descriptions to API and its resources, and then test it again to ensure the performance of the API.

You can move API states in the following linear way based on the development of your APIs:

The default lifecycle states available in Developer Portal are:

Lifecycle Feature Considerations

As an administrator or a provider, you must consider the following when you enable the lifecycle feature for APIs and packages in Developer Portal.

Visibility of assets

The following table lists the visibility and accessibility of assets on the UI based on user persona.

Use case State of asset API consumer API provider Administrator
View API in API gallery Draft


  Live


  Retired


View package in API packages (Package gallery) Draft


  Live


  Retired


Request application (for an API) or subscription (for a package) Draft


  Live


  Retired


Search an API or package using global search Draft


  Live


  Retired


Accessing an API or package using deep link URL Draft


  Live


  Retired


Note: API consumers can access the APIs or packages that are in Draft or Retired state, if they have a valid application or valid subscription associated with the asset.

State of restored APIs When you restore APIs from an archive, the restored APIs retain the same state from the backup archive. If APIs are backed up from an instance in which the API lifecycle feature is not enabled, then the restored APIs are kept in the Draft state.

State of migrated APIs When you migrate APIs to 10.15 from an earlier version of Developer Portal, the migrated APIs are kept in the Draft state. You can change their state as per your requirement.

Creating applications for APIs in Draft state Only administrators or providers can create applications for the APIs that are in the Draft state, in order to test them before exposing to consumers. Consumers cannot view or use those APIs.

How do I enable the lifecycle feature for APIs and packages?

By default, the lifecycle management feature is not enabled. You must enable the feature from the Administration section of Developer Portal to use the feature.

To enable the lifecycle feature

  1. Click the menu options icon from the title bar and click Administration.

  2. Click General.

  3. Turn the Enable lifecycle slider on.

  4. Click Save.

    The lifecycle feature for APIs and packages is enabled.

    The APIs and packages in the Draft state are not available for the use of consumers.

    When you enable the lifecycle feature, all APIs and packages in your Developer Portal instance are moved to the Draft state.

Next steps:

Move the required APIs and packages to the Live state. For information about moving APIs and packages to the Live state, How do I change the state of an API to expose it to consumers? and How do I change the state of a package to expose it to consumers? respectively.

Modifying state of APIs

How do I change the state of an API to expose it to consumers?

This use case explains the steps to move an API to the Live state in order to expose it to consumers.

This use case starts when you want to move an API that is in Draft state to the Live state.

In this example, consider the API, API1 that is in the Draft state is moved to the Live state.

To move an API to the Live state

  1. Click the menu options icon from the title bar and click Manage APIs.

  2. Click the change state icon icon next to the API1.

  3. Select Live.

  4. Click Save.

    The state of API is changed to Live.

    APIs that are moved the Live state appear in the API gallery page.

Next steps:

How do I change the state of a Live API for maintenance?

This use case explains the steps to move an API to the Draft state for performing any maintenance activity on that API.

This use case starts when you want to move an API to the Draft state from the Live state .

In this example, consider the same API, API1 that is in Live state moved to the Draft state.

To move an API to the Draft state

  1. Click the menu options icon from the title bar and click Manage APIs.

  2. Click the change state icon icon next to API1.

  3. Select Draft.

  4. Click Save.

    The state of API is changed to Draft.

    APIs that are moved to the Draft state do not appear in the API gallery page.

Next steps:

How do I change an API’s state to retire it from usage?

This use case starts when you want to retire an API that is in the Live or Draft state to prevent consumers from viewing it.

In this example, consider the API, API1 that is in Live state.

To move an APIs to the Retired state

  1. Click the menu options icon from the title bar and click Manage APIs.

  2. Click the change state icon icon next to the API1.

  3. Select Retired.

  4. Click Save.

    The state of API is changed to Retired.

Next steps:

Modifying State of Packages

How do I change the state of a package to expose it to consumers?

This use case explains the steps to move a package to the Live state to expose it to consumers.

This use case starts when you want to move an package that is in Draft state to the Live state.

In this example, consider the package, Weather that in the Draft state moved to the Live state.

To move a package to the Live state

  1. Click the menu options icon from the title bar and click Manage packages.

  2. Click the change state icon icon next to the package.

  3. Select Live.

  4. Click Save.

    The state of package is changed to Live.

    Packages that are moved to the Live state appear in the API packages page.

Next step:

How do I change the state of a Live package for maintenance?

This use case explains the steps to move a package to the Draft state for performing any maintenance activity on that API.

This use case starts when you want to move a package to the Draft state from the Live state.

In this example, consider the same package, Weather that is in Live state moved to the Draft state.

To move an package to the Draft state

  1. Click the menu options icon from the title bar and click Manage packages.

  2. Click the change state icon icon next to the package.

  3. Select Draft.

  4. Click Save.

    The state of package is changed to Draft.

    Packages that are moved to the Draft state do not appear in the API packages page.

Next steps:

How do I change a package’s state to retire it from usage?

This use case starts when you want to retire a package that is in the Live or Draft state to prevent it from the view of consumers.

In this example, consider the package, Weather that is in Live state.

To move a package to the Retired state

  1. Click the menu options icon from the title bar and click Manage packages.

  2. Click the change state icon icon next to the package.

  3. Select Retired.

  4. Click Save.

    The state of package is changed to Retired.

    You cannot move the retired packages to the other states.