First Steps Toward Deep Security Automation
The Deep Security API enables you to automate operational tasks, thereby increasing the productivity of your value stream and improving the security services that you support:
- Configure policies and protect computers
- Discover vulnerabilities and patch them
- Perform routine maintenance tasks
To learn about the features and abilities of Deep Security, go to the Deep Security Help Center.
The API and SDK - DevOps tools for automation
The Deep Security API is a RESTful API that you use to make HTTP requests to interact with Deep Security Manager. The SDK includes client libraries that enable you to use the API in the following languages:
- Python
- JavaScript (via NodeJS)
- Java
The API Reference provides information about each resource that you interact with:
- Descriptions of operations that you can perform on each resource (GET, POST, etc)
- Request paths, headers, and payloads
- Example requests and response messages
Guides, such as this one, describe how to use the SDKs via examples of how to automate typical Deep Security operational tasks.
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 the Deep Security Manager with which you are interacting. However, Deep Security Manager 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.