Skip to content

Deactivation

Deactivation is the process of removing the API from being available, removing the source code, and removing the artifacts from being maintained and built. Once deactivation is complete, the API version will no longer be available.

The Sunset header set in the version deprecation phase is the date the API will no longer be available.

If 3 weeks before the communicated deactivation date, there is still usage of the API version, the VA strongly urges API teams to understand the activity and communicate to stakeholders the risk of deactivation.

Sometimes the deactivation date will need to be moved to a later calendar date due to the availability of resources to implement the changes. It should rarely, if ever, move to an earlier date.

Guidance

  • Understand usage on an API version about to be deactivated. Communicate that activity with stakeholders at least 3 weeks prior to the Sunset date that was established in the version deprecation phase.