MaxMind Geo IP2

A brief description goes here. Be sure to provide an overview of what the plugin does. Include description of the product being integrated, plus use cases/value prop of the Swimlane integration.

Prerequisites

Prerequisites, everything outside of the plugin itself. This should include info on how to configure the device (API Key, Perms, ect)

Capabilities

This plugin provides the following capabilities:

Capabilities

Here

e.g. Manage Firewall Policies instead of listing each individual tasks

Limitations

Include information about known limitations here, including supported or minimum versions, especially known unsupported versions.

Asset Setup

The content here should discuss asset setup in a conversational manner. Be sure to include any known login and test connection errors.

Tasks Setup

Special task setup as needed depending on plugin, exclude if empty.

Known available allowed input options from enum type selection

Notes

Any other notes not fitting other sections go here.

Any reference URLs to external docs or other resources

Configurations

MaxMind GeoIP2 HTTP Basic Authentication

Authenticates MaxMind GeoIP2 HTTP using username and password.

Configuration Parameters

Parameter	Description	Type	Required
url	A URL to the target host.	string	Required
username	MaxMind Account ID	string	Required
password	MaxMind License Key	string	Required
verify_ssl	Verify SSL certificate	boolean	Optional
http_proxy	A proxy to route requests through.	string	Optional

Actions

Get City

Get City Plus.

Endpoint

URL: /geoip/v2.1/city/{{ip_address}}

Method: GET

Input

Argument Name	Type	Required	Description
path_parameters.ip_address	string	Required	Parameters for the Get City action

Input Example

{"path_parameters":{"ip_address":"me"}}

Output

Parameter	Type	Description
status_code	number	HTTP status code of the response
reason	string	Response reason phrase
city	object	Output field: city
city.geoname_id	number	Unique identifier
city.names	object	Name of the resource
city.names.en	string	Name of the resource
continent	object	Output field: continent
continent.code	string	Output field: continent.code
continent.geoname_id	number	Unique identifier
continent.names	object	Name of the resource
continent.names.ru	string	Name of the resource
continent.names.zh-CN	string	Name of the resource
continent.names.de	string	Name of the resource
continent.names.en	string	Name of the resource
continent.names.es	string	Name of the resource
continent.names.fr	string	Name of the resource
continent.names.ja	string	Name of the resource
continent.names.pt-BR	string	Name of the resource
country	object	Output field: country
country.iso_code	string	Output field: country.iso_code
country.geoname_id	number	Unique identifier
country.names	object	Name of the resource
country.names.en	string	Name of the resource
country.names.es	string	Name of the resource
country.names.fr	string	Name of the resource

Output Example

{"status_code":200,"response_headers":{"Date":"Tue, 05 Mar 2024 16:07:16 GMT","Content-Type":"application/vnd.maxmind.com-city+json; charset=UTF-8; version=2.1","Content-Length":"1259","Connection":"keep-alive","CF-Cache-Status":"DYNAMIC","Server":"cloudflare","CF-RAY":"85fb5ba79bbb9a77-NAG"},"reason":"OK","json_body":{"city":{"geoname_id":1257345,"names":{}},"continent":{"code":"AS","geoname_id":6255147,"names":{}},"country":{"iso_code":"IN","geoname_id":1269750,"names":{}},"location":{"accurac...

Get Country

Get Country.

Endpoint

URL: /geoip/v2.1/country/{{ip_address}}

Method: GET

Input

Argument Name	Type	Required	Description
path_parameters.ip_address	string	Required	Parameters for the Get Country action

Input Example

{"path_parameters":{"ip_address":"me"}}

Output

Parameter	Type	Description
status_code	number	HTTP status code of the response
reason	string	Response reason phrase
continent	object	Output field: continent
continent.code	string	Output field: continent.code
continent.geoname_id	number	Unique identifier
continent.names	object	Name of the resource
continent.names.zh-CN	string	Name of the resource
continent.names.de	string	Name of the resource
continent.names.en	string	Name of the resource
continent.names.es	string	Name of the resource
continent.names.fr	string	Name of the resource
continent.names.ja	string	Name of the resource
continent.names.pt-BR	string	Name of the resource
continent.names.ru	string	Name of the resource
country	object	Output field: country
country.iso_code	string	Output field: country.iso_code
country.geoname_id	number	Unique identifier
country.names	object	Name of the resource
country.names.ru	string	Name of the resource
country.names.zh-CN	string	Name of the resource
country.names.de	string	Name of the resource
country.names.en	string	Name of the resource
country.names.es	string	Name of the resource
country.names.fr	string	Name of the resource
country.names.ja	string	Name of the resource

Output Example

{"status_code":200,"response_headers":{},"reason":"OK","json_body":{"continent":{"code":"AS","geoname_id":6255147,"names":{}},"country":{"iso_code":"IN","geoname_id":1269750,"names":{}},"maxmind":{"queries_remaining":49998},"registered_country":{"iso_code":"US","geoname_id":6252001,"names":{}},"traits":{"ip_address":"8.29.228.38","network":"8.29.228.38/32"}}}

Get Insights

Get Insights.

Endpoint

URL: /geoip/v2.1/insights/{{ip_address}}

Method: GET

Input

Argument Name	Type	Required	Description
path_parameters.ip_address	string	Required	Parameters for the Get Insights action

Input Example

{"path_parameters":{"ip_address":"me"}}

Output

Parameter	Type	Description
status_code	number	HTTP status code of the response
reason	string	Response reason phrase
city	object	Output field: city
city.confidence	number	Unique identifier
city.geoname_id	number	Unique identifier
city.names	object	Name of the resource
city.names.en	string	Name of the resource
continent	object	Output field: continent
continent.code	string	Output field: continent.code
continent.geoname_id	number	Unique identifier
continent.names	object	Name of the resource
continent.names.de	string	Name of the resource
continent.names.en	string	Name of the resource
continent.names.es	string	Name of the resource
continent.names.fr	string	Name of the resource
continent.names.ja	string	Name of the resource
continent.names.pt-BR	string	Name of the resource
continent.names.ru	string	Name of the resource
continent.names.zh-CN	string	Name of the resource
country	object	Output field: country
country.confidence	number	Unique identifier
country.iso_code	string	Output field: country.iso_code
country.geoname_id	number	Unique identifier
country.names	object	Name of the resource
country.names.zh-CN	string	Name of the resource

Output Example

{"status_code":200,"response_headers":{"Date":"Tue, 05 Mar 2024 16:09:53 GMT","Content-Type":"application/vnd.maxmind.com-insights+json; charset=UTF-8; version=2.1","Content-Length":"1409","Connection":"keep-alive","CF-Cache-Status":"DYNAMIC","Server":"cloudflare","CF-RAY":"85fb5f7fcac09a77-NAG"},"reason":"OK","json_body":{"city":{"confidence":10,"geoname_id":1257345,"names":{}},"continent":{"code":"AS","geoname_id":6255147,"names":{}},"country":{"confidence":99,"iso_code":"IN","geoname_id":1269...

Response Headers

Header	Description	Example
CF-Cache-Status	HTTP response header: CF-Cache-Status	DYNAMIC
CF-RAY	HTTP response header: CF-RAY	85fb5f7fcac09a77-NAG
Connection	HTTP response header: Connection	keep-alive
Content-Length	The length of the response body in bytes	1409
Content-Type	The media type of the resource	application/vnd.maxmind.com-insights+json; charset=UTF-8; version=2.1
Date	The date and time at which the message was originated	Tue, 05 Mar 2024 16:07:16 GMT
Server	Information about the software used by the origin server	cloudflare