Skip to content

Splunk SOAR app actions reference

This page documents all supported actions for the DomainTools App for Splunk SOAR.

The following actions are supported:

  • Test Connectivity - Validate the asset configuration for connectivity
  • Domain Reputation - Evaluate the risk of a given domain
  • Pivot Action - Find domains connected by any supported Iris Investigate search parameter
  • Reverse Domain - Extract IPs from a single domain response for further pivoting
  • Reverse IP - Find domains with web hosting IP, NS IP or MX IP
  • Load Hash - Load or monitor Iris Investigate search results by Iris Investigate export hash
  • Reverse Email - Find domains with email in WHOIS, DNS SOA or SSL certificate
  • Lookup Domain - Get all Iris Investigate data for a domain using the Iris Investigate API endpoint (required)
  • Enrich Domain - Get all Iris Investigate data for a domain except counts using the high volume Iris Enrich API endpoint (if provisioned)
  • Configure Scheduled Playbooks - Run on initial setup to configure the optional monitoring playbooks
  • On Poll - Execute scheduled playbooks based on the set interval in domaintools_scheduled_playbooks custom list
  • Parsed Domain RDAP - Return the most recent Domain-RDAP registration record for a domain
  • NOD Feed - Retrieve apex-level domains observed for the first time, not present in DNSDB
  • NAD Feed - Retrieve apex-level domains newly observed in the DNS sensor network
  • NOH Feed - Retrieve fully qualified domain names never seen before in passive DNS
  • Domain Discovery Feed - Retrieve new domains discovered via registration, sensor network, or third parties
  • Domain RDAP Feed - Retrieve RDAP registration records for domains
  • Domain Risk Feed - Retrieve real-time updates to Domain Risk Scores for apex domains
  • Domain Hotlist Feed - Retrieve high-risk domains active within the last 24 hours
  • Iris Detect Get New Domains - Retrieve newly discovered domains from Iris Detect across all monitors
  • Iris Detect Get Watched Domains - Retrieve watched domains from Iris Detect across all monitors
  • Iris Detect Get Ignored Domains - Retrieve ignored (false positive) domains from Iris Detect
  • Iris Detect Get Escalated Domains - Retrieve domains escalated to Google Safe Browsing from Iris Detect
  • Iris Detect Get Blocklist Domains - Retrieve domains escalated for internal blocking from Iris Detect
  • Iris Detect Get Monitors List - Retrieve the list of monitors configured in Iris Detect
  • Iris Detect Escalate Domains - Escalate one or more watched domains to Google Safe Browsing
  • Iris Detect Blocklist Domains - Escalate one or more watched domains for internal blocking
  • Iris Detect Watch Domains - Add one or more domains to the Iris Detect watchlist
  • Iris Detect Ignore Domains - Mark one or more domains as ignored in Iris Detect

Validate the asset configuration for connectivity.

Type: test Read only: True

This action requires no parameters.

No Output

Evaluate the risk of a given domain.

Type: Investigate Read only: True

ParameterRequiredDescriptionTypeContains
domainrequiredDomain or comma-separated list of domains to querystringurl domain
Data PathTypeContainsExample Values
action_result.parameter.domainstringurl domain
action_result.datastring
action_result.statusstringsuccess failed
action_result.messagestring
action_result.summary.domain_risknumeric
action_result.summary.zerolistedbooleanTrue False
action_result.summary.proximitynumeric
action_result.summary.threat_profilenumeric
action_result.summary.threat_profile_malwarenumeric
action_result.summary.threat_profile_phishingnumeric
action_result.summary.threat_profile_spamnumeric
summary.total_objectsnumeric1
summary.total_objects_successfulnumeric1

Find domains connected by any supported Iris Investigate search parameter.

Type: Investigate Read only: True

ParameterRequiredDescriptionTypeContains
query_valuerequiredValue to querystringurl domain ip email
pivot_typerequiredField to pivot onstring
statusoptionalReturn domains of this registration typestring
data_updated_afteroptionalIris Investigate records that were updated on or after midnight on this date, in YYYY-MM-DD format or relative options ( ‘today’, ‘yesterday’ )string
tldoptionalLimit results to only include domains in a specific top-level domain (i.e. “tld=com” or “tld=ru”)string
create_dateoptionalOnly include domains created on a specific date, in YYYY-MM-DD format or relative options ( ‘today’, ‘yesterday’ )string
create_date_withinoptionalOnly include domains with a whois create date within the specified number of days (e.g. specifying ‘1’ would indicate within the past day)string
first_seen_withinoptionalOnly include domains with a current lifecycle first observed within the specified number of seconds (e.g. specifying ‘86400’ would indicate within the past day)string
first_seen_sinceoptionalOnly include domains with a current lifecycle first observed since a specified datetime. (Example: 2023-04-10T00:00:00+00:00)string
expiration_dateoptionalOnly include domains expiring on a specific date, in YYYY-MM-DD format or relative options ( ‘today’, ‘yesterday’ )string
Data PathTypeContainsExample Values
action_result.parameter.create_datestring
action_result.parameter.create_date_withinstring
action_result.parameter.data_updated_afterstring
action_result.parameter.first_seen_withinstring
action_result.parameter.first_seen_sincestring
action_result.parameter.expiration_datestring
action_result.data.*.first_seen.countnumeric
action_result.data.*.first_seen.valuestring
action_result.data.*.server_type.countnumeric
action_result.data.*.server_type.valuestring
action_result.data.*.website_title.countnumeric
action_result.data.*.website_title.valuestring
action_result.parameter.pivot_typestring
action_result.parameter.query_valuestringurl domain ip email
action_result.parameter.statusstring
action_result.parameter.tldstring
action_result.data.*.domainstringdomain
action_result.data.*.domain_risk.risk_scorenumeric
action_result.data.*.domain_risk.risk_score_stringstring
action_result.statusstringsuccess failed
action_result.messagestring
action_result.summarystring
summary.total_objectsnumeric1
summary.total_objects_successfulnumeric1

Extract IPs from a single domain response for further pivoting.

Type: Investigate Read only: True

ParameterRequiredDescriptionTypeContains
domainrequiredDomain or comma-separated list of domains to querystringurl domain
Data PathTypeContainsExample Values
action_result.parameter.domainstringurl domain
action_result.datastring
action_result.data.*.first_seen.countnumeric
action_result.data.*.first_seen.valuestring
action_result.data.*.server_type.countnumeric
action_result.data.*.server_type.valuestring
action_result.data.*.website_title.countnumeric
action_result.data.*.website_title.valuestring
action_result.statusstringsuccess failed
action_result.messagestring
action_result.summary.ip_list.*.countnumeric
action_result.summary.ip_list.*.count_stringstring
action_result.summary.ip_list.*.ipstringip
action_result.summary.ip_list.*.typestring
summary.total_objectsnumeric1
summary.total_objects_successfulnumeric1

Find domains with web hosting IP, NS IP or MX IP.

Type: Investigate Read only: True

ParameterRequiredDescriptionTypeContains
iprequiredIP address to querystringip
statusoptionalReturn domains of this registration typestring
data_updated_afteroptionalIris Investigate records that were updated on or after midnight on this date, in YYYY-MM-DD format or relative options ( ‘today’, ‘yesterday’ )string
tldoptionalLimit results to only include domains in a specific top-level domain (i.e. “tld=com” or “tld=ru”)string
create_dateoptionalOnly include domains created on a specific date, in YYYY-MM-DD format or relative options ( ‘today’, ‘yesterday’ )string
create_date_withinoptionalOnly include domains with a whois create date within the specified number of days (e.g. specifying ‘1’ would indicate within the past day)string
first_seen_withinoptionalOnly include domains with a current lifecycle first observed within the specified number of seconds (e.g. specifying ‘86400’ would indicate within the past day)string
first_seen_sinceoptionalOnly include domains with a current lifecycle first observed since a specified datetime. (Example: 2023-04-10T00:00:00+00:00)string
expiration_dateoptionalOnly include domains expiring on a specific date, in YYYY-MM-DD format or relative options ( ‘today’, ‘yesterday’ )string
Data PathTypeContainsExample Values
action_result.parameter.create_datestring
action_result.parameter.create_date_withinstring
action_result.parameter.data_updated_afterstring
action_result.parameter.expiration_datestring
action_result.parameter.first_seen_withinstring
action_result.parameter.first_seen_sincestring
action_result.parameter.ipstringip
action_result.parameter.statusstring
action_result.parameter.tldstring
action_result.data.*.domainstringdomain
action_result.data.*.domain_risk.risk_scorenumeric
action_result.data.*.domain_risk.risk_score_stringstring
action_result.statusstringsuccess failed
action_result.messagestring
action_result.summarystring
summary.total_objectsnumeric1
summary.total_objects_successfulnumeric1

Load or monitor Iris Investigate search results by Iris Investigate export hash.

Type: Investigate Read only: True

ParameterRequiredDescriptionTypeContains
search_hashrequiredPaste the “Current Search Export” string (Advanced -> Import/Export Search) from Iris Investigate in this field to import up to 5000 domainsstring
Data PathTypeContainsExample Values
action_result.parameter.search_hashstring
action_result.data.*.domainstringdomain
action_result.data.*.domain_risk.risk_scorenumeric
action_result.data.*.domain_risk.risk_score_stringstring
action_result.statusstringsuccess failed
action_result.messagestring
action_result.summarystring
summary.total_objectsnumeric1
summary.total_objects_successfulnumeric1

Find domains with email in Whois, DNS SOA or SSL certificate.

Type: Investigate Read only: True

ParameterRequiredDescriptionTypeContains
emailrequiredEmail querystringemail
statusoptionalReturn domains of this registration typestring
data_updated_afteroptionalIris Investigate records that were updated on or after midnight on this date, in YYYY-MM-DD format or relative options ( ‘today’, ‘yesterday’ )string
tldoptionalLimit results to only include domains in a specific top-level domain (i.e. “tld=com” or “tld=ru”)string
create_dateoptionalOnly include domains created on a specific date, in YYYY-MM-DD format or relative options ( ‘today’, ‘yesterday’ )string
create_date_withinoptionalOnly include domains with a whois create date within the specified number of days (e.g. specifying ‘1’ would indicate within the past day)string
first_seen_withinoptionalOnly include domains with a current lifecycle first observed within the specified number of seconds (e.g. specifying ‘86400’ would indicate within the past day)string
first_seen_sinceoptionalOnly include domains with a current lifecycle first observed since a specified datetime. (Example: 2023-04-10T00:00:00+00:00)string
expiration_dateoptionalOnly include domains expiring on a specific date, in YYYY-MM-DD format or relative options ( ‘today’, ‘yesterday’ )string
Data PathTypeContainsExample Values
action_result.parameter.create_datestring
action_result.parameter.create_date_withinstring
action_result.parameter.data_updated_afterstring
action_result.parameter.emailstringemail
action_result.parameter.expiration_datestring
action_result.parameter.first_seen_withinstring
action_result.parameter.first_seen_sincestring
action_result.parameter.statusstring
action_result.parameter.tldstring
action_result.data.*.domainstringdomain
action_result.data.*.domain_risk.risk_scorenumeric
action_result.data.*.domain_risk.risk_score_stringstring
action_result.data.*.first_seen.countnumeric
action_result.data.*.first_seen.valuestring
action_result.data.*.server_type.countnumeric
action_result.data.*.server_type.valuestring
action_result.data.*.website_title.countnumeric
action_result.data.*.website_title.valuestring
action_result.statusstringsuccess failed
action_result.messagestring
action_result.summarystring
summary.total_objectsnumeric1
summary.total_objects_successfulnumeric1

The Parsed Domain RDAP API returns the most recent Domain-RDAP registration record. This action complements the WHOIS-based lookups: some registries and registrars support RDAP as an alternative to WHOIS for providing domain registration data.

Type: Investigate Read only: True

ParameterRequiredDescriptionTypeContains
domainoptionalThe domain name to query (for example, example.com)string
Data PathTypeContainsExample Values
action_result.datastring
action_result.data.*.domainstringdomain
action_result.data.*.domain_statusesstring
action_result.data.*.creation_datestring
action_result.data.*.last_changed_datestring
action_result.data.*.expiration_datestring
action_result.data.*.dnssec.signedboolean
action_result.data.*.nameserversstring
action_result.data.*.conformancestring
action_result.data.*.emailsstring
action_result.data.*.email_domainsstring
action_result.data.*.unclassified_emailsstring
action_result.data.*.registrar_namestring
action_result.data.*.registrar_iana_idstring
action_result.data.*.registrar_contacts_namestring
action_result.data.*.registrar_contacts_emailstring
action_result.data.*.registrar_contacts_phonestring
action_result.data.*.registrar_contacts_rolesstring
action_result.data.*.contact_name_1string
action_result.data.*.contact_org_1string
action_result.data.*.contact_email_1string
action_result.data.*.contact_phone_1string
action_result.data.*.contact_street_1string
action_result.data.*.contact_city_1string
action_result.data.*.contact_postal_1string
action_result.data.*.contact_region_1string
action_result.data.*.contact_country_1string
action_result.data.*.contact_roles_1string
action_result.data.*.contact_name_2string
action_result.data.*.contact_org_2string
action_result.data.*.contact_email_2string
action_result.data.*.contact_phone_2string
action_result.data.*.contact_street_2string
action_result.data.*.contact_city_2string
action_result.data.*.contact_postal_2string
action_result.data.*.contact_region_2string
action_result.data.*.contact_country_2string
action_result.data.*.contact_roles_2string
action_result.data.*.contact_name_3string
action_result.data.*.contact_org_3string
action_result.data.*.contact_email_3string
action_result.data.*.contact_phone_3string
action_result.data.*.contact_street_3string
action_result.data.*.contact_city_3string
action_result.data.*.contact_postal_3string
action_result.data.*.contact_region_3string
action_result.data.*.contact_country_3string
action_result.data.*.contact_roles_3string
action_result.statusstringsuccess failed
action_result.summarystring
action_result.messagestring
action_result.parameter.domainstring
summary.total_objectsnumeric1
summary.total_objects_successfulnumeric1

Apex-level domains observed for the first time by the DomainTools sensor network, and not present in the DNSDB historical database.

Type: Investigate Read only: True

ParameterRequiredDescriptionTypeContains
domainoptionalFilter by exact domain or partial match (prefix or suffix with *)string
beforeoptionalEnd of the query window, in seconds or ISO 8601 format, relative to current time, inclusivestring
afteroptionalStart of the query window, in seconds or ISO 8601 format, relative to current time, inclusivestring
session_idoptionalUnique identifier for the session; resumes retrieval from the last recorded timestampstring
topoptionalMaximum number of results to returnstring
Data PathTypeContainsExample Values
action_result.datastring
action_result.data.*.domainstringdomain
action_result.data.*.timestampstring
action_result.statusstringsuccess failed
action_result.summarystring
action_result.messagestring
action_result.parameter.afterstring
action_result.parameter.beforestring
action_result.parameter.domainstring
action_result.parameter.session_idstring
action_result.parameter.topstring
summary.total_objectsnumeric1
summary.total_objects_successfulnumeric1

Apex-level domains newly observed in the DomainTools DNS sensor network. Includes domains observed in DNS for the first time, and domains re-observed after at least 10 days of inactivity.

Type: Investigate Read only: True

ParameterRequiredDescriptionTypeContains
domainoptionalFilter by exact domain or partial match (prefix or suffix with *)string
beforeoptionalEnd of the query window, in seconds or ISO 8601 format, relative to current time, inclusivestring
afteroptionalStart of the query window, in seconds or ISO 8601 format, relative to current time, inclusivestring
session_idoptionalUnique identifier for the session; resumes retrieval from the last recorded timestampstring
topoptionalMaximum number of results to returnstring
Data PathTypeContainsExample Values
action_result.datastring
action_result.data.*.domainstringdomain
action_result.data.*.timestampstring
action_result.statusstringsuccess failed
action_result.summarystring
action_result.messagestring
action_result.parameter.afterstring
action_result.parameter.beforestring
action_result.parameter.domainstring
action_result.parameter.session_idstring
action_result.parameter.topstring
summary.total_objectsnumeric1
summary.total_objects_successfulnumeric1

Fully qualified domain names never seen before in passive DNS, emitted as soon as they are first observed by the DomainTools global DNS sensor network.

Type: Investigate Read only: True

ParameterRequiredDescriptionTypeContains
domainoptionalFilter by exact domain or partial match (prefix or suffix with *)string
beforeoptionalEnd of the query window, in seconds or ISO 8601 format, relative to current time, inclusivestring
afteroptionalStart of the query window, in seconds or ISO 8601 format, relative to current time, inclusivestring
session_idoptionalUnique identifier for the session; resumes retrieval from the last recorded timestampstring
topoptionalMaximum number of results to returnstring
Data PathTypeContainsExample Values
action_result.datastring
action_result.data.*.domainstringdomain
action_result.data.*.timestampstring
action_result.statusstringsuccess failed
action_result.summarystring
action_result.messagestring
action_result.parameter.afterstring
action_result.parameter.beforestring
action_result.parameter.domainstring
action_result.parameter.session_idstring
action_result.parameter.topstring
summary.total_objectsnumeric1
summary.total_objects_successfulnumeric1

New domains as they are discovered in domain registration information, observed by the DomainTools global sensor network, or reported by trusted third parties.

Type: Investigate Read only: True

ParameterRequiredDescriptionTypeContains
domainoptionalFilter by exact domain or partial match (prefix or suffix with *)string
beforeoptionalEnd of the query window, in seconds or ISO 8601 format, relative to current time, inclusivestring
afteroptionalStart of the query window, in seconds or ISO 8601 format, relative to current time, inclusivestring
session_idoptionalUnique identifier for the session; resumes retrieval from the last recorded timestampstring
topoptionalMaximum number of results to returnstring
Data PathTypeContainsExample Values
action_result.datastring
action_result.data.*.domainstringdomain
action_result.data.*.timestampstring
action_result.statusstringsuccess failed
action_result.summarystring
action_result.messagestring
action_result.parameter.afterstring
action_result.parameter.beforestring
action_result.parameter.domainstring
action_result.parameter.session_idstring
action_result.parameter.topstring
summary.total_objectsnumeric1
summary.total_objects_successfulnumeric1

RDAP registration records for domains. When a domain has records from both a registry and a registrar, the response combines both sets of results.

Type: Investigate Read only: True

ParameterRequiredDescriptionTypeContains
domainoptionalFilter by exact domain or partial match (prefix or suffix with *)string
beforeoptionalEnd of the query window, in seconds or ISO 8601 format, relative to current time, inclusivestring
afteroptionalStart of the query window, in seconds or ISO 8601 format, relative to current time, inclusivestring
session_idoptionalUnique identifier for the session; resumes retrieval from the last recorded timestampstring
topoptionalMaximum number of results to returnstring
Data PathTypeContainsExample Values
action_result.datastring
action_result.data.*.domainstringdomain
action_result.data.*.timestampstring
action_result.data.*.parsed_record.parsed_fieldsstring
action_result.statusstringsuccess failed
action_result.summarystring
action_result.messagestring
action_result.parameter.afterstring
action_result.parameter.beforestring
action_result.parameter.domainstring
action_result.parameter.session_idstring
action_result.parameter.topstring
summary.total_objectsnumeric1
summary.total_objects_successfulnumeric1

Real-time updates to Domain Risk Scores for apex domains, regardless of observed traffic.

Type: Investigate Read only: True

ParameterRequiredDescriptionTypeContains
domainoptionalFilter by exact domain or partial match (prefix or suffix with *)string
beforeoptionalEnd of the query window, in seconds or ISO 8601 format, relative to current time, inclusivestring
afteroptionalStart of the query window, in seconds or ISO 8601 format, relative to current time, inclusivestring
session_idoptionalUnique identifier for the session; resumes retrieval from the last recorded timestampstring
topoptionalMaximum number of results to returnstring
Data PathTypeContainsExample Values
action_result.datastring
action_result.data.*.domainstringdomain
action_result.data.*.timestampstring
action_result.data.*.phishing_riskstring
action_result.data.*.malware_riskstring
action_result.data.*.spam_riskstring
action_result.data.*.proximity_riskstring
action_result.data.*.overall_riskstring
action_result.statusstringsuccess failed
action_result.summarystring
action_result.messagestring
action_result.parameter.afterstring
action_result.parameter.beforestring
action_result.parameter.domainstring
action_result.parameter.session_idstring
action_result.parameter.topstring
summary.total_objectsnumeric1
summary.total_objects_successfulnumeric1

Domains with high Domain Risk Scores that have also been active within 24 hours.

Type: Investigate Read only: True

ParameterRequiredDescriptionTypeContains
domainoptionalFilter by exact domain or partial match (prefix or suffix with *)string
beforeoptionalEnd of the query window, in seconds or ISO 8601 format, relative to current time, inclusivestring
afteroptionalStart of the query window, in seconds or ISO 8601 format, relative to current time, inclusivestring
session_idoptionalUnique identifier for the session; resumes retrieval from the last recorded timestampstring
topoptionalMaximum number of results to returnstring
Data PathTypeContainsExample Values
action_result.datastring
action_result.data.*.domainstringdomain
action_result.data.*.timestampstring
action_result.data.*.phishing_riskstring
action_result.data.*.malware_riskstring
action_result.data.*.spam_riskstring
action_result.data.*.proximity_riskstring
action_result.data.*.overall_riskstring
action_result.data.*.expiresstring
action_result.statusstringsuccess failed
action_result.summarystring
action_result.messagestring
action_result.parameter.afterstring
action_result.parameter.beforestring
action_result.parameter.domainstring
action_result.parameter.session_idstring
action_result.parameter.topstring
summary.total_objectsnumeric1
summary.total_objects_successfulnumeric1

Get all Iris Investigate data for a domain using the Iris Investigate API endpoint (required).

Type: Investigate Read only: True

ParameterRequiredDescriptionTypeContains
domainrequiredDomain or comma-separated list of domains to query using the Iris Investigate APIstringurl domain
Data PathTypeContainsExample Values
action_result.statusstringfailed success
action_result.parameter.domainstringurl domain
action_result.messagestring
action_result.summarystring
summary.total_objectsnumeric1
summary.total_objects_successfulnumeric1

The action_result.data.* fields are grouped by category below. Each field includes a .count (numeric) and .value (string) pair unless otherwise noted.

Admin contact — action_result.data.*.admin_contact.*

FieldType
city.count / city.valuenumeric / string
country.count / country.valuenumeric / string
fax.count / fax.valuenumeric / string
name.count / name.valuenumeric / string
org.count / org.valuenumeric / string
phone.count / phone.valuenumeric / string
postal.count / postal.valuenumeric / string
state.count / state.valuenumeric / string
street.count / street.valuenumeric / string

Billing contact — action_result.data.*.billing_contact.*

Same fields as admin contact: city, country, fax, name, org, phone, postal, state, street (each with .count and .value).

Registrant contact — action_result.data.*.registrant_contact.*

Same fields as admin contact, plus:

FieldType
email.*.count / email.*.valuenumeric / string

Technical contact — action_result.data.*.technical_contact.*

Same fields as admin contact: city, country, fax, name, org, phone, postal, state, street (each with .count and .value).

Registrant (top-level) — action_result.data.*

FieldType
registrant_name.count / registrant_name.valuenumeric / string
registrant_org.count / registrant_org.valuenumeric / string
registrar.count / registrar.valuenumeric / string

IP addresses — action_result.data.*.ip.*

FieldType
address.count / address.valuenumeric / string
asn.*.count / asn.*.valuenumeric / string
country_code.count / country_code.valuenumeric / string
isp.count / isp.valuenumeric / string

Name servers — action_result.data.*.name_server.*

FieldType
domain.count / domain.valuenumeric / string
host.count / host.valuenumeric / string
ip.*.count / ip.*.valuenumeric / string

Mail servers — action_result.data.*.mx.*

FieldType
domain.count / domain.valuenumeric / string
host.count / host.valuenumeric / string
ip.*.count / ip.*.valuenumeric / string

SOA email — action_result.data.*.soa_email.*

FieldType
*.count / *.valuenumeric / string

SSL info — action_result.data.*.ssl_info.*

FieldType
alt_names.*.count / alt_names.*.valuenumeric / string
common_name.count / common_name.valuenumeric / string
duration.count / duration.valuenumeric / string
email.*.count / email.*.valuenumeric / string
hash.count / hash.valuenumeric / string
issuer_common_name.count / issuer_common_name.valuenumeric / string
not_after.count / not_after.valuenumeric / string
not_before.count / not_before.valuenumeric / string
organization.count / organization.valuenumeric / string
subject.count / subject.valuenumeric / string

Web and redirect — action_result.data.*

FieldType
redirect.count / redirect.valuenumeric / string
redirect_domain.count / redirect_domain.valuenumeric / string
server_type.count / server_type.valuenumeric / string
website_title.count / website_title.valuenumeric / string
Data PathType
action_result.data.*.additional_whois_email.*.countnumeric
action_result.data.*.additional_whois_email.*.valuestring
action_result.data.*.adsense.count / .valuenumeric / string
action_result.data.*.alexanumeric
action_result.data.*.create_date.count / .valuenumeric / string
action_result.data.*.domain_risk.risk_scorenumeric
action_result.data.*.email_domain.*.count / .valuenumeric / string
action_result.data.*.expiration_date.count / .valuenumeric / string
action_result.data.*.first_seen.count / .valuenumeric / string
action_result.data.*.google_analytics.count / .valuenumeric / string
action_result.data.*.tldstring
Data PathType
action_result.data.*.tags.*.labelstring
action_result.data.*.tags.*.scopestring
action_result.data.*.tags.*.tagged_atstring

Run on initial setup to configure the optional monitoring playbooks. This action creates a custom list to manage the playbook scheduling and run status.

Type: Investigate Read only: True

This action requires no parameters.

Data PathTypeContainsExample Values
action_result.statusstringfailed success
action_result.data.*string
action_result.summarystring
action_result.messagestring
summary.total_objectsnumeric1
summary.total_objects_successfulnumeric1

Execute scheduled playbooks based on the set interval in domaintools_scheduled_playbooks custom list. Smaller intervals result in more accurate schedules.

Type: ingest Read only: True

No parameters are required for this action.

No Output

Retrieve newly discovered domains from Iris Detect across all monitors or a specific monitor.

Type: Investigate Read only: True

ParameterRequiredDescriptionTypeContains
monitor_idoptionalMonitor ID to filter results to a specific monitorstring
tldsoptionalComma-separated list of TLDs to filter results (for example, com,net)string
risk_score_rangesoptionalComma-separated risk score ranges to filter by (for example, 70-99,100-100)string
mx_existsoptionalFilter by whether the domain has an MX recordboolean
discovered_sinceoptionalFilter domains discovered since this datetime (ISO 8601 format)string
changed_sinceoptionalFilter domains changed since this datetime (ISO 8601 format)string
searchoptionalSearch string to filter domains by name (contains match)string
sortoptionalSort field (discovered_date, changed_date, or risk_score)string
orderoptionalSort orderstring
include_domain_dataoptionalInclude DNS and WHOIS/RDAP details in the responseboolean
limitoptionalMaximum number of results to return (max 100, or 50 if include_domain_data is true)numeric
offsetoptionalNumber of results to skip for paginationnumeric
previewoptionalPreview mode for testing — limits results to 10 without hourly rate limitboolean
Data PathTypeContainsExample Values
action_result.data.*.domainstringdomain
action_result.data.*.statestring
action_result.data.*.risk_scorenumeric
action_result.data.*.risk_score_statusstring
action_result.data.*.discovered_datestring
action_result.data.*.changed_datestring
action_result.data.*.statusstring
action_result.data.*.tldstring
action_result.data.*.idstring
action_result.data.*.mx_existsboolean
action_result.data.*.monitor_idsstring
action_result.statusstringsuccess failed
action_result.messagestring
action_result.summary.domain_countnumeric
action_result.summary.total_countnumeric
action_result.parameter.monitor_idstring
action_result.parameter.tldsstring
action_result.parameter.risk_score_rangesstring
action_result.parameter.mx_existsboolean
action_result.parameter.discovered_sincestring
action_result.parameter.changed_sincestring
action_result.parameter.searchstring
action_result.parameter.sortstring
action_result.parameter.orderstring
action_result.parameter.include_domain_databoolean
action_result.parameter.limitnumeric
action_result.parameter.offsetnumeric
action_result.parameter.previewboolean
summary.total_objectsnumeric1
summary.total_objects_successfulnumeric1

Retrieve watched domains from Iris Detect across all monitors or a specific monitor.

Type: Investigate Read only: True

ParameterRequiredDescriptionTypeContains
monitor_idoptionalMonitor ID to filter results to a specific monitorstring
tldsoptionalComma-separated list of TLDs to filter results (for example, com,net)string
risk_score_rangesoptionalComma-separated risk score ranges to filter by (for example, 70-99,100-100)string
mx_existsoptionalFilter by whether the domain has an MX recordboolean
discovered_sinceoptionalFilter domains discovered since this datetime (ISO 8601 format)string
changed_sinceoptionalFilter domains changed since this datetime (ISO 8601 format)string
escalated_sinceoptionalFilter domains escalated since this datetime (ISO 8601 format)string
searchoptionalSearch string to filter domains by name (contains match)string
sortoptionalSort fieldstring
orderoptionalSort orderstring
include_domain_dataoptionalInclude DNS and WHOIS/RDAP details in the responseboolean
limitoptionalMaximum number of results to return (max 100, or 50 if include_domain_data is true)numeric
offsetoptionalNumber of results to skip for paginationnumeric
previewoptionalPreview mode for testing — limits results to 10 without hourly rate limitboolean
Data PathTypeContainsExample Values
action_result.data.*.domainstringdomain
action_result.data.*.statestring
action_result.data.*.risk_scorenumeric
action_result.data.*.risk_score_statusstring
action_result.data.*.discovered_datestring
action_result.data.*.changed_datestring
action_result.data.*.statusstring
action_result.data.*.escalationsstring
action_result.data.*.tldstring
action_result.data.*.idstring
action_result.data.*.mx_existsboolean
action_result.data.*.monitor_idsstring
action_result.statusstringsuccess failed
action_result.messagestring
action_result.summary.domain_countnumeric
action_result.summary.total_countnumeric
action_result.parameter.monitor_idstring
action_result.parameter.tldsstring
action_result.parameter.risk_score_rangesstring
action_result.parameter.mx_existsboolean
action_result.parameter.discovered_sincestring
action_result.parameter.changed_sincestring
action_result.parameter.escalated_sincestring
action_result.parameter.searchstring
action_result.parameter.sortstring
action_result.parameter.orderstring
action_result.parameter.include_domain_databoolean
action_result.parameter.limitnumeric
action_result.parameter.offsetnumeric
action_result.parameter.previewboolean
summary.total_objectsnumeric1
summary.total_objects_successfulnumeric1

Retrieve ignored (false positive) domains from Iris Detect across all monitors or a specific monitor.

Type: Investigate Read only: True

ParameterRequiredDescriptionTypeContains
monitor_idoptionalMonitor ID to filter results to a specific monitorstring
tldsoptionalComma-separated list of TLDs to filter results (for example, com,net)string
risk_score_rangesoptionalComma-separated risk score ranges to filter by (for example, 70-99,100-100)string
mx_existsoptionalFilter by whether the domain has an MX recordboolean
discovered_sinceoptionalFilter domains discovered since this datetime (ISO 8601 format)string
changed_sinceoptionalFilter domains changed since this datetime (ISO 8601 format)string
escalated_sinceoptionalFilter domains escalated since this datetime (ISO 8601 format)string
searchoptionalSearch string to filter domains by name (contains match)string
sortoptionalSort fieldstring
orderoptionalSort orderstring
include_domain_dataoptionalInclude DNS and WHOIS/RDAP details in the responseboolean
limitoptionalMaximum number of results to return (max 100, or 50 if include_domain_data is true)numeric
offsetoptionalNumber of results to skip for paginationnumeric
previewoptionalPreview mode for testing — limits results to 10 without hourly rate limitboolean
Data PathTypeContainsExample Values
action_result.data.*.domainstringdomain
action_result.data.*.statestring
action_result.data.*.risk_scorenumeric
action_result.data.*.risk_score_statusstring
action_result.data.*.discovered_datestring
action_result.data.*.changed_datestring
action_result.data.*.statusstring
action_result.data.*.tldstring
action_result.data.*.idstring
action_result.data.*.mx_existsboolean
action_result.data.*.monitor_idsstring
action_result.statusstringsuccess failed
action_result.messagestring
action_result.summary.domain_countnumeric
action_result.summary.total_countnumeric
action_result.parameter.monitor_idstring
action_result.parameter.tldsstring
action_result.parameter.risk_score_rangesstring
action_result.parameter.mx_existsboolean
action_result.parameter.discovered_sincestring
action_result.parameter.changed_sincestring
action_result.parameter.escalated_sincestring
action_result.parameter.searchstring
action_result.parameter.sortstring
action_result.parameter.orderstring
action_result.parameter.include_domain_databoolean
action_result.parameter.limitnumeric
action_result.parameter.offsetnumeric
action_result.parameter.previewboolean
summary.total_objectsnumeric1
summary.total_objects_successfulnumeric1

Retrieve domains escalated to Google Safe Browsing from Iris Detect.

Type: Investigate Read only: True

ParameterRequiredDescriptionTypeContains
monitor_idoptionalMonitor ID to filter results to a specific monitorstring
tldsoptionalComma-separated list of TLDs to filter results (for example, com,net)string
risk_score_rangesoptionalComma-separated risk score ranges to filter by (for example, 70-99,100-100)string
mx_existsoptionalFilter by whether the domain has an MX recordboolean
discovered_sinceoptionalFilter domains discovered since this datetime (ISO 8601 format)string
changed_sinceoptionalFilter domains changed since this datetime (ISO 8601 format)string
escalated_sinceoptionalFilter domains escalated since this datetime (ISO 8601 format)string
searchoptionalSearch string to filter domains by name (contains match)string
sortoptionalSort fieldstring
orderoptionalSort orderstring
include_domain_dataoptionalInclude DNS and WHOIS/RDAP details in the responseboolean
limitoptionalMaximum number of results to return (max 100, or 50 if include_domain_data is true)numeric
offsetoptionalNumber of results to skip for paginationnumeric
previewoptionalPreview mode for testing — limits results to 10 without hourly rate limitboolean
Data PathTypeContainsExample Values
action_result.data.*.domainstringdomain
action_result.data.*.statestring
action_result.data.*.risk_scorenumeric
action_result.data.*.risk_score_statusstring
action_result.data.*.discovered_datestring
action_result.data.*.changed_datestring
action_result.data.*.statusstring
action_result.data.*.escalationsstring
action_result.data.*.tldstring
action_result.data.*.idstring
action_result.data.*.mx_existsboolean
action_result.data.*.monitor_idsstring
action_result.statusstringsuccess failed
action_result.messagestring
action_result.summary.domain_countnumeric
action_result.summary.total_countnumeric
summary.total_objectsnumeric1
summary.total_objects_successfulnumeric1

Retrieve domains escalated for internal blocking from Iris Detect.

Type: Investigate Read only: True

ParameterRequiredDescriptionTypeContains
monitor_idoptionalMonitor ID to filter results to a specific monitorstring
tldsoptionalComma-separated list of TLDs to filter results (for example, com,net)string
risk_score_rangesoptionalComma-separated risk score ranges to filter by (for example, 70-99,100-100)string
mx_existsoptionalFilter by whether the domain has an MX recordboolean
discovered_sinceoptionalFilter domains discovered since this datetime (ISO 8601 format)string
changed_sinceoptionalFilter domains changed since this datetime (ISO 8601 format)string
escalated_sinceoptionalFilter domains escalated since this datetime (ISO 8601 format)string
searchoptionalSearch string to filter domains by name (contains match)string
sortoptionalSort fieldstring
orderoptionalSort orderstring
include_domain_dataoptionalInclude DNS and WHOIS/RDAP details in the responseboolean
limitoptionalMaximum number of results to return (max 100, or 50 if include_domain_data is true)numeric
offsetoptionalNumber of results to skip for paginationnumeric
previewoptionalPreview mode for testing — limits results to 10 without hourly rate limitboolean
Data PathTypeContainsExample Values
action_result.data.*.domainstringdomain
action_result.data.*.statestring
action_result.data.*.risk_scorenumeric
action_result.data.*.risk_score_statusstring
action_result.data.*.discovered_datestring
action_result.data.*.changed_datestring
action_result.data.*.statusstring
action_result.data.*.escalationsstring
action_result.data.*.tldstring
action_result.data.*.idstring
action_result.data.*.mx_existsboolean
action_result.data.*.monitor_idsstring
action_result.statusstringsuccess failed
action_result.messagestring
action_result.summary.domain_countnumeric
action_result.summary.total_countnumeric
summary.total_objectsnumeric1
summary.total_objects_successfulnumeric1

Retrieve the list of monitors configured in Iris Detect for your account.

Type: Investigate Read only: True

ParameterRequiredDescriptionTypeContains
include_countsoptionalInclude counts of new, watched, changed, and escalated domains per monitorboolean
datetime_counts_sinceoptionalRequired if include_counts is true. Datetime to count domains from (ISO 8601 format)string
sortoptionalSort fieldstring
orderoptionalSort orderstring
limitoptionalMaximum number of monitors to return (max 100)numeric
offsetoptionalNumber of results to skip for paginationnumeric
Data PathTypeContainsExample Values
action_result.data.*.termstring
action_result.data.*.idstring
action_result.data.*.statestring
action_result.data.*.statusstring
action_result.data.*.created_datestring
action_result.data.*.updated_datestring
action_result.data.*.created_bystring
action_result.data.*.match_substring_variationsboolean
action_result.data.*.nameserver_exclusionsstring
action_result.data.*.text_exclusionsstring
action_result.data.*.domain_counts.newnumeric
action_result.data.*.domain_counts.watchednumeric
action_result.data.*.domain_counts.changednumeric
action_result.data.*.domain_counts.escalatednumeric
action_result.statusstringsuccess failed
action_result.messagestring
action_result.summary.monitor_countnumeric
action_result.summary.total_countnumeric
action_result.parameter.include_countsboolean
action_result.parameter.datetime_counts_sincestring
action_result.parameter.sortstring
action_result.parameter.orderstring
action_result.parameter.limitnumeric
action_result.parameter.offsetnumeric
summary.total_objectsnumeric1
summary.total_objects_successfulnumeric1

Escalate one or more watched domains to Google Safe Browsing via Iris Detect.

Type: correct Read only: False

ParameterRequiredDescriptionTypeContains
watchlist_domain_idsrequiredComma-separated list of Iris Detect domain IDs to escalate to Google Safe Browsingstring
Data PathTypeContainsExample Values
action_result.data.*.watchlist_domain_idstring
action_result.data.*.escalation_typestring
action_result.data.*.idstring
action_result.data.*.created_datestring
action_result.data.*.created_bystring
action_result.data.*.updated_datestring
action_result.parameter.watchlist_domain_idsstring
action_result.statusstringsuccess failed
action_result.messagestring
action_result.summary.escalated_countnumeric
summary.total_objectsnumeric1
summary.total_objects_successfulnumeric1

Escalate one or more watched domains for internal blocking via Iris Detect.

Type: correct Read only: False

ParameterRequiredDescriptionTypeContains
watchlist_domain_idsrequiredComma-separated list of Iris Detect domain IDs to escalate for internal blockingstring
Data PathTypeContainsExample Values
action_result.data.*.watchlist_domain_idstring
action_result.data.*.escalation_typestring
action_result.data.*.idstring
action_result.data.*.created_datestring
action_result.data.*.created_bystring
action_result.data.*.updated_datestring
action_result.parameter.watchlist_domain_idsstring
action_result.statusstringsuccess failed
action_result.messagestring
action_result.summary.blocklisted_countnumeric
summary.total_objectsnumeric1
summary.total_objects_successfulnumeric1

Add one or more domains to the Iris Detect watchlist for ongoing monitoring.

Type: correct Read only: False

ParameterRequiredDescriptionTypeContains
watchlist_domain_idsrequiredComma-separated list of Iris Detect domain IDs to add to the watchliststring
Data PathTypeContainsExample Values
action_result.data.*.domainstringdomain
action_result.data.*.statestring
action_result.data.*.idstring
action_result.data.*.discovered_datestring
action_result.data.*.changed_datestring
action_result.parameter.watchlist_domain_idsstring
action_result.statusstringsuccess failed
action_result.messagestring
action_result.summary.watched_countnumeric
summary.total_objectsnumeric1
summary.total_objects_successfulnumeric1

Mark one or more domains as ignored (false positives) in Iris Detect.

Type: correct Read only: False

ParameterRequiredDescriptionTypeContains
watchlist_domain_idsrequiredComma-separated list of Iris Detect domain IDs to mark as ignoredstring
Data PathTypeContainsExample Values
action_result.data.*.domainstringdomain
action_result.data.*.statestring
action_result.data.*.idstring
action_result.data.*.discovered_datestring
action_result.data.*.changed_datestring
action_result.parameter.watchlist_domain_idsstring
action_result.statusstringsuccess failed
action_result.messagestring
action_result.summary.ignored_countnumeric
summary.total_objectsnumeric1
summary.total_objects_successfulnumeric1