SDK Version Compatibility

Deep Security SDKs are associated with a specific Deep Security version and platform (AWS, Azure, or On-Premise, or Deep Security as a Service). Always use an SDK that is compatible with your Deep Security Manager.

Follow these rules to make sure that the SDK you are using is compatible with your manager:

  • Use an SDK that is associated with the same platform on which your Deep Security Manager runs.
  • The version of your SDK must be equal to or earlier than the version of your Deep Security Manager.

Upgrade scenarios

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

  • You upgrade Deep Security Manager: There is no need to update your SDK or change your scripts when you upgrade Deep Security Manager. An SDK is compatible with the version of the Deep Security Manager that it is associated with, and with later versions. For example, the SDK that was released for Deep Security 11.3 is compatible with Deep Security Manager 11.3 and 12.0. However, you should consider upgrading your SDK to take advantage of new capabilities.
  • 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 for the version of Deep Security that corresponds with the newer SDK.

Determine your SDK’s compatibility

To determine whether the SDK that you’re using is compatible with your Deep Security Manager, obtain the SDK version and compare it with with the version that is associated with your manager. The version of your SDK must be equal to or earlier than the version of your Deep Security Manager.

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 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
  • JavaScript: Open the package.json file that is extracted from the root of the JavaScript SDK ZIP file and see the value of the version key. For example, the following version key indicates an SDK of version 12.0.296:
    "version": "12.0.296"
    Alternatively, open any JavaScript source file (.js) from the SDK in a text editor. The multiline comment at the top of the file includes the version:
    OpenAPI spec version: 12.0.296
  • Java: The name of the JAR file that is included in the Java SDK ZIP file that you download includes the version. For example, if the file name is deepsecurity-12.0.296.jar, the version is 12.0.296.

Discover the SDK version for Deep Security Manager

The SDK version corresponds with the version that appears in the title of the API Reference. Make sure the correct platform and version is selected for the Automation Center.