API Versioning

Starting in version 2.4 of ThreadFix, we have introduced versioned REST calls. These versions allow us to adjust the parameters and responses of REST calls while preserving backwards compatibility for those who do not wish to edit their existing integrations. Here are a few rules about how to use the version:

• By adding “/v2.4” after “/rest”, you will use the 2.4 version of a REST call.
  Example: http://localhost:8080/rest/v2.4/teams?apiKey={apiKey}

• 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?apiKey={apiKey}

• 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?apiKey={apiKey}

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

• Note: If you do not specify a version, the call will use the “/legacy” version implicitly.  This behavior will eventually default to using “/latest”, but we will be sure to give clients warning when this happens.