Box SDK versioning strategy
Box SDK versioning strategy
The Box core SDKs and the Box Next Generation SDKs were initially created as separate libraries. However, in keeping with industry best practices, we are consolidating the Box Next Generation SDKs and the Box core SDKs into a single package for each programming language. This makes migration efforts much easier and allows seamless addition of new capabilities to existing applications still powered by older versions of the Box core SDKs, which were maintained manually.
To facilitate this migration process, there are two actively maintained major Box core SDK versions:
- A major version that follows sequential versioning for each SDK artifact and includes: the manually maintained package and the generated one. This SDK version enables leveraging coexisting packages at the same time, and serves as a transition phase. Support for the consolidated version of each Box core SDKs will continue in 2027.
v10that includes only the generated package.
Here's what you can expect from generated packages of the Box SDK:
- Full API support: New Box SDKs empower developers with complete coverage of the Box API ecosystem. You can access all the latest features and functionalities offered by Box and build feature-rich applications.
- Rapid API updates: The new auto-generation development approach allows you to add Box APIs to SDKs at a much faster pace (in a matter of days). This means you can leverage the most up-to-date features in your applications without delay.
- Embedded documentation: All objects and parameters are documented directly in the source code of the SDK so all the necessary information is stored in one place.
- Enhanced convenience methods: The newly introduced convenience methods cover various aspects such as authentication, chunk uploads, exponential back-offs, automatic retries, type checkers that help to ensure that you’re using variables correctly, and much more.
What it means for your project
Versioning overview
Box core SDK versions and artifacts overview
| Repository name | Artifact name | Includes both packages | Includes generated package only |
|---|---|---|---|
box-python-sdk | boxsdk | v4.X.Y | ≥v10.0.0 |
box-node-sdk | box-node-sdk | v4.X.Y | ≥v10.0.0 |
box-java-sdk | box-java-sdk | v5.X.Y | ≥v10.0.0 |
box-windows-sdk-v2 | Box.V2, Box.V2.Core | v6.X.Y | ≥v10.0.0 |
box-ios-sdk | BoxSDK | v6.X.Y | ≥v10.0.0 |
Box Next Gen SDKs deprecation
As of September 17, 2025 Box Next Generation SDKs are no longer supported as separate artifacts. Don’t worry, your existing code will continue to work without changes. You can still use your applications based on Box Next Generation SDKs with no impact, but you won't receive new features, updates, or bug fixes.
All future development, including new features and updates, will be delivered through the Box core SDKs. The standalone generated artifact was introduced in the version v10 of the Box core SDKs, and it is currently available as a separate branch.
| Repository name | Artifact name | Note |
|---|---|---|
box-python-sdk-gen | box-sdk-gen | Deprecated, use boxsdk ≥v10.0.0 |
box-typescript-sdk-gen | box-typescript-sdk-gen | Deprecated, use box-node-sdk ≥v10.0.0 |
box-java-sdk-gen | box-java-sdk-gen | Deprecated, use box-java-sdk ≥v10.0.0 |
box-dotnet-sdk-gen | Box.Sdk.Gen | Deprecated, use Box.V2.Core ≥v10.0.0 |
box-swift-sdk-gen | BoxSdkGen | Deprecated, use BoxSDK ≥v10.0.0 |
Migration
Migration from manually maintained SDK version to the consolidated SDK version
Follow detailed migration guides to migrate from the manually maintained SDK version to the consolidated SDK version:
Once your project is upgraded, follow the migration guides and migrate to the generated package.
Migration to the generated package
Follow detailed migration guides to migrate to the generated package within the Box core SDKs.
- Python: migrate from
boxsdktobox_sdk_genpackage - Node: migrate from
box-node-sdktosdk-gen - Java: migrate migrate from
com.box.sdkto com.box.sdkgenpackage - .NET: migrate from
Box.V2module toBox.Sdk.Genmodule - Swift: migrate from
BoxSDKmodule toBoxSdkGen module
Migration from the Box Next Generation SDKs to the Box core SDKs
Follow detailed migration guides to migrate from the Box Next Generation SDKs to the Box core SDK ≥v10: