Help Center
Login Sign up
  1. Home
  2. API reference
  3. API documentation (JSON/XML)
  4. Objects

SOA object

API reference (XML/JSON) · Updated 2023-09-25

Description

The object SOA represents the SOA settings.

Only for ns action values "primary" and "complete".

Structure

Keyword JSONKeyword XMLOccursTypeFormatDescription

level0 - 1enumsoa_levelPre-defined SOA-Settings
ttlttl0 - 1integerint64Time-to-live default value of the Resource Record of a zone
refreshrefresh0 - 1integerint64Number of seconds after which secondary name servers 
should query the master for the SOA record, to detect zone changes.
retryretry0 - 1integerint64Number of seconds after which secondary name servers should retry to request the serial number from the master if the master does not respond. It must be less than Refresh.
expireexpire0 - 1integerint64Number of seconds after which secondary name servers 
should stop answering request for this zone if the master does not respond. 
This value must be bigger than the sum of Refresh and Retry

ignore0 - 1boolean
Check whether the SOA values used are within the range permitted by the registry.Possible values:
  • false = Check is performed
  • true = Not checked

Default = false

For XML, 0 (false) and 1 (true) can also be used.

emailemail0 - 1StringemailThe email address of the Zone Contact