When configuring your APIs before publishing them through the DfE's Find and Use an API Management Portal for access and consumption through the DfE's Find and Use API Consumption Portal the available release lifecycle status tag options are as follows:

  • Planned - Planned release can be considered pre-alpha release with milestone versions that may include specific sets of functions and are released as soon as a feature is complete. This happens before developing and releasing an alpha version of an API. And during this phrase, many new versions of the base API will be developed and released as new features and functions are added, building up towards a fully featured API release.

  • Alpha - Alpha release is a simulated or actual operational release to potential users/customers or an independent or internal test team.

  • Beta - Beta release is the release after the alpha release and can be considered a form of external user acceptance. It is usually versions released to a limited external audience or public to increase the feedback.

  • Live - Live release is the production release label for the fully tested and approved API ready for the public to access and consumed.

  • Deprecated - A deprecated API release in one that is no longer supported or maintained by its developer. This may be necessary because of changes in technology or user preferences. Deprecated features or APIs, should be supported with adequate documentation. This will help users understand why the deprecation or related change is being made and how they can act including recommendations by the developer as a replacement, if necessary.