Process of retirement of API's in APIGEE Edge

[mangdeep83]

Can someone please let me know the process of retirement of API's in APIGEE as part of API Lifecycle. Please provide your inputs. In other words, how do we retire and API in APIGEE.

[ChrisHood]

That's one of the primary use cases for Versions.

In Apigee you have revisions and versions. By managing the versions, you can set an end of life with your API consumers. The mechanisms to actually retire an API would be to simply unpublish or turn off the proxy / products you want to retire.

The goal would be to manage that communication with your developers in some way. You could publish the information on the developer portal, or send an email.

The basic premise is to have v1/api and v2/api - when v2 is ready, you may have both versions published for a period of time. Once the developers have migrated over to version 2, turn off version 1.

There's a good discussion here: https://community.apigee.com/questions/71668/managing-apigee-proxy-version-in-source-control.html

And here: https://community.apigee.com/questions/37285/should-version-number-come-before-or-after-the-api.html

[#3]

This process is very simple. You need to just undeploy the proxy deployed revision.

Prior to that inform the consumers and allow some grace period.

On the final day just undeploy your proxy so that the api will stop serving the traffic.

You can also provide the redirect uri or custom response in a new revision if you want to guide your consumers.