action neutrinoapi_ipprobe {
  label: "IP Probe"
  description: "Execute a realtime network probe against an IPv4 or IPv6 address"
  provider: neutrinoapi
  method: GET
  path: "/ip-probe"
  encoding: json
  input: {
    type: "object"
    properties: {
      ip: {
        type: "string"
      }
    }
    required: ["ip"]
    additionalProperties: false
  }
  output: {
    type: "object"
    required: ["as-age", "as-cidr", "as-country-code", "as-country-code3", "as-description", "as-domains", "asn", "city", "continent-code", "country", "country-code", "country-code3", "currency-code", "host-domain", "hostname", "ip", "is-bogon", "is-hosting", "is-isp", "is-proxy", "is-v4-mapped", "is-v6", "is-vpn", "provider-description", "provider-domain", "provider-type", "provider-website", "region", "region-code", "valid", "vpn-domain"]
    properties: {
      "as-age": {
        type: "integer"
        format: "int32"
        description: "The age of the autonomous system (AS) in number of years since registration"
      }
      "as-cidr": {
        type: "string"
        description: "The autonomous system (AS) CIDR range"
      }
      "as-country-code": {
        type: "string"
        description: "The autonomous system (AS) ISO 2-letter country code"
      }
      "as-country-code3": {
        type: "string"
        description: "The autonomous system (AS) ISO 3-letter country code"
      }
      "as-description": {
        type: "string"
        description: "The autonomous system (AS) description / company name"
      }
      "as-domains": {
        type: "array"
        description: "Array of all the domains associated with the autonomous system (AS)"
        items: {
          type: "string"
        }
      }
      asn: {
        type: "string"
        description: "The autonomous system (AS) number"
      }
      city: {
        type: "string"
        description: "Full city name (if detectable)"
      }
      "continent-code": {
        type: "string"
        description: "ISO 2-letter continent code"
      }
      country: {
        type: "string"
        description: "Full country name"
      }
      "country-code": {
        type: "string"
        description: "ISO 2-letter country code"
      }
      "country-code3": {
        type: "string"
        description: "ISO 3-letter country code"
      }
      "currency-code": {
        type: "string"
        description: "ISO 4217 currency code associated with the country"
      }
      "host-domain": {
        type: "string"
        description: "The IPs host domain"
      }
      hostname: {
        type: "string"
        description: "The IPs full hostname (PTR)"
      }
      ip: {
        type: "string"
        description: "The IP address"
      }
      "is-bogon": {
        type: "boolean"
        description: "True if this is a bogon IP address such as a private network, local network or reserved address"
      }
      "is-hosting": {
        type: "boolean"
        description: "True if this IP belongs to a hosting company. Note that this can still be true even if the provider type is VPN/proxy, this occurs in the case that the IP is detected as both types"
      }
      "is-isp": {
        type: "boolean"
        description: "True if this IP belongs to an internet service provider. Note that this can still be true even if the provider type is VPN/proxy, this occurs in the case that the IP is detected as both types"
      }
      "is-proxy": {
        type: "boolean"
        description: "True if this IP ia a proxy"
      }
      "is-v4-mapped": {
        type: "boolean"
        description: "True if this is a <a href=\"https://en.wikipedia.org/wiki/IPv6#IPv4-mapped_IPv6_addresses\">IPv4 mapped IPv6 address</a>"
      }
      "is-v6": {
        type: "boolean"
        description: "True if this is a IPv6 address. False if IPv4"
      }
      "is-vpn": {
        type: "boolean"
        description: "True if this IP ia a VPN"
      }
      "provider-description": {
        type: "string"
        description: "A description of the provider (usually extracted from the providers website)"
      }
      "provider-domain": {
        type: "string"
        description: "The domain name of the provider"
      }
      "provider-type": {
        type: "string"
        description: "The detected provider type, possible values are: <br> <ul> <li>isp - IP belongs to an internet service provider. This includes both mobile, home and business internet providers</li> <li>hosting - IP belongs to a hosting company. This includes website hosting, cloud computing platforms and colocation facilities</li> <li>vpn - IP belongs to a VPN provider</li> <li>proxy - IP belongs to a proxy service. This includes HTTP/SOCKS proxies and browser based proxies</li> <li>university - IP belongs to a university/college/campus</li> <li>government - IP belongs to a government department. This includes military facilities</li> <li>commercial - IP belongs to a commercial entity such as a corporate headquarters or company office</li> <li>unknown - could not identify the provider type</li> </ul>"
      }
      "provider-website": {
        type: "string"
        description: "The website URL for the provider"
      }
      region: {
        type: "string"
        description: "Full region name (if detectable)"
      }
      "region-code": {
        type: "string"
        description: "ISO 3166-2 region code (if detectable)"
      }
      valid: {
        type: "boolean"
        description: "True if this is a valid IPv4 or IPv6 address"
      }
      "vpn-domain": {
        type: "string"
        description: "The domain of the VPN provider (may be empty if the VPN domain is not detectable)"
      }
    }
  }
}