{"type":"api","title":"Get WHOIS Information Search","meta":{"id":"/apps/pubhub/media/legacy-umbrella-api/bf58de618cbb72dda8f39b0414ce94c0a15cd467/f963d12c-70c5-3340-bb7c-d5cff60c643a","info":{"title":"Investigate API","description":"Umbrella Investigate API","version":"1.1.4","contact":{"name":"Cloud Security Developer Community"}},"security":[{"bearerAuth":[]}],"tags":[{"name":"Domain Status and Categorization"},{"name":"Domain Volume"},{"name":"Co-occurrences for a Domain"},{"name":"Passive DNS"},{"name":"Tagging Timeline"},{"name":"Subdomains for a Domain"},{"name":"Related Domains for a Domain"},{"name":"Security Information for a Domain"},{"name":"AS Information for a Domain"},{"name":"WHOIS Information for a Domain"},{"name":"Umbrella Popularity List-Top Million Domains"},{"name":"Search Domain"},{"name":"Cisco Secure Malware Analytics Integration"}],"x-parser-conf":{"overview":{"markdownPath":"investigate/investigate-explorer-overview.md"}},"openapi":"3.0.0","servers":[{"url":"https://investigate.api.umbrella.com"}],"securitySchemes":{"bearerAuth":{"type":"http","scheme":"bearer"}}},"spec":{"summary":"Get WHOIS Information Search","operationId":"getWhoisSearch","tags":["WHOIS Information for a Domain"],"description":"Performs a regular expression (RegEx) search on the WHOIS data (domain, nameserver, and email fields)\nthat was 'updated' or 'created' in the specified time range.\nReturns a list of ten WHOIS records that match the specified RegEx expression.\nUse the offset query parameter to paginate the collection.\nBy default, Umbrella sorts by the `updated` field.\n","parameters":[{"name":"searchField","in":"path","required":true,"description":"Specifies the field name to use in the RegEx search.\nValid field names: `domain`, `nameserver`, and `email`.","schema":{"type":"string"}},{"name":"regexExpression","in":"path","required":true,"description":"A standard RegEx pattern search","schema":{"type":"string"}},{"name":"start","in":"query","required":true,"description":"Specifies a relative or absolute start time. If specifying an absolute time,\nuse an epoch time (Unix time) millisecond timestamp within the last 30 days as the Start.\nIf specifying a relative time, use either seconds, minutes, hours, days\nor weeks with a minus sign in front.\nAs an example, -1days, -1000minutes, or -2weeks are all valid.\nHowever these timestamps cannot be combined. Only use one of the relative time\nenumerators per query.","schema":{"type":"string"}},{"name":"stop","in":"query","required":false,"description":"Specifies the exclusive end time in milliseconds or a relative time ('now', '-2days').","schema":{"type":"string"}},{"name":"limit","in":"query","required":false,"description":"The number of items to return from the collection. The default is 10.\nIncrease the limit to request a larger set of data.","schema":{"type":"integer","default":10},"$$ref":"#/components/parameters/limitParam"},{"name":"offset","in":"query","required":false,"description":"A number that represents an index into the collection. By default, the offset is 0 (the first record).","schema":{"type":"integer"},"$$ref":"#/components/parameters/offsetParam"},{"name":"sortField","in":"query","required":false,"description":"Valid values are: 'created', 'updated', 'expires', or 'domainname'.","schema":{"type":"string"},"$$ref":"#/components/parameters/sortFieldParam"}],"responses":{"200":{"description":"Everything worked as expected.","content":{"application/json":{"schema":{"type":"object","properties":{"totalResults":{"type":"integer","description":"Total number of results for this search."},"offset":{"type":"integer"},"moreDataAvailable":{"type":"boolean","description":"Determines if there are more than 10 results for this search."},"limit":{"type":"integer","description":"Total number of results for this page. Default limit is 10."},"sortField":{"type":"string"},"records":{"type":"array","items":{"type":"object","description":"A standard WHOIS response record for a single domain.","properties":{"administrativeContactFax":{"type":"string"},"whoisServers":{"type":"string"},"addresses":{"type":"array","items":{"type":"string"}},"administrativeContactName":{"type":"string"},"zoneContactEmail":{"type":"string"},"billingContactFax":{"type":"string"},"administrativeContactTelephoneExt":{"type":"string"},"administrativeContactEmail":{"type":"string"},"technicalContactEmail":{"type":"string"},"technicalContactFax":{"type":"string"},"nameServers":{"type":"array","items":{"type":"string"}},"zoneContactName":{"type":"string"},"billingContactPostalCode":{"type":"string"},"zoneContactFax":{"type":"string"},"registrantTelephoneExt":{"type":"string"},"zoneContactFaxExt":{"type":"string"},"technicalContactTelephoneExt":{"type":"string"},"billingContactCity":{"type":"string"},"zoneContactStreet":{"type":"array","items":{"type":"string"}},"created":{"type":"string"},"administrativeContactCity":{"type":"string"},"registrantName":{"type":"string"},"zoneContactCity":{"type":"string"},"domainName":{"type":"string"},"zoneContactPostalCode":{"type":"string"},"administrativeContactFaxExt":{"type":"string"},"technicalContactCountry":{"type":"string"},"registrarIANAID":{"type":"string"},"updated":{"type":"string"},"administrativeContactStreet":{"type":"array","items":{"type":"string"}},"billingContactEmail":{"type":"string"},"status":{"type":"array","items":{"type":"string"}},"registrantCity":{"type":"string"},"billingContactCountry":{"type":"string"},"expires":{"type":"string"},"technicalContactStreet":{"type":"array","items":{"type":"string"}},"registrantOrganization":{"type":"string"},"billingContactStreet":{"type":"array","items":{"type":"string"}},"registrarName":{"type":"string"},"registrantPostalCode":{"type":"string"},"zoneContactTelephone":{"type":"string"},"registrantEmail":{"type":"string"},"technicalContactFaxExt":{"type":"string"},"technicalContactOrganization":{"type":"string"},"emails":{"type":"array","items":{"type":"string"}},"registrantStreet":{"type":"array","items":{"type":"string"}},"technicalContactTelephone":{"type":"string"},"technicalContactState":{"type":"string"},"technicalContactCity":{"type":"string"},"registrantFax":{"type":"string"},"registrantCountry":{"type":"string"},"billingContactFaxExt":{"type":"string"},"timestamp":{"type":"integer"},"zoneContactOrganization":{"type":"string"},"administrativeContactCountry":{"type":"string"},"billingContactName":{"type":"string"},"registrantState":{"type":"string"},"registrantTelephone":{"type":"string"},"administrativeContactState":{"type":"string"},"registrantFaxExt":{"type":"string"},"technicalContactPostalCode":{"type":"string"},"zoneContactTelephoneExt":{"type":"string"},"administrativeContactOrganization":{"type":"string"},"billingContactTelephone":{"type":"string"},"billingContactTelephoneExt":{"type":"string"},"zoneContactState":{"type":"string"},"administrativeContactTelephone":{"type":"string"},"billingContactOrganization":{"type":"string"},"technicalContactName":{"type":"string"},"administrativeContactPostalCode":{"type":"string"},"zoneContactCountry":{"type":"string"},"billingContactState":{"type":"string"},"auditUpdatedDate":{"type":"string"}},"$$ref":"#/components/schemas/WhoisDomain"}}}},"example":{"totalResults":500,"offset":0,"moreDataAvailable":true,"limit":10,"sortField":"updated","records":[]}}}},"400":{"description":"Invalid request","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string"}}}}},"$$ref":"#/components/responses/400Error"},"401":{"description":"Unauthorized request","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string"}}}}},"$$ref":"#/components/responses/401Error"},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string"}}}}},"$$ref":"#/components/responses/403Error"},"404":{"description":"Not Found","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string"}}}}},"$$ref":"#/components/responses/404Error"},"500":{"description":"Server error","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string"}}}}},"$$ref":"#/components/responses/500Error"}},"__originalOperationId":"getWhoisSearch","security":[{"bearerAuth":[]}],"method":"get","path":"/whois/search/{searchField}/{regexExpression}"}}