Guides

MaxMind: Playbook

MaxMind

Release Notes

1.0.3 (2024-04-17)

  • APP-4456 - added PY3.11 support and upgraded to TcEx 4

1.0.2 (2022-07-13)

  • APP-3612 - added PY3.9 support and patched package vulnerabilities

1.0.1 (2021-07-16)

  • Update App category

1.0.0 (2020-12-11)

  • APP-948 Initial Release

Category

  • Data Enrichment

Description

This app is a set of actions to interact with the MaxMind GeoIP2 service. For full details on using MaxMind GeoIP2 please see https://www.maxmind.com/en/geoip2-services-and-databases

The following actions are included:

  • Get GeoIP Info - Action to retrieve GeoIP2 info for a specified Address.

  • Advanced Request - Users may access the full MaxMind API.

Actions

Get GeoIP Info

Action to retrieve GeoIP2 info for a specified Address.

Inputs

Connection

Account ID (TypeEnum.String)

MaxMind account ID.

License Key (TypeEnum.String)

MaxMind license key.

Configure

IP to Submit (TypeEnum.String)

The IP to submit to MaxMind.

Allows: String, TCEntity

Service (Choice, Default: Country)

Different information is returned based on the MaxMind service selected.

Valid Values: Country, City, Insights

Outputs

  • maxmind.action (String)
  • maxmind.response.json.raw (String)

Advanced Request

Users may access the full MaxMind API.

Inputs

Connection

Account ID (TypeEnum.String)

MaxMind account ID.

License Key (TypeEnum.String)

MaxMind license key.

Configure

API Endpoint/Path (String)

The API Path request.

HTTP Method (Choice, Default: GET)

HTTP method to use.

Valid Values: GET, POST, DELETE, PUT, HEAD, PATCH, OPTIONS

Query Parameters (KeyValueList, Optional)

Query parameters to append to the URL. For sensitive information like API keys, using variables is recommended to ensure that the Playbook will not export sensitive data.

Allows: String, StringArray

Exclude Empty/Null Parameters (Boolean)

Some API endpoint don't handle null/empty query parameters properly (e.g., ?name=&type=String). If selected this options will exclude any query parameters that has a null/empty value.

Headers (KeyValueList, Optional)

Headers to include in the request. When using Multi-part Form/File data, do not add a Content-Type header. For sensitive information like API keys, using variables is recommended to ensure that the Playbook will not export sensitive data.

Body (String, Optional)

Content of the HTTP request.

Allows: String, Binary

URL Encode JSON Body (Boolean)

URL encode a JSON-formatted body. Typically used for 'x-www-form-urlencoded' data, where the data can be configured in the body as a JSON string.

Fail for Status (Boolean, Default: Selected)

Fail if the response status code is 4XX - 5XX.

Outputs

  • maxmind.action (String)
  • maxmind.request.content (String)
  • maxmind.request.content.binary (Binary)
  • maxmind.request.headers (String)
  • maxmind.request.ok (String)
  • maxmind.request.reason (String)
  • maxmind.request.status_code (String)
  • maxmind.request.url (String)

Labels

  • address, enrichment, ip

Updated 12 months ago