SDK version compatibility

Always use an SDK that is compatible with Workload Security.

Upgrade scenarios

Determine whether you need to change your scripts when Workload Security is upgraded or you upgrade your SDK to take advantage of new or improved capabilities.

  • Workload Security is upgraded: There is no need to update your SDK or change your scripts when Workload Security is upgraded. An SDK is compatible with the version of Workload Security that it is associated with, and with later versions. For example, the SDK that was released with Deep Security as a Service on March 21, 2019 is compatible with Deep Security as a Service released on August 1, 2019.
  • You upgrade your SDK: You might need to make minor changes to your scripts when you upgrade the SDK that you are using. Scripts are not guaranteed to be 100% compatible with versions of the SDK that are later than the version with which the script was created. New versions of the SDK can introduce changes that break your existing scripts. For example, when a new version of an SDK introduces a new required method parameter, to use the new SDK your existing scripts that use that method need to include a corresponding argument.

Discover changes to SDKs

The Changelog lists all changes that are made to the API and SDKs. When you upgrade your SDK, check the Changelog.

Discover the version of your SDK

After you download the SDK you can discover its version.

The first two digits of the SDK version corresponds with the version of Workload Security or Deep Security for which the SDK was released. For example, an SDK version of 12.0.296 was released for Deep Security 12.0.

Python: Open any Python source file (*.py) from the SDK in a text editor. The multiline docstring at the top of the file includes the version. For example, the following text indicates a version of 12.0.296:

OpenAPI spec version: 12.0.296

Discover the SDK version for Workload Security

The SDK version corresponds with the version that appears in the title of the API Reference.