The API and SDK
The Workload Security API is a RESTful API that you use to make HTTP requests to interact
with Workload Security. The SDK includes a Python package that makes it easy to use
the API in Python.
The API Reference provides information about each resource with which you interact:
- Descriptions of operations that you can perform on each resource (GET, POST, and so on).
- Request paths, headers, and payloads.
- Example requests and response messages.
API versions
The API is versioned. Each request that you make must include the version to use in
the
api-version header. The first version is v1.Although new versions are rarely released, you must ensure that the API version you
are using is compatible with Workload Security. However, Workload Security is backward-compatible
with all versions of the API. For example, if your code uses the
v1 API and you upgrade the manager, your code behavior does not change. However, you
should always use the latest available version of the API.Legacy REST and SOAP APIs
The REST and SOAP APIs that were provided before Deep Security 11.1 have not changed.
They have been deprecated, so even though new features are not added, the existing
API functionality will continue to work.
Workload Security still includes the legacy Deep Security REST and SOAP APIs. For
guidance on using them, see the following: