Forward PADNS Lookup

Query Parameters:

• qtype (string) (required) –

  • the following qypes are supported:

    • a

    • aaaa

    • cname

    • mx

    • ns

    • ptr4

    • ptr6

    • any

    • anyipv4

    • anyipv6

    • soa

    • txt

• qname (string) (required) –

  • specify a name or IP address to lookup

    • name - wildcards (*) are supported in name string

    • IPv4

    • IPv6

• netmask = (int) (optional) –

  • net mask may be given for qtypes ptr4 or ptr6

    • defaults: IPv4 = 32, IPv6 = 128

• subdomains = (int) (optional) –

  • include or exclude subdomains from qtype a or aaaa results

    • 0 = exclude

    • 1 = include

• regex = (pattern) (optional) –

  • re2 regular expression

    • pattern must be a valid re2 regular expression

• match = (string) (optional) –

  • limit results to self-hosted infrastructure for qtype mx or ns

    • strict (default) - find all matching results

    • self - only show results where mx or ns records are in the same domain as qname

• first_seen_after = (optional) –

  • first_seen timestamp must be on or after this time

    • date: yyyy-mm-dd (2021-07-09) - fixed date

    • epoch: number (1625834953) - fixed time in epoch format

    • sec: negative number (-172800) - relative time seconds ago

    • time period: negative number with time period (-36h / -5d / -3w / -6m) - relative time ago

      • h : hours

      • d : days

      • w : weeks

      • m : months

• first_seen_before = (optional) –

  • first_seen timestamp must be on or before this time

  • date: yyyy-mm-dd (2021-07-09) - fixed date

  • epoch: number (1625834953) - fixed time in epoch format

  • sec: negative number (-172800) - relative time seconds ago

  • time period: negative number with time period (-36h / -5d / -3w / -6m) - relative time ago

    • h : hours

    • d : days

    • w : weeks

    • m : months

• last_seen_after = (optional) –

  • last_seen timestamp must be on or after this time

    • date: yyyy-mm-dd (2021-07-09) - fixed date

    • epoch: number (1625834953) - fixed time in epoch format

    • sec: negative number (-172800) - relative time seconds ago

    • time period: negative number with time period (-36h / -5d / -3w / -6m) - relative time ago

      • h : hours

      • d : days

      • w : weeks

      • m : months

• last_seen_before = (optional) –

  • last_seen timestamp must be on or before this time

    • date: yyyy-mm-dd (2021-07-09) - fixed date

    • epoch: number (1625834953) - fixed time in epoch format

    • sec: negative number (-172800) - relative time seconds ago

    • time period: negative number with time period (-36h / -5d / -3w / -6m) - relative time ago

      • h : hours

      • d : days

      • w : weeks

      • m : months

• as_of = (optional) –

  • only return records where the as_of timestamp equivalent is between the first_seen and the last_seen timestamp

    • date: yyyy-mm-dd (2021-07-09) - fixed date

    • epoch: number (1625834953) - fixed time in epoch format

    • sec: negative number (-172800) - relative time seconds ago

    • time period: negative number with time period (-36h / -5d / -3w / -6m) - relative time ago

      • h : hours

      • d : days

      • w : weeks

      • m : months

• sort = (optional) –

  • order results in specified order - parameter may be repeated with different column names to produce a nested sorting effect

    • sort:

      • last_seen/last/time_last - synonyms for last_seen column

      • first_seen/first/time_first - synonyms for first_seen column

      • query/rrname - synonyms for query column

      • answer/rdata - synonyms for answer_seen column

    • order:

      • asc/+/up - synonyms for ascending order

      • desc/-/down - synonyms for descending order

• output_format = (optional) –

  • padns (default) - Silent Push padns output format

  • cof - common output format

• limit = (int) (optional) –

  • number of results to return

    • default = 100

• skip = (int) (optional) –

  • number of results to skip

• prefer = (string) (optional) –

  • result (default) - return results if available before max_wait timeout, otherwise return job_id

  • job_id - return job_id immediately

• max_wait = (int) (optional) –

  • number of seconds to wait for results before returning job_id

    • default = 25

    • value in the range from 0 to 25

• with_metadata =<0|1> (int) (optional) –

  • include metadata object in response : returned results, total results, job_id

    • 0 (default) = do not include

    • 1 = include metadata

Request headers:

• X-API-KEY - api-key