Fortinet Document Library

Version:


Table of Contents

1.0.0
Copy Link

About the connector

NeutrinoAPI is a general-purpose tool which can assist in many different situations. It solves recurring problems encountered during the development of software systems. The API has a variety of functions ranging from Phone and IP lookup to HTML code extraction.

This document provides information about the NeutrinoAPI connector, which facilitates automated interactions with NeutrinoAPI using FortiSOAR™ playbooks. Add the NeutrinoAPI connector as a step in FortiSOAR™ playbooks and perform automated operations, such as retrieving location, blocklisted, and general information about a specified IP address.

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

For the detailed procedure to install a connector, click here.

Prerequisites to configuring the connector

  • You must have the URL of NeutrinoAPI 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 NeutrinoAPI connector and click Configure to configure the following parameters:

Parameter Description
Server URL URL of the NeutrinoAPI server to which you will connect and perform automated operations.
User ID User ID used to access the NeutrinoAPI server to which you will connect and perform automated operations.
API Key API key configured for your account to access the NeutrinoAPI endpoint 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
Analyze IP Runs an analysis and retrieves information about a specified IP address using NeutrinoAPI. Information such as location, host, provider’s domain, and if the specified IP address is an ISP is retrieved from NeutrinoAPI. ip_probe
Investigation
Get IP Information Retrieves information about a specified IP address, specifically its exact location, using NeutrinoAPI. ip_info
Investigation
IP Blocklist Status Retrieves information about whether a specified IP address is or was blocklisted, how many times it was blocklisted and the reasons for its blocklisting from NeutrinoAPI. ip_blocklist
Investigation

operation: Analyze IP Address

Input parameters

Parameter Description
IP Address IP address based on which you want to runs an analysis and retrieves information using the NeutrinoAPI.

Output

The output contains the following populated JSON schema:
{
     "provider-type": "",
     "city": "",
     "currency-code": "",
     "is-hosting": "",
     "provider-domain": "",
     "provider-website": "",
     "hostname": "",
     "country-code3": "",
     "country-code": "",
     "region": "",
     "provider-description": "",
     "is-isp": "",
     "country": "",
     "valid": "",
     "continent-code": "",
     "ip": ""
}

operation: Get IP Address Information

Input parameters

Parameter Description
IP Address IP address whose information you want to retrieve using the NeutrinoAPI.

Output

The output contains the following populated JSON schema:
{
     "city": "",
     "currency-code": "",
     "latitude": "",
     "hostname": "",
     "longitude": "",
     "country-code3": "",
     "country-code": "",
     "region": "",
     "country": "",
     "valid": "",
     "continent-code": "",
     "ip": ""
}

operation: Get IP Address Blocklist Status

Input parameters

Parameter Description
IP Address IP address whose blocklist status or information you want to retrieve using the NeutrinoAPI.

Output

The output contains the following populated JSON schema:
{
     "is-vpn": "",
     "is-exploit-bot": "",
     "is-tor": "",
     "is-listed": "",
     "is-dshield": "",
     "is-bot": "",
     "is-spam-bot": "",
     "is-hijacked": "",
     "list-count": "",
     "is-malware": "",
     "is-spider": "",
     "is-proxy": "",
     "is-spyware": "",
     "last-seen": "",
     "blocklists": [],
     "ip": ""
}

Included playbooks

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

  • Analyze IP Address
  • Get IP Address Blocklist Status
  • Get IP Address Information

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

NeutrinoAPI is a general-purpose tool which can assist in many different situations. It solves recurring problems encountered during the development of software systems. The API has a variety of functions ranging from Phone and IP lookup to HTML code extraction.

This document provides information about the NeutrinoAPI connector, which facilitates automated interactions with NeutrinoAPI using FortiSOAR™ playbooks. Add the NeutrinoAPI connector as a step in FortiSOAR™ playbooks and perform automated operations, such as retrieving location, blocklisted, and general information about a specified IP address.

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

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

Parameter Description
Server URL URL of the NeutrinoAPI server to which you will connect and perform automated operations.
User ID User ID used to access the NeutrinoAPI server to which you will connect and perform automated operations.
API Key API key configured for your account to access the NeutrinoAPI endpoint 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
Analyze IP Runs an analysis and retrieves information about a specified IP address using NeutrinoAPI. Information such as location, host, provider’s domain, and if the specified IP address is an ISP is retrieved from NeutrinoAPI. ip_probe
Investigation
Get IP Information Retrieves information about a specified IP address, specifically its exact location, using NeutrinoAPI. ip_info
Investigation
IP Blocklist Status Retrieves information about whether a specified IP address is or was blocklisted, how many times it was blocklisted and the reasons for its blocklisting from NeutrinoAPI. ip_blocklist
Investigation

operation: Analyze IP Address

Input parameters

Parameter Description
IP Address IP address based on which you want to runs an analysis and retrieves information using the NeutrinoAPI.

Output

The output contains the following populated JSON schema:
{
     "provider-type": "",
     "city": "",
     "currency-code": "",
     "is-hosting": "",
     "provider-domain": "",
     "provider-website": "",
     "hostname": "",
     "country-code3": "",
     "country-code": "",
     "region": "",
     "provider-description": "",
     "is-isp": "",
     "country": "",
     "valid": "",
     "continent-code": "",
     "ip": ""
}

operation: Get IP Address Information

Input parameters

Parameter Description
IP Address IP address whose information you want to retrieve using the NeutrinoAPI.

Output

The output contains the following populated JSON schema:
{
     "city": "",
     "currency-code": "",
     "latitude": "",
     "hostname": "",
     "longitude": "",
     "country-code3": "",
     "country-code": "",
     "region": "",
     "country": "",
     "valid": "",
     "continent-code": "",
     "ip": ""
}

operation: Get IP Address Blocklist Status

Input parameters

Parameter Description
IP Address IP address whose blocklist status or information you want to retrieve using the NeutrinoAPI.

Output

The output contains the following populated JSON schema:
{
     "is-vpn": "",
     "is-exploit-bot": "",
     "is-tor": "",
     "is-listed": "",
     "is-dshield": "",
     "is-bot": "",
     "is-spam-bot": "",
     "is-hijacked": "",
     "list-count": "",
     "is-malware": "",
     "is-spider": "",
     "is-proxy": "",
     "is-spyware": "",
     "last-seen": "",
     "blocklists": [],
     "ip": ""
}

Included playbooks

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