Integrate Kaspersky KES Antivirus
Overview
You can integrate Kaspersky KES Antivirus to scan files during Transfer and detect or block potential threats.
Once configured, files are scanned according to the selected Scan timing. If a threat is detected, the configured On detection action is applied to block the Transfer or generate an alert. The files to be scanned are determined by the selected Scan scope.
The overall process consists of the following steps:
① Verify API Credentials → ② Configure the Integration in the Product
Prerequisites
Before you begin, verify the following requirements.
| Item | Description |
|---|---|
| Kaspersky KES | A Kaspersky KES environment with API access for file scanning is required. |
| API Credentials | An API Token is required. |
| Network | The environment where the product is installed must allow outbound HTTPS communication (port 443) to the Kaspersky API Endpoint. |
Verify API Credentials
To scan files with Kaspersky KES, you need an API Token.
Step 1. Generate an API Token
In the management console, open the API access settings, generate or retrieve the API Token, and copy it.
Treat the API Token as a password. Anyone with access to the API Token can use the scanning API, so do not expose it in public repositories or external documentation. If the API Token is compromised, revoke it and generate a new one.
Verification
✔ The API Token has been generated.
Configure Kaspersky KES Integration
Enter the verified credentials and configure the scanning options.
When you open the Security configuration page, the following screen is displayed.
Step 1. Enter the API Token
Enter the API Token generated in the "Verify API Credentials" section into the API Token field.
Step 2. Select Scan Timing
Select when files should be scanned in Scan timing.
| Option | Description |
|---|---|
| Before transfer at source | Scan files on the source before the Transfer starts. |
| After transfer at target | Scan files on the target after the Transfer completes. |
| Bothway | Scan files both before the Transfer at the source and after the Transfer at the target. |
Step 3. Select On Detection
Select how the system should respond when a threat is detected in On detection.
| Option | Description |
|---|---|
| Block transfer | Block the Transfer when a threat is detected. |
| Alert only | Allow the Transfer to continue and generate an alert only. |
| Admin confirm | Require administrator confirmation before proceeding. |
Step 4. Select Scan Scope
Select which files should be scanned in Scan scope.
| Option | Description |
|---|---|
| All files | Scan every transferred file. |
| Executable files only | Scan executable files only. |
| Custom exceptions | Scan files according to user-defined exception rules. |
Step 5. Save the Configuration
After completing the configuration, click Add to save the integration.
Verification
✔ The API Token has been entered.
✔ The Scan timing, On detection, and Scan scope options have been selected.
Verify the Integration
Verify that the integration is operating correctly.
Step 1. Perform a Test Transfer
Transfer a file to verify that scanning is performed. You can safely verify the scanning behavior using a standard antivirus test file such as EICAR.
Step 2. Verify the Result
Verify that the configured On detection action is applied correctly (for example, Block transfer blocks the Transfer, while Alert only generates a warning).
Verification
✔ File scanning has been performed.
✔ The configured detection action is applied correctly.
Configuration Complete
After the configuration is saved, the integration becomes active.
From this point forward, transferred files are scanned according to the configured timing and scope. If a threat is detected, the configured action is applied automatically.
Troubleshooting
If scanning does not operate correctly, verify the following.
| Issue | Verification |
|---|---|
| Scanning is not performed | Verify that the API Token is correct and does not contain leading or trailing spaces. |
| Authentication error occurs | Verify that the API Token is valid and has not been revoked or regenerated. |
| Threats are detected but Transfers are not blocked | Verify that On detection is set to Block transfer. |
| Certain files are not scanned | Verify the Scan scope configuration (All files, Executable files only, or Custom exceptions). |
| Transfer performance is slower | When Bothway is selected for Scan timing, files are scanned at both the source and target, which may increase processing time. Adjust the setting if necessary. |
| Integration fails in a restricted network | Verify that outbound HTTPS communication (port 443) to the Kaspersky API Endpoint is allowed. |