Reachability API Versioning
The Reachability API supports versioning.
Each endpoint includes the version number in its path, for example:
api/v{version}/select-csm-agent
For each API version, there are corresponding API interfaces and Connector classes that should be used to ensure full compatibility and proper integration.
These components are organized in clearly versioned packages, such as
com.iconsolutions.ipf.{service}.controller.v{version}
com.iconsolutions.ipf.{service}.client.connector.v{version}
Manual Version Setup
To manually configure the API version, update the following property:
ipf.csm-reachability-api.version = V{version}
Supported Versions
| Version | Support Starts | Support Ends |
|---|---|---|
V2 |
IPF 2025.2 release |
October 2027 |
V3 |
IPF 2025.3 release |
Supported until further notice |
Version Migration
When migrating to a new version, breaking changes may occur. Always review the release notes before upgrading to ensure compatibility.
|
Consumers are strongly encouraged to migrate to the latest API version well in advance to ensure continued functionality, support, and access to the latest features and improvements. |