Fortinet Document Library

Version:


Table of Contents

1.0.0
Copy Link

About the connector

Cymon is the largest open tracker of malware, phishing, botnets, spam, and more. 

This document provides information about the Cymon connector, which facilitates automated interactions with Cymon using FortiSOAR™ playbooks. Add the Cymon connector as a step in FortiSOAR™ playbooks and perform automated operations, such as retrieving information about domains, IP addresses, or file hashes from the Cymon v1 API.

Version information

Connector Version: 1.0.0

Authored By: Fortinet

Certified: No

Installing the connector

All connectors provided by FortiSOAR™ are delivered using a FortiSOAR™ repository. Therefore, you must set up your FortiSOAR™ repository and use the yum command to install connectors:

yum install cyops-connector-cymon

For the detailed procedure to install a connector, click here

Prerequisites to configuring the connector

  • You must have the URL of Cymon server to which you will connect and perform automated operations and the API key to access the Cymon APIs.
  • 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 Cymon connector and click Configure to configure the following parameters:

Parameter Description
Server URL Server address of Cymon.
API Key Valid API key to access the Cymon APIs.
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 and onwards:

Function Description Annotation and Category
IP Address Lookup Fetch details about an IP address from Cymon. lookup_ip
Investigation
Look Up Domain Fetch details about a Domain from Cymon. lookup_domain
Investigation
Lookup File Hash Look up details about a file hash in Cymon. lookup_hash
Investigation

operation: IP Address Lookup

Input parameters

Parameter Description
IP Address Specify the IP address for which you want to retrieve information.

Output

The output contains the following populated JSON schema:
{
     "sources": [],
     "domains": {
         "count": "",
         "next": "",
         "previous": "",
         "results": []
     },
     "created": "",
     "addr": "",
     "urls": {
         "count": "",
         "next": "",
         "previous": "",
         "results": []
     },
     "events": {
         "count": "",
         "next": "",
         "previous": "",
         "results": []
     },
     "updated": ""
}

operation: Look Up Domain

Input parameters

Parameter Description
Domain Specify the Domain for which you want to retrieve information.

Output

The output contains the following populated JSON schema:
{
     "sources": [],
     "created": "",
     "urls": [],
     "name": "",
     "updated": "",
     "ips": []
}

operation: Lookup File Hash

Input parameters

Parameter Description
Filehash Specify the filehash for which you want to retrieve information.

Output

The output contains the following populated JSON schema:
{
     "result": {},
     "request_status": ""
}

Included playbooks

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

  • IP Address Lookup
  • Look Up Domain
  • Lookup File Hash

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

Cymon is the largest open tracker of malware, phishing, botnets, spam, and more. 

This document provides information about the Cymon connector, which facilitates automated interactions with Cymon using FortiSOAR™ playbooks. Add the Cymon connector as a step in FortiSOAR™ playbooks and perform automated operations, such as retrieving information about domains, IP addresses, or file hashes from the Cymon v1 API.

Version information

Connector Version: 1.0.0

Authored By: Fortinet

Certified: No

Installing the connector

All connectors provided by FortiSOAR™ are delivered using a FortiSOAR™ repository. Therefore, you must set up your FortiSOAR™ repository and use the yum command to install connectors:

yum install cyops-connector-cymon

For the detailed 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 Cymon connector and click Configure to configure the following parameters:

Parameter Description
Server URL Server address of Cymon.
API Key Valid API key to access the Cymon APIs.
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 and onwards:

Function Description Annotation and Category
IP Address Lookup Fetch details about an IP address from Cymon. lookup_ip
Investigation
Look Up Domain Fetch details about a Domain from Cymon. lookup_domain
Investigation
Lookup File Hash Look up details about a file hash in Cymon. lookup_hash
Investigation

operation: IP Address Lookup

Input parameters

Parameter Description
IP Address Specify the IP address for which you want to retrieve information.

Output

The output contains the following populated JSON schema:
{
     "sources": [],
     "domains": {
         "count": "",
         "next": "",
         "previous": "",
         "results": []
     },
     "created": "",
     "addr": "",
     "urls": {
         "count": "",
         "next": "",
         "previous": "",
         "results": []
     },
     "events": {
         "count": "",
         "next": "",
         "previous": "",
         "results": []
     },
     "updated": ""
}

operation: Look Up Domain

Input parameters

Parameter Description
Domain Specify the Domain for which you want to retrieve information.

Output

The output contains the following populated JSON schema:
{
     "sources": [],
     "created": "",
     "urls": [],
     "name": "",
     "updated": "",
     "ips": []
}

operation: Lookup File Hash

Input parameters

Parameter Description
Filehash Specify the filehash for which you want to retrieve information.

Output

The output contains the following populated JSON schema:
{
     "result": {},
     "request_status": ""
}

Included playbooks

The Sample - Cymon - 1.0.0 playbook collection comes bundled with the Cymon connector. These playbooks contain steps using which you can perform all supported actions. You can see bundled playbooks in the Automation > Playbooks section in FortiSOAR™ after importing the Cymon 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.