Shutting Down an Existing API

Overview

As we create more and more APIs and deploy updates for the ones we have in production, eventually we’ll run into the need to shut down one or more of them. The process of turning off our API means addressing several important issues in order to ensure data integrity and operational safety, including these:

• Communicating the API shutdown
• Placing code in the public domain
• Publishing the interface design as open source
• Making consumer data recoverable
• Marking our API 410 GONE

Communicating the API shutdown

Before we shut things down, we need to make sure we’ve notified all the API consumers we can. For internal APIs, this is often done through company-wide email lists, wiki pages, or ...