Fortinet Document Library

Version:


Table of Contents

1.0.0
Copy Link

About the connector

MetaDefender is a cybersecurity platform for preventing and detecting cybersecurity threats on multiple data channels.

This document provides information about the Metadefender connector, which facilitates automated interactions, with a Metadefender server using FortiSOAR™ playbooks. Add the Metadefender connector as a step in FortiSOAR™ playbooks and perform automated operations, such as retrieving reputation information of a specific IP address or file hash and retrieving a scan result from Metadefender for a submitted file.

 

Version information

Connector Version: 1.0.0

Compatibility with FortiSOAR™ Versions: 4.10.3-161 and later

Compatibility with Metadefender Version: 2.0 and later

 

Installing the connector

For the procedure to install a connector, click here.

 

Prerequisites to configuring the connector

  • You must have the URL of the Metadefender server to which you will connect and perform the automated operations and the API key configured for your account to access that Metadefender server.
  • To access the FortiSOAR™ UI, ensure that port 443 is open through the firewall for the FortiSOAR™ instance.

 

Configuring the connector

For the procedure to configure a connector, click here.

 

Configuration parameters

In FortiSOAR™, on the Connectors page, select the Metadefender connector and click Configure to configure the following parameters:

 

Parameter Description
Server URL URL of the Metadefender server to which you will connect and perform the automated operations.
API Key API key that is configured for your account for the Metadefender server to which you will connect and perform the automated operations.
Verify SSL Specifies whether the SSL certificate for the server is to be verified or not.
By default, this option is set as True.

 

Actions supported by the connector

The following automated operations can be included in playbooks and you can also use the annotations to access operations from FortiSOAR™ release 4.10.0 onwards:

 

Function Description Annotation and Category
Get IP Reputation Retrieves details and reputation of the IP address that you have specified from the Metadefender server. get_ip_reputation
Investigation
Get Filehash Reputation Retrieves details and reputation of the file hash that you have specified from the Metadefender server. get_hash_reputation
Investigation
Get Scan File Result Retrieves a scan result containing details and reputation of a file hash that you had previously submitted on the Metadefender server. The information is retrieved from the Metadefender server based on the Data ID that you specify. get_scan_file_result
Investigation

 

operation: Get IP Reputation

Input parameters

 

Parameter Description
IP Address IP address for which you want to retrieve reputation information from the Metadefender server.

 

Output

The JSON output contains all information, including reputation information, for the IP address that you have specified, retrieved from the Metadefender server.

Following image displays a sample output:

 

Sample output of the Get IP Reputation operation

 

operation: Get Filehash Reputation

Input parameters

 

Parameter Description
File Hash Hash value of the file for which you want to retrieve reputation information from the Metadefender server.

 

Output

The JSON output contains all information, including reputation information, for the file hash that you have specified, retrieved from the Metadefender server.

Following image displays a sample output:

 

Sample output of the Get Filehash Reputation operation

 

operation: Get Scan File Result

Input parameters

 

Parameter Description
Data ID Data ID of file, which you had previously submitted to Metadefender, and for which you want to retrieve reputation information from the Metadefender server. Data ID is similar to a file hash value.

 

Output

The JSON output contains all information, including reputation information for the file, which you had previously submitted to Metadefender, retrieved from the Metadefender server, based on the Data ID that you have specified.

Following image displays a sample output:

 

Sample output of the Get Scan File Result operation

 

Included playbooks

The Sample - Metadefender - 1.0.0 playbook collection comes bundled with the Metadefender connector. This playbook contains steps using which you can perform all supported actions. You can see the bundled playbooks in the Automation > Playbooks section in FortiSOAR™ after importing the Metadefender connector.

  • Get Filehash Reputation
  • Get IP Reputation
  • Get Scan File Result

Note: If you are planning to use any of the sample playbooks in your environment, ensure that you clone those playbooks and move them to a different collection since the sample playbook collection gets deleted during connector upgrade and delete.

 

About the connector

MetaDefender is a cybersecurity platform for preventing and detecting cybersecurity threats on multiple data channels.

This document provides information about the Metadefender connector, which facilitates automated interactions, with a Metadefender server using FortiSOAR™ playbooks. Add the Metadefender connector as a step in FortiSOAR™ playbooks and perform automated operations, such as retrieving reputation information of a specific IP address or file hash and retrieving a scan result from Metadefender for a submitted file.

 

Version information

Connector Version: 1.0.0

Compatibility with FortiSOAR™ Versions: 4.10.3-161 and later

Compatibility with Metadefender Version: 2.0 and later

 

Installing the connector

For the procedure to install a connector, click here.

 

Prerequisites to configuring the connector

 

Configuring the connector

For the procedure to configure a connector, click here.

 

Configuration parameters

In FortiSOAR™, on the Connectors page, select the Metadefender connector and click Configure to configure the following parameters:

 

Parameter Description
Server URL URL of the Metadefender server to which you will connect and perform the automated operations.
API Key API key that is configured for your account for the Metadefender server to which you will connect and perform the automated operations.
Verify SSL Specifies whether the SSL certificate for the server is to be verified or not.
By default, this option is set as True.

 

Actions supported by the connector

The following automated operations can be included in playbooks and you can also use the annotations to access operations from FortiSOAR™ release 4.10.0 onwards:

 

Function Description Annotation and Category
Get IP Reputation Retrieves details and reputation of the IP address that you have specified from the Metadefender server. get_ip_reputation
Investigation
Get Filehash Reputation Retrieves details and reputation of the file hash that you have specified from the Metadefender server. get_hash_reputation
Investigation
Get Scan File Result Retrieves a scan result containing details and reputation of a file hash that you had previously submitted on the Metadefender server. The information is retrieved from the Metadefender server based on the Data ID that you specify. get_scan_file_result
Investigation

 

operation: Get IP Reputation

Input parameters

 

Parameter Description
IP Address IP address for which you want to retrieve reputation information from the Metadefender server.

 

Output

The JSON output contains all information, including reputation information, for the IP address that you have specified, retrieved from the Metadefender server.

Following image displays a sample output:

 

Sample output of the Get IP Reputation operation

 

operation: Get Filehash Reputation

Input parameters

 

Parameter Description
File Hash Hash value of the file for which you want to retrieve reputation information from the Metadefender server.

 

Output

The JSON output contains all information, including reputation information, for the file hash that you have specified, retrieved from the Metadefender server.

Following image displays a sample output:

 

Sample output of the Get Filehash Reputation operation

 

operation: Get Scan File Result

Input parameters

 

Parameter Description
Data ID Data ID of file, which you had previously submitted to Metadefender, and for which you want to retrieve reputation information from the Metadefender server. Data ID is similar to a file hash value.

 

Output

The JSON output contains all information, including reputation information for the file, which you had previously submitted to Metadefender, retrieved from the Metadefender server, based on the Data ID that you have specified.

Following image displays a sample output:

 

Sample output of the Get Scan File Result operation

 

Included playbooks

The Sample - Metadefender - 1.0.0 playbook collection comes bundled with the Metadefender connector. This playbook contains steps using which you can perform all supported actions. You can see the bundled playbooks in the Automation > Playbooks section in FortiSOAR™ after importing the Metadefender connector.

Note: If you are planning to use any of the sample playbooks in your environment, ensure that you clone those playbooks and move them to a different collection since the sample playbook collection gets deleted during connector upgrade and delete.