dns-settings_soa

Components of the zone's SOA record.

APIs.ioEngineeringPlatform

Properties

Name Type Description
expire number Time in seconds of being unable to query the primary server after which secondary servers should stop serving the zone.
min_ttl number The time to live (TTL) for negative caching of records within the zone.
mname string The primary nameserver, which may be used for outbound zone transfers.
refresh number Time in seconds after which secondary servers should re-check the SOA record to see if the zone has been updated.
retry number Time in seconds after which secondary servers should retry queries after the primary server was unresponsive.
rname string The email address of the zone administrator, with the first label representing the local part of the email address.
ttl number The time to live (TTL) of the SOA record itself.
View JSON Schema on GitHub

JSON Schema

apis-io-engineering-platform-dns-settings-soa-schema.json Raw ↑
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "#/components/schemas/dns-settings_soa",
  "title": "dns-settings_soa",
  "description": "Components of the zone's SOA record.",
  "properties": {
    "expire": {
      "description": "Time in seconds of being unable to query the primary server after which secondary servers should stop serving the zone.",
      "example": 604800,
      "maximum": 2419200.0,
      "minimum": 86400,
      "type": "number"
    },
    "min_ttl": {
      "description": "The time to live (TTL) for negative caching of records within the zone.",
      "example": 1800,
      "maximum": 86400,
      "minimum": 60,
      "type": "number"
    },
    "mname": {
      "description": "The primary nameserver, which may be used for outbound zone transfers.",
      "example": "kristina.ns.cloudflare.com",
      "type": "string"
    },
    "refresh": {
      "description": "Time in seconds after which secondary servers should re-check the SOA record to see if the zone has been updated.",
      "example": 10000,
      "maximum": 86400,
      "minimum": 600,
      "type": "number"
    },
    "retry": {
      "description": "Time in seconds after which secondary servers should retry queries after the primary server was unresponsive.",
      "example": 2400,
      "maximum": 86400,
      "minimum": 600,
      "type": "number"
    },
    "rname": {
      "description": "The email address of the zone administrator, with the first label representing the local part of the email address.",
      "example": "admin.example.com",
      "type": "string"
    },
    "ttl": {
      "description": "The time to live (TTL) of the SOA record itself.",
      "example": 3600,
      "maximum": 86400,
      "minimum": 300,
      "type": "number"
    }
  },
  "required": [
    "mname",
    "rname",
    "refresh",
    "retry",
    "expire",
    "min_ttl",
    "ttl"
  ],
  "type": "object"
}