Webex API and SDK Support Policy

anchorVersioning
anchor

Webex APIs and SDKs are versioned using standard SEMVER (https://semver.org/).

Version format: MAJOR.MINOR.PATCH

  • Bug fixes not affecting the API increment the patch version
  • Backwards compatible API additions/changes increment the minor version
  • Backwards incompatible API changes increment the major version
anchorAPIs and SDKs end of life (EOL) policy
anchor
Normal Upgrade Cycle

API versions will be deprecated 18 months after the release of a new version.

  • At the time of the new release, a notification will be sent to all customers that a new version is available including the change log of what was added or fixed.
  • After 12 months customers still using deprecated APIs will be contacted with an ever increasing frequency being asked to upgrade.
  • At the 18 months mark the deprecated APIs shall be switched off using 410 HTTP code.

SDK versions will be deprecated 12 months after the release of a new minor version or 18 months in case of a major version.

  • At the time of the new release, Cisco will communicate to the community about the changes that are included in the new version and reminders to upgrade.
  • At 18 months mark the deprecated SDK may stop functioning. Attempts shall be made on Cisco's part to help customer apps "fail gracefully" in such cases.
Priority Upgrade Policy

A priority upgrade will be required if there is an issue discovered that impacts Webex' ability to maintain quality of service. If a priority upgrade is required for the API or an SDK, the old versions will be supported up to 6 months from the time of release of the new version.

Critical Upgrade Policy

A critical upgrade will be limited to changes that are required to remediate security and/or data protection or loss issues. If a critical upgrade is required for the API or an SDK, the old versions will be immediately deprecated at the time of release of the new version.

  • Connections from previous version may be refused immediately.
  • At the time of the new release, a notification will be sent to all customers using the existing version that a new version is available to address a critical issue and include appropriate details of the impact of the critical issue. Instructions will be provided on how to upgrade to the new version as soon as possible with an offer of assistance from support.
  • Technical support and Customer Success will work with all affected teams until upgrades are completed.
anchorDeprecating SDK APIs
anchor

According to SEMVER recommendations to deprecate functionality in a previously released SDK we shall:

  • Update the documentation and create a guide for how to migrate to the new set of APIs.
  • Issue a minor release with the APIs that are being deprecated clearly marked.
  • Issue a new major release shortly after with the deprecated APIs removed.