Deprecating an API instance on API Manager

While transitioning consumers of your API to an updated instance, you can prevent developers from signing up for access to your old API instance. As an API administrator, you mark an API as deprecated to remove the invitation for developers to request access from the portal page. Existing application contracts remain active but no new contracts can be created for that API instance. Deprecated APIs have an indicator in any location where they appear showing they are deprecated. A badge in search results indicates that the instance is deprecated.

  1. Go to Anypoint Platform > API Manager.

  2. In API Administration, click the name of the API you want to deprecate.

    The API Settings detail appears:

    api settings
  3. Select Actions > Deprecate API.

  4. Click Ok.

    The API is now deprecated.

Was this article helpful?

💙 Thanks for your feedback!

Edit on GitHub
Submit your feedback!
Share your thoughts to help us build the best documentation experience for you!
Take our latest survey!