API Versioning

The platform in general provides support for a previous major version in order to support backwards compatibility and enable the clients to make the necessary changes to adapt to the new API without any disruptions. Though there are overall sensible defaults that are used, in order to provide flexibility as well as a more deterministic behavior, the callers can indicate the version that they would like to use. This is done by passing a custom header X-Api-Version when making an API call.

👍

Version Header

Though sending the version header is optional, it is highly encouraged to provide it. It is highly likely that this will be made required in the upcoming versions.

📘

Versioning

Note that only major versions can be specified by the caller. The table below defines the list of available version and the current status.

Here is an example using cURL that describes how to the pass the version header. In this example, the major version v2 is being requested.

cURL

curl --location --request GET 'https://...' \
--header 'X-Api-Version: v2'

Version	Status	Notes
v1	Frozen (No active development)
v2	Current	This is the active stable version.