When you make your first API request, we will pin your account to the then-current API version. Your pinned API version can be changed via your account settings, e.g. to upgrade a licensing integration from 1.0 to 1.1. This ensures that your integration never breaks, even when we introduce breaking changes to our API.
Alternatively, you may provide a
Keygen-Version header to change the API
version on a per-request basis. This is useful during upgrades.
Keygen-Version header should not contain a
We recommend all applications pin their API integration to the current API version.
For example, if you're developing an application against 1.1 of the API, we
recommend including the above
Keygen-Version header in all API requests.
Later on, this will make upgrading to e.g. 1.2 much easier.
To reduce breakages, when upgrading, we recommend using the
You should only change your account's pinned version after you've confirmed all
API requests are using the newer version.
In addition, all webhook endpoints utilize version pinning also well. This ensures that webhook events sent to your endpoints do not change shape.