API versioning policy

Talend public APIs are considered as a whole and a single version is defined for all endpoints and business domains. The version is incremented only if a breaking change is introduced in an API. In this case, the version is incremented for all APIs.

The version name indicates the year and month of its release, following the pattern YYYY-MM.

Current version: 2021-03

Version support

As soon as a new version is released, the previous version becomes deprecated and is supported for another 18 months. After that, the version is retired and can no longer be used.

By default, the oldest supported version is used in a request if:

There is no version specified.
The version specified is retired.
The version specified does not exist.

Using a specific version in a request

Talend APIs support two ways of setting an API version in a request:

In an HTTP header with the key talend-version (recommended)
In a query parameter with the key talendVersion

In Talend API Tester, you can set the version as follows: API Tester request with version in header