Learn about our API versioning, our policy for backwards compatibility, and the end-of-life schedule for our APIs.
In this article:
Current API versions
We currently offer these versions of the Cognite Data Fusion API.
|API v1||Stable||Recommended for production environments. |
We will keep adding backwards-compatible (non-breaking) changes to the stable API. If we change the API in a backwards-incompatible way, we will release those changes as a new major API version.
The current stable API will be available for a 12 months after the release of the next major API version.
|API v1 Beta||Beta||Not recommended for production environments. |
Beta features allow you to start developing solutions with the latest features early and be ready to deploy as soon as we promote the feature to the stable release.
Any changes we make to a feature while it's in beta will be backwards-compatible (non-breaking).
To use the API directly, use the header
We will promote beta features to the stable version within six weeks.
|Playground||Unstable||Do not use in production environments. |
This version showcases our newest ideas, experimental features and demos.
The interface is highly unstable and constantly changing.
|API 0.5||Deprecated||Previous stable API. |
Scheduled to be removed.
End-of-life for API versions
The following API versions are scheduled for end-of-life. If you have applications, solutions, or demos using these APIs and SDKs, you need to migrate to the current stable API and accompanying SDKs. If you have any questions or need assistance please contact firstname.lastname@example.org
The APIs will not be available after their end-of-life dates.
|API version||SDK version||End-of-life date|
|API 0.5||Python SDK 0.x.x or earlier |
|Extended: September 30th, 2020|
Removed API versions
The following API versions have been removed. If you make direct API calls to these versions or use SDKs or other tools that depend on them, you will receive errors.
|API version||SDK version||Removed|
|API 0.6||Python SDK 0.x.x or earlier |
|April 1, 2020|
|API 0.4||Python SDK 0.11.x or earlier||September 10, 2019|
|API 0.3||Python SDK 0.11.x or earlier||September 10, 2019|
If we change the current stable API in a way that is backwards-incompatible, we will release those changes as part of a new major API version. The current stable API will be available for 12 months after the release of the next major API version to provide a migration period for our users.
A backwards-incompatible change is a change that causes a previously successful request, or successful parsing of the response, to fail or give different results after the change is released.
Backwards-compatible (non-breaking) changes
We consider the following to be examples of backwards-compatible (non-breaking) changes:
- Increasing the request limits.
- Adding properties to the response body.
- Adding properties to the request body (as long as it doesn't affect previous requests).
- Adding support for more query parameters (as long as it doesn't affect previous requests).
Backwards-incompatible (breaking) changes
We consider the following to be examples of backwards-incompatible (breaking) changes:
- Removing an endpoint.
- Removing a property in the response.
- Changing the error response format (not the status code).
- Changing the status code from 2xx to another 2xx.
- Reducing the limit on a request (not the response). Example: the number of assets to retrieve by
- Changing the name of query parameters and body properties.
- Changing the sort order if the original order was expected by the user.