Overview#
You can integrate Vitrium Security to scan files during Transfer and detect or block potential threats.
Once configured, transferred files are scanned automatically. If a threat is detected, the configured On detection action is applied to block the Transfer or generate an alert.
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 |
|---|---|
| Vitrium Account | A Vitrium Security environment with API access for file scanning is required. |
| API Credentials | An API Endpoint and API Key are required. |
| Network | The environment where the product is installed must allow outbound HTTPS communication (port 443) to the API Endpoint. |
Verify API Credentials#
To scan files with Vitrium Security, you need an API Endpoint and an API Key.
Step 1. Verify the API Endpoint#
In the management console, locate the API endpoint used for file scanning.
(Example: https://api.vitrium.com/...)
Step 2. Generate an API Key#
In the management console, open the API access settings, generate or retrieve the API Key, and copy it.
Treat the API Key as a password. Anyone with access to the API Key can use the scanning API, so do not expose it in public repositories or external documentation. If the API Key is compromised, revoke it and generate a new one.
Verification#
✔ The API Endpoint has been verified.
✔ The API Key has been generated.
Configure Vitrium Security Integration#
Enter the verified credentials and configure the detection policy.
When you open the Security configuration page, the following screen is displayed.
Step 1. Enter the API Endpoint#
Enter the API Endpoint verified in the "Verify API Credentials" section into the API Endpoint field.
(Example: https://api.vitrium.com/...)
Step 2. Enter the API Key#
Enter the API Key generated in the "Verify API Credentials" section into the API Key field.
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. Save the Configuration#
After completing the configuration, click Add to save the integration.
Verification#
✔ The API Endpoint and API Key have been entered.
✔ The On detection option has 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 automatically. If a threat is detected, the configured action is applied.
Troubleshooting#
If scanning does not operate correctly, verify the following.
| Issue | Verification |
|---|---|
| Scanning is not performed | Verify that the API Endpoint and API Key are correct and do not contain leading or trailing spaces. |
| Authentication error occurs | Verify that the API Key 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. |
| Integration fails in a restricted network | Verify that outbound HTTPS communication (port 443) to the API Endpoint is allowed through the firewall or proxy. |