Iris Investigate

Returns data from a POST request.

The GET method is available for simple queries.

The POST method supports two request formats:

  • Form parameters (application/x-www-form-urlencoded): Traditional parameter-based searches
  • IrisQL (text/plain): Complex queries using IrisQL query language for advanced filtering and OR logic

For IrisQL usage and syntax, see the IrisQL API Guide.

post/v1/iris-investigate/

Request

Request body application/x-www-form-urlencoded

adsensestring

A short identifier, code, or handle.

baidu_analyticsstring

A short identifier, code, or handle.

contact_namestring

A generic and unconstrained string value.

contact_phonestring

A generic and unconstrained string value.

contact_streetstring

A generic and unconstrained string value.

ipstring ipv4

A standard IPv4 address.

domainstring

A comma-separated list of one or more apex domains to investigate.

emailstring email

A valid email address, as defined by RFC 5322 and commonly used in WHOIS, SSL certificates, RDAP records, or domain registration contacts.

email_dns_soastring email

A valid email address, as defined by RFC 5322 and commonly used in WHOIS, SSL certificates, RDAP records, or domain registration contacts.

email_domainstring

A base (apex) domain like example.com, excluding subdomains.

historical_free_textstring

A generic and unconstrained string value.

facebookstring

A short identifier, code, or handle.

ga4string

A short identifier, code, or handle.

google_analyticsstring

A short identifier, code, or handle.

google_tag_managerstring

A short identifier, code, or handle.

hotjarstring

A short identifier, code, or handle.

iana_idstring

A short identifier, code, or handle.

mailserver_domainstring

A base (apex) domain like example.com, excluding subdomains.

mailserver_hoststring hostname

A Fully Qualified Domain Name (FQDN), including subdomains (e.g., www.example.com). Must be a valid DNS hostname per RFC 1123, excluding trailing dot.

mailserver_ipstring ipv4

A standard IPv4 address.

matomostring

A short identifier, code, or handle.

nameserver_domainstring hostname

A valid, fully-qualified domain name (FQDN).

nameserver_hoststring hostname

A valid, fully-qualified domain name (FQDN).

nameserver_ipstring ipv4

A standard IPv4 address.

redirect_domainstring

A generic and unconstrained string value.

registrantstring

A human-readable organization name as used in WHOIS or RDAP records, such as a registrar, registrant, or sponsoring organization. Supports Unicode letters and numbers, along with common punctuation.

historical_registrantstring

A human-readable organization name as used in WHOIS or RDAP records, such as a registrar, registrant, or sponsoring organization. Supports Unicode letters and numbers, along with common punctuation.

registrant_orgstring

A human-readable organization name as used in WHOIS or RDAP records, such as a registrar, registrant, or sponsoring organization. Supports Unicode letters and numbers, along with common punctuation.

registrarstring

A human-readable organization name as used in WHOIS or RDAP records, such as a registrar, registrant, or sponsoring organization. Supports Unicode letters and numbers, along with common punctuation.

search_hashstring

Opaque token representing a saved search from the Iris Investigate UI. Exported via “Search → Export” in the Iris UI. Example: aGVsbG93b3yY2hfaGFzaF9jb2RlJsZF9zZWFcw==

server_typestring

A non-empty string with a standard length limit.

ssl_alt_namesstring

A generic and unconstrained string value.

ssl_common_namestring

A generic and unconstrained string value.

ssl_durationinteger
ssl_emailstring email

A valid email address, as defined by RFC 5322 and commonly used in WHOIS, SSL certificates, RDAP records, or domain registration contacts.

ssl_hashstring

A 40-character hexadecimal SHA-1 hash string, typically used to identify SSL certificates or digital signatures.

ssl_orgstring

A human-readable organization name as used in WHOIS or RDAP records, such as a registrar, registrant, or sponsoring organization. Supports Unicode letters and numbers, along with common punctuation.

ssl_subjectstring

A distinguished name (DN) string representing the Subject field of an SSL certificate. Typically includes components like CN, O, C, ST, and L in a comma-separated format. Example: C=US, ST=California, L=San Francisco, O=Example Corp, CN=example.com

ssl_issuer_common_namestring

A generic and unconstrained string value.

statcounter_projectstring

A short identifier, code, or handle.

statcounter_securitystring

A short identifier, code, or handle.

tagged_with_allstring

A generic and unconstrained string value.

tagged_with_anystring

A generic and unconstrained string value.

website_titlestring

The exact value of the <title> tag from a website's HTML.

whoisstring

A generic and unconstrained string value.

yandex_metricastring

A short identifier, code, or handle.

activeboolean
create_datestring

A date in YYYY-MM-DD format, optionally prefixed with an operator (>, >=, <, <=) for comparison. Example: <=2025-01-01

create_date_withininteger

A positive integer representing the maximum number of days.

expiration_datestring date

A calendar date in the format YYYY-MM-DD, per RFC 3339 (full-date). Does not include a time or timezone.

first_seen_withininteger

A positive integer representing a time window, in seconds. Used to filter results based on how recently an event occurred.

ip_country_codestring
rankinteger
risk_scoreinteger
ssl_not_afterstring date

A calendar date in the format YYYY-MM-DD, per RFC 3339 (full-date). Does not include a time or timezone.

ssl_not_beforestring date

A calendar date in the format YYYY-MM-DD, per RFC 3339 (full-date). Does not include a time or timezone.

not_tagged_with_allstring

A comma-separated list of tag names. Tags are matched exactly and compared case-insensitively unless otherwise specified.

not_tagged_with_anystring

A comma-separated list of tag names. Tags are matched exactly and compared case-insensitively unless otherwise specified.

tldstring

A top-level or public suffix domain, such as com, org, or co.uk. Must not include a leading dot.

parsed_domain_rdapboolean

An optional boolean flag that enables a specific feature or response extension when set to true. If false or omitted, the feature is ignored.

parsed_whoisboolean

An optional boolean flag that enables a specific feature or response extension when set to true. If false or omitted, the feature is ignored.

nextboolean

An optional boolean flag that enables a specific feature or response extension when set to true. If false or omitted, the feature is ignored.

format'html' | 'json' | 'xml'

The desired response format.

page_sizeinteger
positionstring

An opaque string token used for cursor-based pagination. Returned in the position field of a paginated response when has_more_results is true, and used as a query parameter to retrieve the next result set. Example: 2c056abadfb64b67ba18896af2c5b900

sort_by'first_seen_since' | 'create_date' | 'domain' | 'risk_score'
sort_direction'asc' | 'dsc'
app_namestring

A short identifier, code, or handle.

app_partnerstring

A short identifier, code, or handle.

app_versionstring

A short identifier, code, or handle.

Response

OK

Example response

{
  "response": {
    "results": [
      {
        "domain_risk": {
          "components": [
            {
              "evidence": [
                "dns"
              ]
            }
          ]
        }
      }
    ]
  }
}

Changes

No recorded changes to this operation across all 1 revision of this API.