Fortinet white logo
Fortinet white logo
1.1.0

MaxMind v1.1.0

About the connector

MaxMind GeoIP2 offer industry-leading IP intelligence data. Get detailed information about an IP address, such as the geographical location, organization, and other related data, with varying levels of precision.

This document provides information about the MaxMind connector, which facilitates automated interactions, with a MaxMind server using FortiSOAR™ playbooks. Add the MaxMind connector as a step in FortiSOAR™ playbooks and perform automated operations with MaxMind.

Version information

Connector Version: 1.1.0

FortiSOAR™ Version Tested on: 7.6.0-5012

MaxMind Version Tested on: v2.1

Authored By: Fortinet

Certified: Yes

Release Notes for version 1.1.0

Following enhancements have been made to the MaxMind Connector in version 1.1.0:

  • Added a new action Execute an API Request.
  • Updated the action Get Insights Details of IP to enhance JSON response format.
  • Renamed the configuration parameter User Id to Account ID.
  • The configuration parameter Verify SSL is now Optional. Default value is True.
  • Updated output schemas for all actions.
  • Updated sample playbook collection.
  • The input parameter IP Address is now mandatory for every connector action.
  • Updated the connector logo to conform with MaxMind's latest branding.

Installing the connector

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

You can also use the yum command as a root user to install the connector:

yum install cyops-connector-maxmind

Prerequisites to configuring the connector

  • You must have the credentials of MaxMind server to connect and perform automated operations.
  • The FortiSOAR™ server should have outbound connectivity to port 443 on the MaxMind server.

Minimum Permissions Required

  • Not applicable

Configuring the connector

For the procedure to configure a connector, click here

Configuration parameters

In FortiSOAR™, on the Connectors page, click the MaxMind 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 Server URL of the MaxMind GeoIP2 server to connect and perform the automated operations.
Account ID Account ID of the MaxMind GeoIP2 server to connect and perform the automated operations.
License Key License Key of the MaxMind GeoIP2 server to connect and perform the automated operations.
Verify SSL Specifies whether the SSL certificate for the server is to be verified.
By default, this option is selected, i.e., set to true.

Actions supported by the connector

You can use the following automated operations in playbooks and also use the annotations to access operations:

Function Description Annotation and Category
Get All Details of IP Retrieves details from MaxMind GeoIP2 based on the IP address you have specified. ip_all_details
Investigation
Get City Details of IP Retrieves details of a city from MaxMind GeoIP2 based on the IP address you have specified. ip_city_details
Investigation
Get Insights Details of IP Retrieves insight details from MaxMind GeoIP2 based on the IP address you have specified. ip_insights_details
Investigation
Get Country Details of IP Retrieves details of a country from MaxMind GeoIP2 based on the IP address you have specified. ip_country_details
Investigation
Execute an API Request Sends an API request to any MaxMind API endpoint based on specified HTTP method, endpoint, and other input parameters that you have specified, enabling flexible API interactions tailored to user needs. execute_an_api_call
Investigation

operation: Get All Details of IP

Input parameters

Parameter Description
IP Address Specify the IP address, whose details to retrieve from MaxMind GeoIP2.

Output

The output contains the following populated JSON schema:

{
    "city_data": {
        "continent": {
            "code": "",
            "geoname_id": "",
            "names": {
                "de": "",
                "en": "",
                "es": "",
                "fr": "",
                "ja": "",
                "pt-BR": "",
                "ru": "",
                "zh-CN": ""
            }
        },
        "country": {
            "geoname_id": "",
            "is_in_european_union": "",
            "iso_code": "",
            "names": {
                "de": "",
                "en": "",
                "es": "",
                "fr": "",
                "ja": "",
                "pt-BR": "",
                "ru": "",
                "zh-CN": ""
            }
        },
        "maxmind": {
            "queries_remaining": ""
        },
        "registered_country": {
            "geoname_id": "",
            "is_in_european_union": "",
            "iso_code": "",
            "names": {
                "de": "",
                "en": "",
                "es": "",
                "fr": "",
                "ja": "",
                "pt-BR": "",
                "ru": "",
                "zh-CN": ""
            }
        },
        "traits": {
            "ip_address": "",
            "is_anycast": "",
            "network": "",
            "autonomous_system_number": "",
            "autonomous_system_organization": "",
            "connection_type": "",
            "domain": "",
            "isp": "",
            "mobile_country_code": "",
            "mobile_network_code": "",
            "organization": ""
        },
        "city": {
            "geoname_id": "",
            "names": {
                "de": "",
                "en": "",
                "es": "",
                "fr": "",
                "ja": "",
                "pt-BR": "",
                "ru": "",
                "zh-CN": ""
            }
        },
        "location": {
            "accuracy_radius": "",
            "latitude": "",
            "longitude": "",
            "metro_code": "",
            "time_zone": ""
        },
        "postal": {
            "code": ""
        },
        "subdivisions": [
            {
                "geoname_id": "",
                "iso_code": "",
                "names": {
                    "de": "",
                    "en": "",
                    "es": "",
                    "fr": "",
                    "ja": "",
                    "ru": "",
                    "zh-CN": ""
                }
            }
        ]
    },
    "insights_data": {
        "continent": {
            "code": "",
            "geoname_id": "",
            "names": {
                "de": "",
                "en": "",
                "es": "",
                "fr": "",
                "ja": "",
                "pt-BR": "",
                "ru": "",
                "zh-CN": ""
            }
        },
        "country": {
            "geoname_id": "",
            "is_in_european_union": "",
            "iso_code": "",
            "names": {
                "de": "",
                "en": "",
                "es": "",
                "fr": "",
                "ja": "",
                "pt-BR": "",
                "ru": "",
                "zh-CN": ""
            },
            "confidence": ""
        },
        "maxmind": {
            "queries_remaining": ""
        },
        "registered_country": {
            "geoname_id": "",
            "is_in_european_union": "",
            "iso_code": "",
            "names": {
                "de": "",
                "en": "",
                "es": "",
                "fr": "",
                "ja": "",
                "pt-BR": "",
                "ru": "",
                "zh-CN": ""
            }
        },
        "traits": {
            "ip_address": "",
            "is_anycast": "",
            "network": "",
            "autonomous_system_number": "",
            "autonomous_system_organization": "",
            "connection_type": "",
            "domain": "",
            "isp": "",
            "mobile_country_code": "",
            "mobile_network_code": "",
            "organization": "",
            "is_anonymous": "",
            "is_anonymous_vpn": "",
            "is_hosting_provider": "",
            "is_public_proxy": "",
            "is_residential_proxy": "",
            "is_tor_exit_node": "",
            "static_ip_score": "",
            "user_count": "",
            "user_type": ""
        },
        "city": {
            "confidence": "",
            "geoname_id": "",
            "names": {
                "de": "",
                "en": "",
                "es": "",
                "fr": "",
                "ja": "",
                "pt-BR": "",
                "ru": "",
                "zh-CN": ""
            }
        },
        "location": {
            "accuracy_radius": "",
            "latitude": "",
            "longitude": "",
            "metro_code": "",
            "time_zone": "",
            "average_income": ""
        },
        "postal": {
            "code": "",
            "confidence": ""
        },
        "subdivisions": [
            {
                "geoname_id": "",
                "iso_code": "",
                "names": {
                    "de": "",
                    "en": "",
                    "es": "",
                    "fr": "",
                    "ja": "",
                    "ru": "",
                    "zh-CN": ""
                },
                "confidence": ""
            }
        ]
    },
    "country_data": {
        "continent": {
            "code": "",
            "geoname_id": "",
            "names": {
                "de": "",
                "en": "",
                "es": "",
                "fr": "",
                "ja": "",
                "pt-BR": "",
                "ru": "",
                "zh-CN": ""
            }
        },
        "country": {
            "geoname_id": "",
            "is_in_european_union": "",
            "iso_code": "",
            "names": {
                "de": "",
                "en": "",
                "es": "",
                "fr": "",
                "ja": "",
                "pt-BR": "",
                "ru": "",
                "zh-CN": ""
            }
        },
        "maxmind": {
            "queries_remaining": ""
        },
        "registered_country": {
            "geoname_id": "",
            "is_in_european_union": "",
            "iso_code": "",
            "names": {
                "de": "",
                "en": "",
                "es": "",
                "fr": "",
                "ja": "",
                "pt-BR": "",
                "ru": "",
                "zh-CN": ""
            }
        },
        "traits": {
            "ip_address": "",
            "is_anycast": "",
            "network": ""
        }
    }
}

operation: Get City Details of IP

Input parameters

Parameter Description
IP Address Specify the IP address, whose city details to retrieve from MaxMind GeoIP2.

Output

The output contains the following populated JSON schema:

{
    "continent": {
        "code": "",
        "geoname_id": "",
        "names": {
            "de": "",
            "en": "",
            "es": "",
            "fr": "",
            "ja": "",
            "pt-BR": "",
            "ru": "",
            "zh-CN": ""
        }
    },
    "country": {
        "geoname_id": "",
        "is_in_european_union": "",
        "iso_code": "",
        "names": {
            "de": "",
            "en": "",
            "es": "",
            "fr": "",
            "ja": "",
            "pt-BR": "",
            "ru": "",
            "zh-CN": ""
        }
    },
    "maxmind": {
        "queries_remaining": ""
    },
    "registered_country": {
        "geoname_id": "",
        "is_in_european_union": "",
        "iso_code": "",
        "names": {
            "de": "",
            "en": "",
            "es": "",
            "fr": "",
            "ja": "",
            "pt-BR": "",
            "ru": "",
            "zh-CN": ""
        }
    },
    "traits": {
        "ip_address": "",
        "is_anycast": "",
        "network": "",
        "autonomous_system_number": "",
        "autonomous_system_organization": "",
        "connection_type": "",
        "domain": "",
        "isp": "",
        "mobile_country_code": "",
        "mobile_network_code": "",
        "organization": ""
    },
    "city": {
        "geoname_id": "",
        "names": {
            "de": "",
            "en": "",
            "es": "",
            "fr": "",
            "ja": "",
            "pt-BR": "",
            "ru": "",
            "zh-CN": ""
        }
    },
    "location": {
        "accuracy_radius": "",
        "latitude": "",
        "longitude": "",
        "metro_code": "",
        "time_zone": ""
    },
    "postal": {
        "code": ""
    },
    "subdivisions": [
        {
            "geoname_id": "",
            "iso_code": "",
            "names": {
                "de": "",
                "en": "",
                "es": "",
                "fr": "",
                "ja": "",
                "ru": "",
                "zh-CN": ""
            }
        }
    ]
}

operation: Get Insights Details of IP

Input parameters

Parameter Description
IP Address Specify the IP address, whose insights to retrieve from MaxMind GeoIP2.

Output

The output contains the following populated JSON schema:

{
    "continent": {
        "code": "",
        "geoname_id": "",
        "names": {
            "de": "",
            "en": "",
            "es": "",
            "fr": "",
            "ja": "",
            "pt-BR": "",
            "ru": "",
            "zh-CN": ""
        }
    },
    "country": {
        "geoname_id": "",
        "is_in_european_union": "",
        "iso_code": "",
        "names": {
            "de": "",
            "en": "",
            "es": "",
            "fr": "",
            "ja": "",
            "pt-BR": "",
            "ru": "",
            "zh-CN": ""
        },
        "confidence": ""
    },
    "maxmind": {
        "queries_remaining": ""
    },
    "registered_country": {
        "geoname_id": "",
        "is_in_european_union": "",
        "iso_code": "",
        "names": {
            "de": "",
            "en": "",
            "es": "",
            "fr": "",
            "ja": "",
            "pt-BR": "",
            "ru": "",
            "zh-CN": ""
        }
    },
    "traits": {
        "ip_address": "",
        "is_anycast": "",
        "network": "",
        "autonomous_system_number": "",
        "autonomous_system_organization": "",
        "connection_type": "",
        "domain": "",
        "isp": "",
        "mobile_country_code": "",
        "mobile_network_code": "",
        "organization": "",
        "is_anonymous": "",
        "is_anonymous_vpn": "",
        "is_hosting_provider": "",
        "is_public_proxy": "",
        "is_residential_proxy": "",
        "is_tor_exit_node": "",
        "static_ip_score": "",
        "user_count": "",
        "user_type": ""
    },
    "city": {
        "confidence": "",
        "geoname_id": "",
        "names": {
            "de": "",
            "en": "",
            "es": "",
            "fr": "",
            "ja": "",
            "pt-BR": "",
            "ru": "",
            "zh-CN": ""
        }
    },
    "location": {
        "accuracy_radius": "",
        "latitude": "",
        "longitude": "",
        "metro_code": "",
        "time_zone": "",
        "average_income": ""
    },
    "postal": {
        "code": "",
        "confidence": ""
    },
    "subdivisions": [
        {
            "geoname_id": "",
            "iso_code": "",
            "names": {
                "de": "",
                "en": "",
                "es": "",
                "fr": "",
                "ja": "",
                "ru": "",
                "zh-CN": ""
            },
            "confidence": ""
        }
    ]
}

operation: Get Country Details of IP

Input parameters

Parameter Description
IP Address Specify the IP address, whose country details to retrieve from MaxMind GeoIP2.

Output

The output contains the following populated JSON schema:

{
    "continent": {
        "code": "",
        "geoname_id": "",
        "names": {
            "de": "",
            "en": "",
            "es": "",
            "fr": "",
            "ja": "",
            "pt-BR": "",
            "ru": "",
            "zh-CN": ""
        }
    },
    "country": {
        "geoname_id": "",
        "is_in_european_union": "",
        "iso_code": "",
        "names": {
            "de": "",
            "en": "",
            "es": "",
            "fr": "",
            "ja": "",
            "pt-BR": "",
            "ru": "",
            "zh-CN": ""
        }
    },
    "maxmind": {
        "queries_remaining": ""
    },
    "registered_country": {
        "geoname_id": "",
        "is_in_european_union": "",
        "iso_code": "",
        "names": {
            "de": "",
            "en": "",
            "es": "",
            "fr": "",
            "ja": "",
            "pt-BR": "",
            "ru": "",
            "zh-CN": ""
        }
    },
    "traits": {
        "ip_address": "",
        "is_anycast": "",
        "network": ""
    }
}

operation: Execute an API Request

Input parameters

Parameter Description
HTTP Method Select an HTTP action for the request. You can select from the following options:
  • DELETE
  • GET
  • PATCH
  • POST
  • PUT
Endpoint Specify the REST API endpoint for the action to perform. For example: city/target-ip-address
Query Parameters (Optional) Specify any optional parameters to add to the URL and refine the request.
Request Payload (Optional) Specify data, as JSON, to be sent as the request payload (typically for POST or PUT requests).

Output

The output contains a non-dictionary value.

Included playbooks

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

  • Execute an API Request
  • Get All Details of IP
  • Get City Details of IP
  • Get Country Details of IP
  • Get Insights Details of IP

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.

Previous
Next

MaxMind v1.1.0

About the connector

MaxMind GeoIP2 offer industry-leading IP intelligence data. Get detailed information about an IP address, such as the geographical location, organization, and other related data, with varying levels of precision.

This document provides information about the MaxMind connector, which facilitates automated interactions, with a MaxMind server using FortiSOAR™ playbooks. Add the MaxMind connector as a step in FortiSOAR™ playbooks and perform automated operations with MaxMind.

Version information

Connector Version: 1.1.0

FortiSOAR™ Version Tested on: 7.6.0-5012

MaxMind Version Tested on: v2.1

Authored By: Fortinet

Certified: Yes

Release Notes for version 1.1.0

Following enhancements have been made to the MaxMind Connector in version 1.1.0:

Installing the connector

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

You can also use the yum command as a root user to install the connector:

yum install cyops-connector-maxmind

Prerequisites to configuring the connector

Minimum Permissions Required

Configuring the connector

For the procedure to configure a connector, click here

Configuration parameters

In FortiSOAR™, on the Connectors page, click the MaxMind 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 Server URL of the MaxMind GeoIP2 server to connect and perform the automated operations.
Account ID Account ID of the MaxMind GeoIP2 server to connect and perform the automated operations.
License Key License Key of the MaxMind GeoIP2 server to connect and perform the automated operations.
Verify SSL Specifies whether the SSL certificate for the server is to be verified.
By default, this option is selected, i.e., set to true.

Actions supported by the connector

You can use the following automated operations in playbooks and also use the annotations to access operations:

Function Description Annotation and Category
Get All Details of IP Retrieves details from MaxMind GeoIP2 based on the IP address you have specified. ip_all_details
Investigation
Get City Details of IP Retrieves details of a city from MaxMind GeoIP2 based on the IP address you have specified. ip_city_details
Investigation
Get Insights Details of IP Retrieves insight details from MaxMind GeoIP2 based on the IP address you have specified. ip_insights_details
Investigation
Get Country Details of IP Retrieves details of a country from MaxMind GeoIP2 based on the IP address you have specified. ip_country_details
Investigation
Execute an API Request Sends an API request to any MaxMind API endpoint based on specified HTTP method, endpoint, and other input parameters that you have specified, enabling flexible API interactions tailored to user needs. execute_an_api_call
Investigation

operation: Get All Details of IP

Input parameters

Parameter Description
IP Address Specify the IP address, whose details to retrieve from MaxMind GeoIP2.

Output

The output contains the following populated JSON schema:

{
    "city_data": {
        "continent": {
            "code": "",
            "geoname_id": "",
            "names": {
                "de": "",
                "en": "",
                "es": "",
                "fr": "",
                "ja": "",
                "pt-BR": "",
                "ru": "",
                "zh-CN": ""
            }
        },
        "country": {
            "geoname_id": "",
            "is_in_european_union": "",
            "iso_code": "",
            "names": {
                "de": "",
                "en": "",
                "es": "",
                "fr": "",
                "ja": "",
                "pt-BR": "",
                "ru": "",
                "zh-CN": ""
            }
        },
        "maxmind": {
            "queries_remaining": ""
        },
        "registered_country": {
            "geoname_id": "",
            "is_in_european_union": "",
            "iso_code": "",
            "names": {
                "de": "",
                "en": "",
                "es": "",
                "fr": "",
                "ja": "",
                "pt-BR": "",
                "ru": "",
                "zh-CN": ""
            }
        },
        "traits": {
            "ip_address": "",
            "is_anycast": "",
            "network": "",
            "autonomous_system_number": "",
            "autonomous_system_organization": "",
            "connection_type": "",
            "domain": "",
            "isp": "",
            "mobile_country_code": "",
            "mobile_network_code": "",
            "organization": ""
        },
        "city": {
            "geoname_id": "",
            "names": {
                "de": "",
                "en": "",
                "es": "",
                "fr": "",
                "ja": "",
                "pt-BR": "",
                "ru": "",
                "zh-CN": ""
            }
        },
        "location": {
            "accuracy_radius": "",
            "latitude": "",
            "longitude": "",
            "metro_code": "",
            "time_zone": ""
        },
        "postal": {
            "code": ""
        },
        "subdivisions": [
            {
                "geoname_id": "",
                "iso_code": "",
                "names": {
                    "de": "",
                    "en": "",
                    "es": "",
                    "fr": "",
                    "ja": "",
                    "ru": "",
                    "zh-CN": ""
                }
            }
        ]
    },
    "insights_data": {
        "continent": {
            "code": "",
            "geoname_id": "",
            "names": {
                "de": "",
                "en": "",
                "es": "",
                "fr": "",
                "ja": "",
                "pt-BR": "",
                "ru": "",
                "zh-CN": ""
            }
        },
        "country": {
            "geoname_id": "",
            "is_in_european_union": "",
            "iso_code": "",
            "names": {
                "de": "",
                "en": "",
                "es": "",
                "fr": "",
                "ja": "",
                "pt-BR": "",
                "ru": "",
                "zh-CN": ""
            },
            "confidence": ""
        },
        "maxmind": {
            "queries_remaining": ""
        },
        "registered_country": {
            "geoname_id": "",
            "is_in_european_union": "",
            "iso_code": "",
            "names": {
                "de": "",
                "en": "",
                "es": "",
                "fr": "",
                "ja": "",
                "pt-BR": "",
                "ru": "",
                "zh-CN": ""
            }
        },
        "traits": {
            "ip_address": "",
            "is_anycast": "",
            "network": "",
            "autonomous_system_number": "",
            "autonomous_system_organization": "",
            "connection_type": "",
            "domain": "",
            "isp": "",
            "mobile_country_code": "",
            "mobile_network_code": "",
            "organization": "",
            "is_anonymous": "",
            "is_anonymous_vpn": "",
            "is_hosting_provider": "",
            "is_public_proxy": "",
            "is_residential_proxy": "",
            "is_tor_exit_node": "",
            "static_ip_score": "",
            "user_count": "",
            "user_type": ""
        },
        "city": {
            "confidence": "",
            "geoname_id": "",
            "names": {
                "de": "",
                "en": "",
                "es": "",
                "fr": "",
                "ja": "",
                "pt-BR": "",
                "ru": "",
                "zh-CN": ""
            }
        },
        "location": {
            "accuracy_radius": "",
            "latitude": "",
            "longitude": "",
            "metro_code": "",
            "time_zone": "",
            "average_income": ""
        },
        "postal": {
            "code": "",
            "confidence": ""
        },
        "subdivisions": [
            {
                "geoname_id": "",
                "iso_code": "",
                "names": {
                    "de": "",
                    "en": "",
                    "es": "",
                    "fr": "",
                    "ja": "",
                    "ru": "",
                    "zh-CN": ""
                },
                "confidence": ""
            }
        ]
    },
    "country_data": {
        "continent": {
            "code": "",
            "geoname_id": "",
            "names": {
                "de": "",
                "en": "",
                "es": "",
                "fr": "",
                "ja": "",
                "pt-BR": "",
                "ru": "",
                "zh-CN": ""
            }
        },
        "country": {
            "geoname_id": "",
            "is_in_european_union": "",
            "iso_code": "",
            "names": {
                "de": "",
                "en": "",
                "es": "",
                "fr": "",
                "ja": "",
                "pt-BR": "",
                "ru": "",
                "zh-CN": ""
            }
        },
        "maxmind": {
            "queries_remaining": ""
        },
        "registered_country": {
            "geoname_id": "",
            "is_in_european_union": "",
            "iso_code": "",
            "names": {
                "de": "",
                "en": "",
                "es": "",
                "fr": "",
                "ja": "",
                "pt-BR": "",
                "ru": "",
                "zh-CN": ""
            }
        },
        "traits": {
            "ip_address": "",
            "is_anycast": "",
            "network": ""
        }
    }
}

operation: Get City Details of IP

Input parameters

Parameter Description
IP Address Specify the IP address, whose city details to retrieve from MaxMind GeoIP2.

Output

The output contains the following populated JSON schema:

{
    "continent": {
        "code": "",
        "geoname_id": "",
        "names": {
            "de": "",
            "en": "",
            "es": "",
            "fr": "",
            "ja": "",
            "pt-BR": "",
            "ru": "",
            "zh-CN": ""
        }
    },
    "country": {
        "geoname_id": "",
        "is_in_european_union": "",
        "iso_code": "",
        "names": {
            "de": "",
            "en": "",
            "es": "",
            "fr": "",
            "ja": "",
            "pt-BR": "",
            "ru": "",
            "zh-CN": ""
        }
    },
    "maxmind": {
        "queries_remaining": ""
    },
    "registered_country": {
        "geoname_id": "",
        "is_in_european_union": "",
        "iso_code": "",
        "names": {
            "de": "",
            "en": "",
            "es": "",
            "fr": "",
            "ja": "",
            "pt-BR": "",
            "ru": "",
            "zh-CN": ""
        }
    },
    "traits": {
        "ip_address": "",
        "is_anycast": "",
        "network": "",
        "autonomous_system_number": "",
        "autonomous_system_organization": "",
        "connection_type": "",
        "domain": "",
        "isp": "",
        "mobile_country_code": "",
        "mobile_network_code": "",
        "organization": ""
    },
    "city": {
        "geoname_id": "",
        "names": {
            "de": "",
            "en": "",
            "es": "",
            "fr": "",
            "ja": "",
            "pt-BR": "",
            "ru": "",
            "zh-CN": ""
        }
    },
    "location": {
        "accuracy_radius": "",
        "latitude": "",
        "longitude": "",
        "metro_code": "",
        "time_zone": ""
    },
    "postal": {
        "code": ""
    },
    "subdivisions": [
        {
            "geoname_id": "",
            "iso_code": "",
            "names": {
                "de": "",
                "en": "",
                "es": "",
                "fr": "",
                "ja": "",
                "ru": "",
                "zh-CN": ""
            }
        }
    ]
}

operation: Get Insights Details of IP

Input parameters

Parameter Description
IP Address Specify the IP address, whose insights to retrieve from MaxMind GeoIP2.

Output

The output contains the following populated JSON schema:

{
    "continent": {
        "code": "",
        "geoname_id": "",
        "names": {
            "de": "",
            "en": "",
            "es": "",
            "fr": "",
            "ja": "",
            "pt-BR": "",
            "ru": "",
            "zh-CN": ""
        }
    },
    "country": {
        "geoname_id": "",
        "is_in_european_union": "",
        "iso_code": "",
        "names": {
            "de": "",
            "en": "",
            "es": "",
            "fr": "",
            "ja": "",
            "pt-BR": "",
            "ru": "",
            "zh-CN": ""
        },
        "confidence": ""
    },
    "maxmind": {
        "queries_remaining": ""
    },
    "registered_country": {
        "geoname_id": "",
        "is_in_european_union": "",
        "iso_code": "",
        "names": {
            "de": "",
            "en": "",
            "es": "",
            "fr": "",
            "ja": "",
            "pt-BR": "",
            "ru": "",
            "zh-CN": ""
        }
    },
    "traits": {
        "ip_address": "",
        "is_anycast": "",
        "network": "",
        "autonomous_system_number": "",
        "autonomous_system_organization": "",
        "connection_type": "",
        "domain": "",
        "isp": "",
        "mobile_country_code": "",
        "mobile_network_code": "",
        "organization": "",
        "is_anonymous": "",
        "is_anonymous_vpn": "",
        "is_hosting_provider": "",
        "is_public_proxy": "",
        "is_residential_proxy": "",
        "is_tor_exit_node": "",
        "static_ip_score": "",
        "user_count": "",
        "user_type": ""
    },
    "city": {
        "confidence": "",
        "geoname_id": "",
        "names": {
            "de": "",
            "en": "",
            "es": "",
            "fr": "",
            "ja": "",
            "pt-BR": "",
            "ru": "",
            "zh-CN": ""
        }
    },
    "location": {
        "accuracy_radius": "",
        "latitude": "",
        "longitude": "",
        "metro_code": "",
        "time_zone": "",
        "average_income": ""
    },
    "postal": {
        "code": "",
        "confidence": ""
    },
    "subdivisions": [
        {
            "geoname_id": "",
            "iso_code": "",
            "names": {
                "de": "",
                "en": "",
                "es": "",
                "fr": "",
                "ja": "",
                "ru": "",
                "zh-CN": ""
            },
            "confidence": ""
        }
    ]
}

operation: Get Country Details of IP

Input parameters

Parameter Description
IP Address Specify the IP address, whose country details to retrieve from MaxMind GeoIP2.

Output

The output contains the following populated JSON schema:

{
    "continent": {
        "code": "",
        "geoname_id": "",
        "names": {
            "de": "",
            "en": "",
            "es": "",
            "fr": "",
            "ja": "",
            "pt-BR": "",
            "ru": "",
            "zh-CN": ""
        }
    },
    "country": {
        "geoname_id": "",
        "is_in_european_union": "",
        "iso_code": "",
        "names": {
            "de": "",
            "en": "",
            "es": "",
            "fr": "",
            "ja": "",
            "pt-BR": "",
            "ru": "",
            "zh-CN": ""
        }
    },
    "maxmind": {
        "queries_remaining": ""
    },
    "registered_country": {
        "geoname_id": "",
        "is_in_european_union": "",
        "iso_code": "",
        "names": {
            "de": "",
            "en": "",
            "es": "",
            "fr": "",
            "ja": "",
            "pt-BR": "",
            "ru": "",
            "zh-CN": ""
        }
    },
    "traits": {
        "ip_address": "",
        "is_anycast": "",
        "network": ""
    }
}

operation: Execute an API Request

Input parameters

Parameter Description
HTTP Method Select an HTTP action for the request. You can select from the following options:
  • DELETE
  • GET
  • PATCH
  • POST
  • PUT
Endpoint Specify the REST API endpoint for the action to perform. For example: city/target-ip-address
Query Parameters (Optional) Specify any optional parameters to add to the URL and refine the request.
Request Payload (Optional) Specify data, as JSON, to be sent as the request payload (typically for POST or PUT requests).

Output

The output contains a non-dictionary value.

Included playbooks

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

Previous
Next