Learn about deprecation in the Wowza Streaming Cloud™ REST API, including our general deprecation policy and our schedule for versioning.
The feature set for the Wowza Streaming Cloud service naturally evolves over time, and sometimes a feature may need to be updated or removed from the REST API. We also provide performance improvements in newer API versions to increase efficiency. Deprecation and sunsetting may involve individual parameters, endpoints, or an entire version of the API. We provide a deprecation policy and schedule so our users can plan migration to newer functionality and versions as they are available. Our goal is to improve the streaming experience without disrupting applications that depend on the Wowza Streaming Cloud REST API.
Parameters that describe resources may be removed as the API develops with updated feature functionality. Parameters are deprecated within the beta version of the REST API only. The current version does not include active deprecations. The Wowza Streaming Cloud REST API release notes changelog provides announcements of parameter deprecations, and the API reference documentation includes deprecation information in the parameter description.
A deprecated parameter may still be available but is not reliable for use. It's marked deprecated when the API version is in beta, and the note remains when the beta version moves to become current. In a new beta version of the API, the parameter is removed from the reference documentation.
At times, it may be necessary to sunset a parameter without going through a deprecation state first. A sunset parameter is no longer available for use. Parameters that are sunset without moving through deprecation first are marked as sunset in the API documentation. When a new beta version is introduced, the sunset parameter is removed.
As the REST API develops over time, we may remove resources and their associated endpoints. We may also reorganize existing resources by updating their endpoints to allow for additional functionality. This maintains an organized and logically accessible API. Like parameters, endpoints that are deprecated or updated are noted in the release notes changelog and the reference documentation. All endpoint reorganization or deprecation is completed in a beta version of the API before it moves to current.
A deprecated endpoint or operation may still be available but is not reliable for use. It's marked as deprecated when the API version is in beta, and the note remains when the beta version moves to become current. In a new beta version of the API, the deprecated endpoint is removed from the reference documentation.
An endpoint or operation may move to a sunset state without going through a deprecation state first. Sunset operations are no longer available for use. Operations that are sunset without moving through deprecation first are marked as sunset in the beta version of the API documentation, and the note remains when the version moves to become current. When a new beta version is introduced, the sunset operation is removed.
API version lifecycle
Each version of the Wowza Streaming Cloud REST API progresses through the following lifecycle stages. We announce to our users when a beta version moves to current, and we announce many months in advance when a supported version moves to deprecated or when a deprecated version moves to sunset.
- Beta – The beta version contains everything that's in the current version as well as some features and functionality that are still in development. These work-in-progress features aren't fully tested and are subject to change. When we're done testing, we'll promote the beta version to the current version and then create a new beta with new features. You're free to use the beta version for testing and evaluation, but beta versions aren't intended for use in production environments and we caution against using a beta in production. There is only one beta version available at any time.
- Current – The current version offers the most complete, up-to-date, tested, and stable code base. We strongly recommend using the current version in your production environment. There is only one current version available at any time.
- Supported – A supported version was current at one time but has been replaced by a newer version of the API. Supported versions don't have the newest features, and may contain features or functions that are outdated and don't offer the most efficient methods for accomplishing your streaming goals. If you're using a supported version, we recommend that you upgrade to the current version, as supported versions will ultimately be deprecated.
- Deprecated – A deprecated version is out-of-date and can't be guaranteed to work in production environments. If you're using a deprecated version, update to the current version at your earliest convenience.
- Sunset – A sunset version is no longer accessible. This includes all relevant documentation.
We encourage you to actively migrate to a newer version of the Wowza Streaming Cloud REST API when the API version you currently use is deprecated. Sunset versions are no longer available. Users must be on a newer—preferably current—version of the API by the sunset date to ensure uninterrupted functionality.
The following deprecation schedule is provided for planning purposes only. Future dates are subject to change at the sole discretion of Wowza Media Systems, however, date changes will be accompanied by advance communication.
Note: Previous versions of the REST API not listed in the below table have been sunset.
|1.3||June 19, 2018||January 31, 2019||January 30, 2020||to be determined||to be determined|
|1.4||January 31, 2019||January 31, 2020||May 27, 2020||to be determined||to be determined|
|1.5||January 31, 2020||May 27, 2020||to be determined||to be determined||to be determined|
|1.6||May 27, 2020||to be determined||to be determined||to be determined||to be determined|
See the Wowza Streaming Cloud REST API migration guide for general guidance.
For further assistance, contact Wowza Technical Support.