Versions Compared


  • This line was added.
  • This line was removed.
  • Formatting was changed.

The changes between REST API v3 and v5 may require some smaller adjustments of the client implementations, but are in general not requireing requiring big-effort changes. This migration guide should give an overview on how to migrate from API v3 to API v5. Please note that at the time of writing this guide the API v6 was already announced, but the changes from v3 or even v5 to v6 are of bigger nature. There will be a separate migration guide from v5 to v6 available. But for projects that are still using API v3, we recommend to migrate to v5 first and then migrate from v5 to v6 as already this 2nd step will be a big change.


REST API /v3 and /v4 DEPRECATION: The 23.76 (published March 2024) will be the last LTS version that includes these API versions. By early June 2024, the REST API routes to v3/v4 will be deactivated on DEMO. Early December 2024, the REST API routes to v3/v4 will be removed from feature stream releases. Note that there is no date communicated yet to discontinue REST APIv5 (and where v5 refers to v4 routes, these will still remain); however we recommend to use the /v6 API specification already.

REST API v3 is deprecated and will be removed from the product soon. For at least 1 year after the deprecation anouncement (01 Jun 2022) the API v3 will still be contained in every featurestream version, and thus will still be part of the 22.76 with marketing name "23 LTS". One year after the deprecation announcement, API v3 will be removed from the product; will then not be available on feature-stream releases and the Shared-Saas instances, and will finally not be included in 23.76 ("24 LTS") anymore, which is expected early in Q2/2024.

We recommend to migrate now from REST API v3 to REST API v4 and v5 as long as new features of API v6 are not mandatory. API v4 and v5 will remain part of the product beyond the announced removal deprecation of v3, while REST API v6 will be added in parallel.
For new projects starting after Jul 2022, we strongly recommend to start with REST API v6.