--- title: "GNQL V3 Query" method: GET path: "/v3/gnql" tags: ["GNQL"] --- # GNQL V3 Query `GET /v3/gnql` GreyNoise Query Language GNQL (GreyNoise Query Language) is a domain-specific query language that uses Lucene deep under the hood. GNQL aims to enable GreyNoise Enterprise and Research users to make complex and one-off queries against the GreyNoise dataset as new business cases arise. GNQL is built with self-defeat and fully featured product lines in mind. If we do our job correctly, each individual GNQL query that brings our users and customers sufficient value will eventually be transitioned into it's own individual offering. _License: The `business_service_intelligence` response field requires the BSI Module. Without it, every result returns an empty `business_service_intelligence` object; all other fields are returned normally._ Facets: * `ip` - The IP address of the scanning device IP * `classification` - Whether the device has been categorized as unknown, benign, or malicious * `first_seen` - The date the device was first observed by GreyNoise * `last_seen` - The date the device was most recently observed by GreyNoise * `actor` - The benign actor the device has been associated with, such as Shodan, Censys, GoogleBot, etc * `tags` - A list of the tags the device has been assigned over the past 90 days * `spoofable` - This IP address has been opportunistically scanning the Internet, however has failed to complete a full TCP connection. Any reported activity could be spoofed. * `vpn` - This IP is associated with a VPN service. Activity, malicious or otherwise, should not be attributed to the VPN service provider. * `vpn_service` - The VPN service the IP is associated with * `tor` - Whether or not the device is a known Tor exit node * `cve` - A list of CVEs that the device has been associated with * `single_destination` - A boolean parameter that filters source country IPs that have only been observed in a single destination country * `metadata.category` - Whether the device belongs to a business, isp, hosting, education, or mobile network * `metadata.carrier` - The Internet Service Provider (ISP) or telecommunications carrier associated with the source IP address * `metadata.country` - The full name of the country the device is geographically located in (This is the same data as `metadata.source_country`. `metadata.source_country` is preferred) * `metadata.country_code` - The two-character country code of the country the device is geographically located in (This is the same data as `metadata.source_country_code`. `metadata.source_country_code` is preferred) * `metadata.datacenter` - The datacenter or hosting provider from which the activity originates. This could indicate the use of cloud services, managed hosting, or enterprise datacenter infrastructure. * `metadata.domain` - The domain name associated with the source IP address * `metadata.sensor_hits` - The amount of unique data that has been recorded by the sensor * `metadata.sensor_count` - The number of sensors the IP Address has been observed on * `metadata.city` - The city the device is geographically located in * `metadata.region` - The region the device is geographically located in * `metadata.organization` - The organization that owns the network that the IP address belongs to * `metadata.rdns` - The reverse DNS pointer of the IP * `metadata.asn` - The autonomous system the IP address belongs to * `metadata.asn_subnet` - Exact match on the latest-observed ASN subnet for the IP in GreyNoise scan data * `metadata.destination_cities` - The city where the GreyNoise sensor is geographically located * `metadata.destination_asns` - The ASN associated with the destination IP address * `metadata.destination_countries` - The full country name where the GreyNoise sensors are physically located * `metadata.destination_country_codes` - The country code where the GreyNoise sensors are physically located * `metadata.destination_country` - The full country name where the GreyNoise sensors are physically located * `metadata.destination_country_code` - The country code where the GreyNoise sensors are physically located * `metadata.latitude` - The geographic latitude of the source IP address * `metadata.longitude` - The geographic longitude of the source IP address * `metadata.rdns_parent` - The parent domain retrieved through reverse DNS (RDNS) lookup of the source IP address * `metadata.rdns_validated` - A validation status that confirms whether the reverse DNS (RDNS) record correctly maps to the source domain * `metadata.source_country_code` - The two-character country code of the country the device is geographically located in * `metadata.source_country` - The full name of the country the device is geographically located in * `raw_data.scan.port` - The port being targeted on a GreyNoise sensor * `raw_data.scan.protocol` - The protocol of the port the device has been observed scanning * `raw_data.web.paths` - Any HTTP paths the device has been observed crawling the Internet for * `raw_data.web.useragents` - Any HTTP user-agents the device has been observed using while crawling the Internet * `raw_data.ja3.fingerprint` - The JA3 TLS/SSL fingerprint * `raw_data.ja3.port` - The corresponding TCP port for the given JA3 fingerprint * `raw_data.hassh.fingerprint` - The HASSH fingerprint * `raw_data.hassh.port` - The corresponding TCP port for the given HASSH fingerprint * `raw_data.http.md5` - An MD5 hash of the body content. This compact, unique representation of the data allows for quick comparisons and deduplication of payloads without storing the raw content. * `raw_data.http.cookie_keys` - The keys or names of cookies exchanged in the communication. These can reveal session identifiers, tracking mechanisms, or other metadata used in web interactions, providing clues about application behavior or vulnerabilities. * `raw_data.http.request_authorization` - The contents of the Authorization header in a request, typically containing authentication credentials or tokens (e.g., Basic Auth, Bearer tokens). Analyzing this helps verify authorization mechanisms and detect credential misuse or token abuse. * `raw_data.http.request_cookie` - Key-value pairs stored in cookies sent with an HTTP request. These cookies often contain session identifiers, user preferences, or tracking data, which can be analyzed to detect unauthorized access or manipulation. * `raw_data.http.request_header` - Request Headers are the keys (names) of HTTP headers that a client sends to a server. * `raw_data.http.request_method` - The HTTP method used in the request, such as GET, POST, PUT, or DELETE. Analyzing methods can reveal the intent of the request, such as retrieving or modifying resources, and identify unexpected or suspicious activity. * `raw_data.http.request_origin` - Indicates the origin of the request, typically used in cross-origin resource sharing (CORS) to specify where the request originated. This helps identify unauthorized or potentially malicious cross-origin requests. * `raw_data.tls.cipher` - The encryption algorithm or cipher suite used during the secure communication. Identifying the cipher helps assess the security of the connection, particularly in TLS/SSL traffic. * `raw_data.tls.ja4` - JA4 TLS fingerprint. JA4 captures distinctive characteristics of TLS client behavior, useful for identifying and clustering malicious or anomalous clients. * `raw_data.http.ja4h` - JA4H HTTP client fingerprint. Captures characteristics of HTTP client behavior including method, headers, and cookie fields, useful for identifying and tracking HTTP clients. * `raw_data.ssh.ja4ssh` - JA4SSH fingerprint. Captures SSH traffic patterns including packet lengths and directions, useful for identifying SSH client behavior and detecting anomalous sessions. * `raw_data.tcp.ja4t` - JA4T TCP fingerprint. Captures TCP connection characteristics such as window size, options, and MSS, useful for OS fingerprinting and identifying network stacks. * `raw_data.tcp.ja4l` - JA4L light distance/latency fingerprint. Captures TCP TTL and window size characteristics, useful for estimating client-server distance and identifying proxied connections. Behavior: * `raw_data.ssh.key` - This is the SSH key used. * You can subtract facets by prefacing the query with a minus character * The data that this endpoint queries refreshes once per hour Shortcuts: * You can find interesting hosts by using the GNQL query term `interesting` * You can use the keyword `today` in the `first_seen` and `last_seen` parameters: `last_seen:today` or `first_seen:today` Examples: * `last_seen:today` - Returns all IPs scanning/crawling the Internet today * `tags:Mirai` - Returns all devices with the "Mirai" tag * `tags:"RDP Scanner"` - Returns all devices with the "RDP Scanner" tag * `classification:malicious metadata.country:Belgium` - Returns all compromised devices located in Belgium * `classification:malicious metadata.rdns:*.gov*` - Returns all compromised devices that include .gov in their reverse DNS records * `metadata.organization:Microsoft classification:malicious` - Returns all compromised devices that belong to Microsoft * `(raw_data.scan.port:445 and raw_data.scan.protocol:TCP) metadata.os:Windows*` - Return all devices scanning the Internet for port 445/TCP running Windows operating systems (Conficker/EternalBlue/WannaCry) * `raw_data.scan.port:554` - Returns all devices scanning the Internet for port 554 * `-metadata.organization:Google raw_data.web.useragents:GoogleBot` - Returns all devices crawling the Internet with "GoogleBot" in their useragent from a network that does NOT belong to Google * `tags:"Siemens PLC Scanner" -classification:benign` - Returns all devices scanning the Internet for SCADA devices who ARE NOT tagged by GreyNoise as "benign" (Shodan/Project Sonar/Censys/Google/Bing/etc) * `classification:benign` - Returns all "good guys" scanning the Internet * `raw_data.ja3.fingerprint:795bc7ce13f60d61e9ac03611dd36d90` - Returns all devices crawling the Internet with a matching client JA3 TLS/SSL fingerprint * `raw_data.hassh.fingerprint:51cba57125523ce4b9db67714a90bf6e` - Returns all devices crawling the Internet with a matching client HASSH fingerprint * `raw_data.tls.ja4:t13d1516h2_8daaf6152771_02713d6af862` - Returns all devices with a matching JA4 TLS fingerprint * `raw_data.http.ja4h:ge11cn060000_4e59edc1297a_4da5efaf0cbd` - Returns all devices with a matching JA4H HTTP fingerprint * `raw_data.ssh.ja4ssh:c76s76_c71s59_c0s0` - Returns all devices with a matching JA4SSH fingerprint * `raw_data.tcp.ja4t:64240_2-1-3-1-1-4_1460_8` - Returns all devices with a matching JA4T TCP fingerprint * `raw_data.tcp.ja4l:1460_64` - Returns all devices with a matching JA4L light distance/latency fingerprint * `raw_data.web.paths:"/HNAP1/"` -Returns all devices crawling the Internet for the HTTP path "/HNAP1/" * `8.0.0.0/8` - Returns all devices scanning the Internet from the CIDR block 8.0.0.0/8 * `cve:CVE-2021-30461` - Returns all devices associated with the supplied CVE * `source_country:Iran` - Returns all results originating from Iran * `destination_country:Ukraine single_destination:true` - Returns all results scanning in only Ukraine ## Query parameters - `query` string, required - `size` integer - `scroll` string - `quick` boolean - `format` 'csv' | 'json' - `exclude` string ## Response `200` OK - request successful. - union - GNQLV3Response - `request_metadata` GNQLV3ResponseMetadata - `complete` boolean — Whether all records have been delivered or not. `false` means there's another page - `scroll` string — Scroll token to use for pagination - `query` string — The GNQL query string the requester queried - `adjusted_query` string — When certain query parameters are not specified or incompatible with your current plan, GreyNoise automatically adjusts params on your query prior to execution. - `count` integer — The number of total results for the given GNQL query - `message` string — A status message indicating if there were issues with the request - `restricted_fields` string[] — The fields that were restricted due to plan limitations - `data` GNQLIPContextV3[] — The relevant IP records requested by the user - `ip` string — IP address that the information is about. - `internet_scanner_intelligence` InternetScannerIntelligence - `ip` string — IP address that the information is about. - `seen` boolean — Whether or not the IP address has been observed by the GreyNoise sensor network. - `classification` 'benign' | 'malicious' | 'unknown' — The classification of the IP address, either "benign", "malicious", or "unknown", based on the activity observed by GreyNoise. - `first_seen` string, date — The earliest date GreyNoise observed any activity from this IP. - `last_seen` string, date — The most recent date GreyNoise observed any activity from this IP. - `last_seen_timestamp` string, date-time — The timestamp of the last observed activity from this IP. - `found` boolean — Indicates if the IP was observed scanning the GreyNoise sensor network. Also referred to as 'noise'. - `actor` string — The overt actor this IP is associated with. - `spoofable` boolean — This IP address has been opportunistically scanning the Internet, however has failed to complete a full TCP connection. Any reported activity could be spoofed. - `cves` string[] — A list of CVEs associate with this IP. - `tor` boolean — Whether or not the device is a known Tor exit node. - `vpn` boolean — This IP is associated with a VPN service. Activity, malicious or otherwise, should not be attributed to the VPN service provider. - `vpn_service` string — Name of associated VPN Service. - `metadata` MetadataV3 - `mobile` boolean — Defines if the IP is part of a known cellular network. - `source_country` string — Country where the IP address is registered or operates. - `source_country_code` string — Country code of the IP address based on ISO 3166-1 alpha-2. - `source_city` string — The city where the device is geographically located. - `region` string — The region where the device is geographically located. - `organization` string — The name of organization that owns the IP address. - `rdns` string — The reverse DNS pointer. - `asn` string — The autonomous system identification number. - `asn_subnet` string — The latest-observed ASN subnet for the IP in GreyNoise scan data, not authoritative current BGP state. - `category` 'isp' | 'business' | 'hosting' | 'mobile' | 'education' — The subset of network types the IP address belongs to. - `os` string — An approximate guess of the operating system of the device, based on the TCP stack fingerprint. - `destination_countries` string[] - `destination_country_codes` string[] - `destination_cities` string[] - `destination_asns` string[] - `single_destination` boolean — A Boolean parameter indicating whether the source IP address has only been observed in a single destination country. - `carrier` string — The Internet Service Provider (ISP) or telecommunications carrier associated with the source IP address. - `datacenter` string — The datacenter or hosting provider from which the activity originates. This could indicate the use of cloud services, managed hosting, or enterprise datacenter infrastructure. - `domain` string — The domain name associated with the source IP address. - `rdns_parent` string — The parent domain retrieved through reverse DNS (RDNS) lookup of the source IP address. - `rdns_validated` boolean — A validation status that confirms whether the reverse DNS (RDNS) record correctly maps to the source domain. - `latitude` number — The geographic latitude of the source IP address. - `longitude` number — The geographic longitude of the source IP address. - `sensor_count` integer — Number of sensors with events observed. - `sensor_hits` integer — Number of scanning events observed. - `tags` IPResponseV3Tags - `id` string — The unique identifier for the tag. - `slug` string — The slugified version of the tag name. - `name` string — The human-readable name for the tag. - `category` string — Category of the IP address such as hosting or ISP. - `intention` string — The intent of the tag, either suspicious, malicious, benign, or unknown. - `description` string — A detailed description of the tag, including the observed activity and any relevant context or details. - `references` string[] - `recommend_block` boolean — A boolean value indicating whether the tag should be recommended for blocking or filtering purposes. - `cves` string[] - `created_at` string — The date and time when the tag was created. - `updated_at` string — The date and time when the tag was last updated. - `raw_data` object — Raw data observed directly by GreyNoise. - `scan` object[] - `port` integer — Port number - `protocol` string — Protocol - `ja3` object[] - `fingerprint` string — JA3 hash fingerprint string - `port` integer — TCP port connection that the SSL/TLS communication occurred over - `hassh` object[] - `fingerprint` string — HASSH hash fingerprint string - `port` integer — TCP port connection where the HASSH hash was identified - `http` object - `md5` string — An MD5 hash of the body content. This compact, unique representation of the data allows for quick comparisons and deduplication of payloads without storing the raw content. - `cookie_keys` string[] — The keys or names of cookies exchanged in the communication. These can reveal session identifiers, tracking mechanisms, or other metadata used in web interactions, providing clues about application behavior or vulnerabilities. - `request_authorization` string[] — The contents of the Authorization header in a request, which can include credentials, tokens, or other authentication information. - `request_cookies` string[] — Key-value pairs stored in cookies sent with an HTTP request. These cookies often contain session identifiers, user preferences, or tracking data, which can be analyzed to detect unauthorized access or manipulation. - `request_header` string[] — Request Headers are the keys (names) of HTTP headers that a client sends to a server. - `method` string[] — The HTTP method used in the request, such as GET, POST, PUT, or DELETE. Analyzing methods can reveal the intent of the request, such as retrieving or modifying resources, and identify unexpected or suspicious activity. - `request_origin` string[] — Indicates the origin of the request, typically used in cross-origin resource sharing (CORS) to specify where the request originated. This helps identify unauthorized or potentially malicious cross-origin requests. - `host` string[] — The host of the request, which can include the domain name and port number. These values can provide insight into the services or endpoints the actor may have been attempting to interact with. - `uri` string[] - `path` string[] - `useragent` string[] - `ja4h` string[] - `tls` object - `cipher` string — The encryption algorithm or cipher suite used during the secure communication. Identifying the cipher helps assess the security of the connection, particularly in TLS/SSL traffic. - `ja4` string[] - `ssh` object - `key` string[] — This is the SSH key used. - `ja4ssh` string[] - `tcp` object - `ja4t` string[] - `ja4l` string — JA4L light distance/latency fingerprint observed in network traffic from the IP. Captures TCP TTL and window size characteristics, useful for estimating client-server distance and identifying proxied connections. - `source` object - `bytes` integer — The total amount of data transferred (in bytes) during the observed session or connection. - `business_service_intelligence` BusinessServiceIntelligence - `found` boolean — Indicates if an IP is part of the RIOT dataset or not. - `category` string — RIOT category the provider belongs to, identifying the type of service provided. - `name` string — The name of the provider and/or service. - `description` string — A description of the provider and what they do. - `explanation` string — An explanation of the category type and what may be expected from this provider and category. - `last_updated` string — Date and time when this record was last updated from its source (format: YYYY-MM-DDTHH:MM:SSZ). - `reference` string — Reference URL for information about this provider and/or service. - `trust_level` string — Trust level assigned to this IP/provider. One of: - "1" — high trust; broadly used legitimate provider where end-user attribution is high. - "2" — moderate trust; common business service infrastructure where end-user attribution is limited. - "3" — label only; cloud compute or bulk hosting provider with no inherent trust signal. - QuickGNQLV3Response - `request_metadata` GNQLV3ResponseMetadata - `complete` boolean — Whether all records have been delivered or not. `false` means there's another page - `scroll` string — Scroll token to use for pagination - `query` string — The GNQL query string the requester queried - `adjusted_query` string — When certain query parameters are not specified or incompatible with your current plan, GreyNoise automatically adjusts params on your query prior to execution. - `count` integer — The number of total results for the given GNQL query - `message` string — A status message indicating if there were issues with the request - `restricted_fields` string[] — The fields that were restricted due to plan limitations - `data` QuickIpProfile[] — The relevant IP records requested by the user - `ip` string — IP address that the information is about. - `business_service_intelligence` QuickBusinessServiceIntelligence - `found` boolean — Indicates if an IP is part of the RIOT dataset or not. - `trust_level` string — Trust level assigned to this IP/provider. One of: - "1" — high trust; broadly used legitimate provider where end-user attribution is high. - "2" — moderate trust; common business service infrastructure where end-user attribution is limited. - "3" — label only; cloud compute or bulk hosting provider with no inherent trust signal. - `internet_scanner_intelligence` QuickInternetScannerIntelligence - `found` boolean — Indicates if the IP was observed scanning the GreyNoise sensor network. Also referred to as 'noise'. - `classification` 'benign' | 'malicious' | 'unknown' — The classification of the IP address, either "benign", "malicious", or "unknown", based on the activity observed by GreyNoise. ## Other responses - `206` — Partial content - request partially successful. Due to plan limitations, your request only returned a subset of fields and/or data. Contact sales@greynoise.io to upgrade your plan and unlock full results. - `400` — Bad request - request syntax is invalid for the specified endpoint. Verify request syntax and try again. - `401` — Unauthorized. Please check your API key. - `403` — Forbidden - request is not authorized due to an invalid API key or plan limitations. If due to plan limitations, contact sales@greynoise.io to upgrade your plan and unlock full results. - `429` — Too many requests. You've hit the rate-limit. --- [API](https://skmtc.dev/greynoise/apis/greynoise-api.md) · [All operations](https://skmtc.dev/greynoise/apis/greynoise-api/llms.txt) · [OpenAPI document](https://skmtc-service-production.skmtc.workers.dev/v1/apis/greynoise/greynoise-api/revisions/30942574656d/schema)