Updating Your Applications to Use a New Version of the API

If you are considering adopting a new version of the Traffic Manager REST API for your existing scripts and applications, Ivanti strongly recommends you take the following steps in order to minimize the impact of the update:

•Avoid hard-coding the API version number in multiple places in a script or application.

•Avoid mixing requests to different major API versions across a single Traffic Manager cluster. For example, it is unsafe to access a resource at a 3.x API version in one script and a 4.x API version in another.

Changes Involving a Minor API Update

For upgrades involving a minor increment to a currently used major version, for example 3.4 to 3.5, PUTs and GETs made to the previous API version are expected to operate as intended with the newer API version. Ivanti recommends you verify that the client behaves as expected when any new keys or resources are returned.

Changes Involving a Major API Update

For upgrades involving a new major API version, for example 3.11 to 4.0, first audit your scripts and applications to determine the list of resources and properties you are accessing. Next, refer to REST API Change History for the change history since your current version up to and including the desired new version. Compare your set of accessed resources and properties to the changes listed and note where a resource or properties has been affected, with specific reference to any renames or deletes. Finally, modify your scripts and applications accordingly.