Fortinet Document Library

Version:


Table of Contents

Fortinet Web Filter Lookup

1.0.0
Copy Link

About the connector

Fortinet Web Filter Lookup allows users to check the category and classification for any Domain or URL.

This document provides information about the Fortinet Web Filter Lookup connector, which facilitates automated interactions, with Fortinet Web Filter Lookup server using FortiSOAR™ playbooks. Add the Fortinet Web Filter Lookup connector as a step in FortiSOAR™ playbooks and perform automated operations, such as checking the categorization of a domain or URL you have specified on Fortinet Web Filter Lookup.

Version information

Connector Version: 1.0.0

FortiSOAR™ Version Tested on: 5.1.0-464

Authored By: Fortinet

Certified: Yes

Installing the connector

From FortiSOAR™ 5.0.0 onwards, use the Connector Store to install the connector. For the detailed procedure to install a connector, click here.
You can also use the yum command to install connectors. Connectors provided by FortiSOAR™ are delivered using a FortiSOAR™ repository. Therefore, you must set up your FortiSOAR™ repository and run the yum command as a root user to install connectors:

yum install cyops-connector-fortinet-web-filter-lookup

Prerequisites to configuring the connector

  • You must have the URL of Fortinet Web Filter Lookup server to which you will connect and perform automated operations.
  • To access the CyOPsTM UI, ensure that port 443 is open through the firewall for the CyOPsTM instance.

Configuring the connector

For the procedure to configure a connector, click here

Configuration parameters

In FortiSOAR™, on the Connectors page, click the Fortinet Web Filter Lookup connector row (if you are in the Grid view on the Connectors page) and in the Configurations tab enter the required configuration details: 

Parameter Description
Server URL URL of the Fortinet Web Filter Lookup to which you will connect and check categorization for a domain or a URL.
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 CyOPsTM release 4.10.0 and onwards:

Function Description Annotation and Category
Check Category of Domain or URL Checks the categorization of the domain or URL you have specified and retrieves the category and information about the specified domain or URL from Fortinet Web Filter Lookup. url_review
Investigation

operation: Check Category of Domain or URL

Input parameters

Parameter Description
Submit Domain/URL Valid Domain or URL that you want to submit to Fortinet Web Filter Lookup for the review process and whose categorization and information you want to retrieve from Fortinet Web Filter Lookup.

Output

The output contains the following populated JSON schema:
{
     "url": "",
     "info": "",
     "category": ""
}

Included playbooks

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

  • Check Category of Domain or URL

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

Fortinet Web Filter Lookup allows users to check the category and classification for any Domain or URL.

This document provides information about the Fortinet Web Filter Lookup connector, which facilitates automated interactions, with Fortinet Web Filter Lookup server using FortiSOAR™ playbooks. Add the Fortinet Web Filter Lookup connector as a step in FortiSOAR™ playbooks and perform automated operations, such as checking the categorization of a domain or URL you have specified on Fortinet Web Filter Lookup.

Version information

Connector Version: 1.0.0

FortiSOAR™ Version Tested on: 5.1.0-464

Authored By: Fortinet

Certified: Yes

Installing the connector

From FortiSOAR™ 5.0.0 onwards, use the Connector Store to install the connector. For the detailed procedure to install a connector, click here.
You can also use the yum command to install connectors. Connectors provided by FortiSOAR™ are delivered using a FortiSOAR™ repository. Therefore, you must set up your FortiSOAR™ repository and run the yum command as a root user to install connectors:

yum install cyops-connector-fortinet-web-filter-lookup

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, click the Fortinet Web Filter Lookup connector row (if you are in the Grid view on the Connectors page) and in the Configurations tab enter the required configuration details: 

Parameter Description
Server URL URL of the Fortinet Web Filter Lookup to which you will connect and check categorization for a domain or a URL.
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 CyOPsTM release 4.10.0 and onwards:

Function Description Annotation and Category
Check Category of Domain or URL Checks the categorization of the domain or URL you have specified and retrieves the category and information about the specified domain or URL from Fortinet Web Filter Lookup. url_review
Investigation

operation: Check Category of Domain or URL

Input parameters

Parameter Description
Submit Domain/URL Valid Domain or URL that you want to submit to Fortinet Web Filter Lookup for the review process and whose categorization and information you want to retrieve from Fortinet Web Filter Lookup.

Output

The output contains the following populated JSON schema:
{
     "url": "",
     "info": "",
     "category": ""
}

Included playbooks

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