ManagedDNSView

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "https://artifacts.apis.io/customdomain-ai/json-schema/customdomain-ai-managed-dnsview-schema.json",
  "title": "ManagedDNSView",
  "x-generated": "2026-11-10",
  "x-method": "derived",
  "x-generator": "derive-json-schema.py",
  "x-source": "openapi/customdomain-ai-managed-dns-api-openapi.yml#/components/schemas/ManagedDNSView",
  "type": "object",
  "required": [
    "zone",
    "status",
    "nameservers",
    "observed_nameservers",
    "registrar",
    "records",
    "warnings",
    "checked_at",
    "activated_at"
  ],
  "properties": {
    "zone": {
      "type": "string",
      "description": "The hosted zone: the registrable domain."
    },
    "status": {
      "type": "string",
      "enum": [
        "awaiting_delegation",
        "active",
        "failed"
      ],
      "description": "`awaiting_delegation`: the zone holds the records; set the nameservers below at the registrar. `active`: every nameserver the registry lists is ours. `failed`: the switch never happened within 14 days, or the nameservers moved away again (the first warning says which); a failed zone keeps being checked and turns active once the delegation appears."
    },
    "nameservers": {
      "type": "array",
      "items": {
        "type": "string"
      },
      "description": "The nameservers to set at the registrar."
    },
    "observed_nameservers": {
      "type": "array",
      "items": {
        "type": "string"
      },
      "description": "The nameservers the registry listed at the last check."
    },
    "registrar": {
      "description": "The domain's registrar from RDAP, or null when unknown.",
      "oneOf": [
        {
          "type": "object",
          "required": [
            "name",
            "url"
          ],
          "properties": {
            "name": {
              "type": "string"
            },
            "url": {
              "type": "string",
              "description": "The registrar's website, or an empty string."
            }
          }
        },
        {
          "type": "null"
        }
      ]
    },
    "records": {
      "type": "array",
      "items": {
        "$ref": "#/$defs/ManagedDNSRecord"
      }
    },
    "warnings": {
      "type": "array",
      "items": {
        "type": "string"
      },
      "description": "Plain-language notes for the user (a partial delegation, records a zone file import skipped, records replaced)."
    },
    "checked_at": {
      "type": "string",
      "format": "date-time",
      "description": "When the delegation was last checked."
    },
    "activated_at": {
      "type": [
        "string",
        "null"
      ],
      "format": "date-time"
    }
  },
  "$defs": {
    "ManagedDNSRecord": {
      "type": "object",
      "required": [
        "id",
        "type",
        "name",
        "value",
        "ttl",
        "priority",
        "source"
      ],
      "properties": {
        "id": {
          "type": "string",
          "description": "Stable id derived from the record content."
        },
        "type": {
          "type": "string",
          "enum": [
            "A",
            "AAAA",
            "CNAME",
            "MX",
            "TXT",
            "SRV",
            "CAA",
            "NS"
          ]
        },
        "name": {
          "type": "string",
          "description": "Fully qualified owner name, lower case (\"acme.com\" is the apex, \"*.acme.com\" a wildcard)."
        },
        "value": {
          "type": "string",
          "description": "A/AAAA: the address. CNAME/NS/MX: the target host (\".\" for a null MX). TXT: the text. SRV: \"<weight> <port> <target>\". CAA: `<flags> <tag> \"<value>\"`."
        },
        "ttl": {
          "type": "integer",
          "description": "Seconds."
        },
        "priority": {
          "type": [
            "integer",
            "null"
          ],
          "description": "MX preference or SRV priority; null for other types."
        },
        "source": {
          "type": "string",
          "enum": [
            "discovered",
            "imported",
            "customdomain",
            "manual"
          ],
          "description": "Where the record came from. `customdomain` records are the ones CustomDomain™ needs for connected domains; they win every conflict and can't be removed here."
        }
      }
    }
  }
}