Discover

Get Started

Developers

Industries

Integrate Fortinet FortiEDR Antivirus

Overview

You can integrate Fortinet FortiEDR 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.

ItemDescription
Fortinet FortiEDRA Fortinet FortiEDR environment with API access for file scanning is required.
API CredentialsAn API Endpoint and API Key are required.
NetworkThe environment where the product is installed must allow outbound HTTPS communication (port 443) to the API Endpoint.

Verify API Credentials

To scan files with Fortinet FortiEDR, you need an API Endpoint and API Key.

Step 1. Verify the API Endpoint

In the management console, verify the API Endpoint used for file scanning (for example, https://fortigate.example.com/api/...).

4_1

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.

4_2

Verification

✔ The API Endpoint has been verified.

✔ The API Key has been generated.

Configure Fortinet FortiEDR Integration

Enter the verified credentials and configure the scanning options.

When you open the Security configuration page, the following screen is displayed.

4_3

Step 1. Enter the API Endpoint

Enter the API Endpoint verified in the "Verify API Credentials" section into the API Endpoint field (for example, https://fortigate.example.com/api/...).

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 Scan Timing

Select when files should be scanned in Scan timing.

OptionDescription
Before transfer at sourceScan files on the source before the Transfer starts.
After transfer at targetScan files on the target after the Transfer completes.
BothwayScan files both before the Transfer at the source and after the Transfer at the target.

Step 4. Select On Detection

Select how the system should respond when a threat is detected in On detection.

OptionDescription
Block transferBlock the Transfer when a threat is detected.
Alert onlyAllow the Transfer to continue and generate an alert only.
Admin confirmRequire administrator confirmation before proceeding.

Step 5. Select Scan Scope

Select which files should be scanned in Scan scope.

OptionDescription
All filesScan every transferred file.
Executable files onlyScan executable files only.
Custom exceptionsScan files according to user-defined exception rules.

Step 6. Save the Configuration

After completing the configuration, click Add to save the integration.

Verification

✔ The API Endpoint and API Key have 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.

4_4

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).

4_5

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.

IssueVerification
Scanning is not performedVerify that the API Endpoint and API Key are correct and do not contain leading or trailing spaces.
Authentication error occursVerify that the API Key is valid and has not been revoked or regenerated.
Threats are detected but Transfers are not blockedVerify that On detection is set to Block transfer.
Certain files are not scannedVerify the Scan scope configuration (All files, Executable files only, or Custom exceptions).
Transfer performance is slowerWhen 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 networkVerify that outbound HTTPS communication (port 443) to the API Endpoint is allowed by the firewall or proxy.