Fortinet Document Library

Version:


Table of Contents

Mxtoolbox

1.0.0
Copy Link

About the connector

MxToolbox offers monitoring solutions and lookup tools. 

This document provides information about the MxToolbox connector, which facilitates automated interactions with MxToolbox using FortiSOAR™ playbooks. Add the MxToolbox connector as a step in FortiSOAR™ playbooks and perform automated operations, such as making an API Call using MxToolbox connector for various investigation methods.

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-mxtoolbox

For the detailed procedure to install a connector, click here

Prerequisites to configuring the connector

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

Parameter Description
Server URL URL of the MxToolbox server to which you will connect and perform automated operations.
API Key API key that is configured for your account to access the MxToolbox endpoint.
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
Get MxToolbox Records Makes an API Call via MxToolbox connector for various investigation methods. api_call
Investigation

operation: Get MxToolbox Records

Input parameters

Parameter Description
API Method API methods are Lookup, Monitor and Usage used for various investigation methods.

Output

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

Included playbooks

The Sample - MXToolbox - 1.0.0 playbook collection comes bundled with the MxToolbox 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 MxToolbox connector.

  • Get MxToolbox Records

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

MxToolbox offers monitoring solutions and lookup tools. 

This document provides information about the MxToolbox connector, which facilitates automated interactions with MxToolbox using FortiSOAR™ playbooks. Add the MxToolbox connector as a step in FortiSOAR™ playbooks and perform automated operations, such as making an API Call using MxToolbox connector for various investigation methods.

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-mxtoolbox

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

Parameter Description
Server URL URL of the MxToolbox server to which you will connect and perform automated operations.
API Key API key that is configured for your account to access the MxToolbox endpoint.
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
Get MxToolbox Records Makes an API Call via MxToolbox connector for various investigation methods. api_call
Investigation

operation: Get MxToolbox Records

Input parameters

Parameter Description
API Method API methods are Lookup, Monitor and Usage used for various investigation methods.

Output

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

Included playbooks

The Sample - MXToolbox - 1.0.0 playbook collection comes bundled with the MxToolbox 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 MxToolbox 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.