Versioning

Cisco Identity Services Engine (ISE) may deprecate certain API versions or operations over time. Following a deprecation period, these versions or operations will sunset. This strategy allows Cisco ISE to introduce newer, more efficient alternatives that better meet developer needs.

Deprecation Principles

  1. Marking Deprecated Operations: Deprecated operations or versions will be clearly indicated in the Open API Description (OAD).
  2. Providing Alternatives: When possible, alternatives to deprecated operations or versions will be documented to facilitate transition.
  3. Support Timeline: Deprecated API operations will continue to be supported through the current release at the time of deprecation announcement, as well as one subsequent release. They will be removed in the following release. For example, if an API operation is deprecated in ISE 3.2, it is supported in both ISE 3.2 and 3.3 but removed in ISE 3.4.
  4. Notifying customers: On each release Cisco will provide release-specific documentation detailing changes in the current release and summarizing API operations marked for deprecation or removed in the current release. Note that Cisco reserves the right to sunset deprecated API operations sooner if necessary.
  1. Stay Informed: Regularly review API updates and changes with each new ISE release.
  2. Impact Evaluation: Conduct a formal impact analysis of deprecated and sunset API operations.
  3. Migration Planning: Collaborate with integration owners to plan and execute necessary migrations for deprecated API operations that will no longer be supported in future releases.

By staying proactive and collaborating on these changes, ISE customers can ensure a smooth transition to newer API functionalities, maintaining seamless integration and operational efficiency.