Skip to main content

IP-API

This Integration is part of the IP-API Pack.#

Supported versions

Supported Cortex XSOAR versions: 6.0.0 and later.

This integration will enrich IP addresses from IP-API with data about the geolocation, as well as a determination of the IP address being associated with a mobile device, hosting or proxy. Revers DNS is also returned.

This service is available for free (with a throttle) - or paid.

This integration was integrated and tested with IP-API

Configure IP-API on Cortex XSOAR#

  1. Navigate to Settings > Integrations > Servers & Services.

  2. Search for IP-API.

  3. Click Add instance to create and configure a new integration instance.

    ParameterDescriptionRequired
    Use HTTPS to communicate with the APIUse of HTTPS requires an API keyFalse
    API KeyOnly required to bypass rate limits and/or use HTTPSFalse
    Fields to returnSee https://members.ip-api.com/docs/json for detailsTrue
    Use system proxy settingsFalse
    Trust any certificate (not secure)False
  4. Click Test to validate the URLs, token, and connection.

Commands#

You can execute these commands from the Cortex XSOAR CLI, as part of an automation, or in a playbook. After you successfully execute a command, a DBot message appears in the War Room with the command details.

ip#


Return IP information

Base Command#

ip

Input#

Argument NameDescriptionRequired
ipList of IPs.Optional

Context Output#

PathTypeDescription
IP-API.continentCodestringcontinentCode
IP-API.zipstringzip
IP-API.mobilebooleanmobile
IP-API.reversestringreverse
IP-API.countryCodestringcountryCode
IP-API.orgstringorg
IP-API.ispstringisp
IP-API.currentTimestringcurrentTime
IP-API.querystringquery
IP-API.citystringcity
IP-API.lonnumberlon
IP-API.proxybooleanproxy
IP-API.districtstringdistrict
IP-API.countryCode3stringcountryCode3
IP-API.currencystringcurrency
IP-API.callingCodenumbercallingCode
IP-API.asstringas
IP-API.statusstringstatus
IP-API.offsetstringoffset
IP-API.continentstringcontinent
IP-API.regionstringregion
IP-API.countrystringcountry
IP-API.timezonestringtimezone
IP-API.hostingbooleanhosting
IP-API.asnamestringasname
IP-API.latnumberlat
IP-API.regionNamestringregionName

Command Example#

!ip ip=8.8.8.8

Human Readable Output#