API Versioning 3.X

Open

Versioned REST calls correspond with the version of ThreadFix that is deployed. These versions allow ThreadFix to adjust the parameters and responses of REST calls while preserving backwards compatibility for those who do not wish to edit their existing integrations. Below are a few rules and examples on how to use versioning:

• By adding “/v2.4” after “/rest”, the 2.4 version of a REST call will be used.
  Example: http://localhost:8080/rest/v2.4/teams

• If you want to keep using the 2.3 version of any changed calls, just put “/v2.3” after “/rest”. 
  Example: http://localhost:8080/rest/v2.3/teams

• To always use the latest version of a call, such as when calls change in future releases, use “/latest”. 
  Example: http://localhost:8080/rest/latest/teams

• To always use the 2.3 version of a call, or the version a call was introduced in if it was introduced after 3.X? 2.3, use “/legacy”. 
  Example: http://localhost:8080/rest/legacy/teams

• Note: If a version is not specified, the call will use the “/legacy” version implicitly.  As of ThreadFix 2.7.4, this behavior is deprecated, and the ability to use a REST call without specifying a version will be removed in a future release.