Search SOA Records

Query Parameters

• domain = (string) (optional) –

  • name or wildcard pattern of domain names to search for

• regex = (pattern) (optional) –

  • re2 regular expression - may be used for complex matching on domain names

  • overrides domain parameter

    • pattern must be a valid re2 regular expression

• ns = (string) (optional) –

  • name or wildcard pattern of ns component

    • self - only show results where domain of ns component matches name of the record’s domain

• mbox = (string) (optional) –

  • name or wildcard pattern of mbox component

    • self - only show results where domain of mbox component matches name of the record’s domain

• serial = (int) (optional) –

  • serial number - exact match

• serial_min = (int) (optional) –

  • serial number - minimum value of serial number

• serial_max = (int) (optional) –

  • serial number - maximum value of serial number

• refresh = (int) (optional) –

  • refresh value - exact match

• refresh_min = (int) (optional) –

  • refresh value - minimum value of refresh

• refresh_max = (int) (optional) –

  • refresh value - maximum value of refresh

• retry = (int) (optional) –

  • retry value - exact match

• retry_min = (int) (optional) –

  • retry value - minimum value of retry

• retry_max = (int) (optional) –

  • retry value - maximum value of retry

• expire = (int) (optional) –

  • expire value - exact match

• expire_min = (int) (optional) –

  • expire value - minimum value of expire

• expire_max = (int) (optional) –

  • expire value - maximum value of expire

• min_tll = (int) (optional) –

  • min_ttl value - exact match

• min_ttl_min = (int) (optional) –

  • min_ttl value - minimum value of min_ttl

• min_ttl_max = (int) (optional) –

  • min_ttl value - maximum value of min_ttl

• 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

• limit_by_n = (int) (optional) –

  • number of results to return for each domain

    • should be used in combination with the sort option to order results by domain name:

      • sort=query/asc&limit_by_n=

      • sort=query/desc&limit_by_n=

• 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