Skip to main content

Targeting a specific version

Default API version​

All requests use your organization's "pinned version". By default, this is the most recent version of the API at the creation time of your organization. This value can be checked and updated on the Console in API Keys. We allow you to pin your API version to any existing version.

API updates​

When backwards-incompatible changes are made to the API, a new, dated version is released. The current version is x-nabla-next. For a list of all available versions and their associated breaking changes, check out our Upgrades page. For a full changelog of API updates, check out our Changelog page.

Manually set the API version​

Via header​

To set the API version on a specific request, you can add a specific header named X-Nabla-Api-Version with the value of the version you are targeting:

curl https://us.api.nabla.com/{endpoint} -H "X-Nabla-Api-Version: x-nabla-next"

Via query parameter​

Alternatively, you can use a query parameter named nabla-api-version:

curl https://us.api.nabla.com/{endpoint}?nabla-api-version=x-nabla-next

This syntax can be particularly useful with WebSockets, for which web clients generally don't allow to provide a custom header.