MaxMind Geo IP2
19 min
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 go 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 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 ip address string required parameter for get city output parameter type description status code number http status code of the response reason string response reason phrase city object output field city geoname id number unique identifier names object name of the resource en string output field en continent object output field continent code string output field code geoname id number unique identifier names object name of the resource ru string output field ru zh cn string output field zh cn de string output field de en string output field en es string output field es fr string output field fr ja string output field ja pt br string output field pt br country object output field country iso code string output field iso code geoname id number unique identifier names object name of the resource en string output field en es string output field es fr string output field fr 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" {}, "continent" {}, "country" {}, "location" {}, "maxmind" {}, "postal" {}, "registered country" {}, "subdivisions" \[], "traits" {} } } ] get country get country endpoint url /geoip/v2 1/country/{{ip address}} method get input argument name type required description ip address string required parameter for get country output parameter type description status code number http status code of the response reason string response reason phrase continent object output field continent code string output field code geoname id number unique identifier names object name of the resource zh cn string output field zh cn de string output field de en string output field en es string output field es fr string output field fr ja string output field ja pt br string output field pt br ru string output field ru country object output field country iso code string output field iso code geoname id number unique identifier names object name of the resource ru string output field ru zh cn string output field zh cn de string output field de en string output field en es string output field es fr string output field fr ja string output field ja example \[ { "status code" 200, "response headers" {}, "reason" "ok", "json body" { "continent" {}, "country" {}, "maxmind" {}, "registered country" {}, "traits" {} } } ] get insights get insights endpoint url /geoip/v2 1/insights/{{ip address}} method get input argument name type required description ip address string required parameter for get insights output parameter type description status code number http status code of the response reason string response reason phrase city object output field city confidence number unique identifier geoname id number unique identifier names object name of the resource en string output field en continent object output field continent code string output field code geoname id number unique identifier names object name of the resource de string output field de en string output field en es string output field es fr string output field fr ja string output field ja pt br string output field pt br ru string output field ru zh cn string output field zh cn country object output field country confidence number unique identifier iso code string output field iso code geoname id number unique identifier names object name of the resource zh cn string output field zh cn 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" {}, "continent" {}, "country" {}, "location" {}, "maxmind" {}, "postal" {}, "registered country" {}, "subdivisions" \[], "traits" {} } } ] 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 1259 content type the media type of the resource application/vnd maxmind com city+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 notes any other notes not fitting other sections go here any reference urls to external docs or other resources