{
  "openapi": "3.1.1",
  "info": {
    "title": "Zone and record management API",
    "description": "Manage DigiCert DNS zones and the records in them. Create primary and secondary zones,\nmanage their record sets, and check DNS health. You can also set up DNSSEC, zone transfers,\nand DNS settings, take zone snapshots, and run reports. Each request acts on the account that owns\nthe API key, so account IDs never appear in the path.\n",
    "version": "2.0.0"
  },
  "servers": [
    {
      "url": "https://api.dns.digicert.com/v1",
      "description": "Production"
    }
  ],
  "security": [
    {
      "apiKey": []
    }
  ],
  "tags": [
    {
      "name": "Zones",
      "description": "A zone is a domain whose DNS records DigiCert DNS serves. Create,\nlist, update, and delete zones, convert a secondary zone to primary,\nrefresh a secondary zone, and export zones as BIND zone files.\n"
    },
    {
      "name": "Nameservers",
      "description": "A zone's nameservers are the DigiCert nameservers that answer for it.\nGet them with their IP addresses, and check whether the zone is\ndelegated to them at its registrar.\n"
    },
    {
      "name": "Inbound IP Sets",
      "description": "An Inbound IP Set is a named list of the primary nameservers that a\nsecondary zone transfers its records from, plus the addresses allowed\nto send it DNS `NOTIFY` messages. You define a set once in your\naccount and use it for any number of secondary zones. Create, list,\nget, update, and delete Inbound IP Sets.\n"
    },
    {
      "name": "Outbound IP Sets",
      "description": "An Outbound IP Set is a named list of the addresses allowed to\ntransfer a primary zone from DigiCert DNS, plus the servers that get a\nDNS `NOTIFY` message when the zone changes. Use one when another DNS\nprovider runs secondary nameservers for your primary zones. You\nchoose the TSIG key for each zone that uses the set, not in the set\nitself. Create, list, get, update, and delete Outbound IP Sets.\n"
    },
    {
      "name": "Nameserver Sets",
      "description": "A Nameserver Set is a named list of the authoritative nameservers\nthat serve your primary zones. One set can be your account's default,\nwhich new primary zones use when you don't name a set. Changing the\ndefault doesn't move existing zones to the new default set. Create,\nlist, get, update, and delete Nameserver Sets.\n"
    },
    {
      "name": "TSIG Keys",
      "description": "A TSIG key is a shared secret that signs zone transfers (AXFR and\nIXFR) so that each server can check the other is who it claims to be.\nSecondary zones and Outbound IP Set bindings on primary zones use a\nTSIG key by name, and a zone transfer import uses it by ID. You set\nits secret when you create or update it, and the API never returns\nit; reads show only a masked preview. Create, list, get, update, and\ndelete TSIG keys.\n"
    },
    {
      "name": "RRSets",
      "description": "A record set is all the records in a zone with the same owner name\nand record type, such as the `A` records for `www.example.com.`. They\nshare one TTL. Create, list, update, and delete record sets, import\nrecords from a BIND zone file, and manage regional record sets and\nregion exclusions.\n"
    },
    {
      "name": "DNS Health",
      "description": "DNS Health checks compare what DigiCert DNS holds for a zone with\nwhat DNS actually serves for it. Get an overall health status for a\nprimary or secondary zone, then look at the detail behind it: the SOA\nvalues that each delegated nameserver reports and the zone's recent\nzone transfers. A separate check compares the zone's DNSSEC DS records\nwith the ones published in the parent zone.\n"
    },
    {
      "name": "Async Tasks",
      "description": "A task tracks an operation that takes too long to finish within one\nrequest, such as a zone import, export, or transfer. The operation\nreturns `202 Accepted` with a `Location` header that points to the\ntask at `/tasks/async/{taskId}`. Poll the task until its status is\n`SUCCEEDED` or `FAILED`. You can also list your tasks\nand delete one that has finished.\n"
    },
    {
      "name": "Reports",
      "description": "Usage reports show how much DNS query traffic and how many resources\nyour account uses, and entitlements show what your account is allowed\nto use. Get monthly usage, a month-to-date usage summary, and your\nentitlements right away. A query volume report per zone takes longer,\nso you request it, poll its task, and then get the results.\n"
    },
    {
      "name": "DNS Settings",
      "description": "DNS settings that apply to your whole account. Get and update your\naccount's default SOA record values: `refresh`, `retry`, `expire`,\n`minimumCache`, `ttl`, `soaContactEmail`, and `primaryNameServer`.\n"
    },
    {
      "name": "DNSSEC",
      "description": "DNSSEC signs a zone's records so that resolvers can check they're\nauthentic. Sign a zone with your account's default DNSSEC policy, get\nits signing status, keys, and DS records, and unsign it. Signing and\nunsigning finish before the API responds.\n"
    },
    {
      "name": "Audit",
      "description": "The audit log records the DNS configuration changes made in your\naccount: who made each change, when, and to what. List audit records,\nfiltered by user, change type, object, date range, or comment text,\nas JSON or CSV. You can also get the accounts, users, object types,\nand change types that appear in your audit log.\n"
    },
    {
      "name": "Snapshots",
      "description": "A snapshot is a point-in-time copy of a primary zone's record sets.\nRestore the zone from a snapshot to go back to that state.\nCreate, list, get, and delete snapshots, and restore a zone from one.\nCreating and restoring a snapshot run as tasks. You can only take a\nsnapshot of a primary zone that isn't signed or suspended and has\n50,000 records or fewer.\n"
    },
    {
      "name": "Batch",
      "description": "A batch request sends several create, update, and delete requests,\ncalled sub-requests, in one call. Get each sub-request's result in the\nresponse, or run the batch request as a task and poll for the outcome.\nTo read several resources in one call, send a batch read request.\n"
    },
    {
      "name": "Integrations",
      "description": "An integration connects your DigiCert DNS account to another\nservice, such as CertCentral for domain control validation (DCV) or\nValimail Monitor. Link, update, and unlink an integration, and check\nits status. These operations finish before the API responds.\n"
    }
  ],
  "paths": {
    "/zones": {
      "get": {
        "operationId": "listZones",
        "x-required-permission": "account.zones:read",
        "summary": "List zones",
        "description": "Returns the zones in your account, one page at a time. `PRIMARY`\nand `SECONDARY` zones share one list. Use `type` to list one kind.\nUse the filters to narrow the list, and `sortBy` and `sortOrder` to\norder it.\n\n**Pagination**\n\nPage tokens are opaque. Don't parse or build `pageToken` values.\n\n- To get the next page, pass `pagination.nextPageToken` while\n  `pagination.hasMore` is `true`.\n- To get the previous page, pass `pagination.prevPageToken` when\n  it's present.\n- To get the first page, omit `pageToken` or pass\n  `pagination.firstPageToken` when it's present.\n- To get the last page, pass `pagination.lastPageToken` when it's\n  present.\n\n**Filters**\n\n- `type` and `status` apply to both zone types.\n- `name` matches part of the zone name. For `SECONDARY` zones, it\n  matches the start of the name only.\n- `nameserverSetName` matches the display name of a `PRIMARY`\n  zone's Nameserver Set.\n- `outboundIpSetName` matches any Outbound IP Set in\n  `primary.outboundIps`. It applies to `PRIMARY` zones.\n- `inboundIpSetName` matches the Inbound IP Set of a `SECONDARY`\n  zone.\n- `tsigKeyName` matches `secondary.tsigKeyName` on `SECONDARY`\n  zones, and any `tsigKeyName` in `primary.outboundIps` on\n  `PRIMARY` zones.\n- `lastTransferStatus` matches the status of a `SECONDARY` zone's\n  most recent transfer.\n- `isDnssecEnabled` matches the DNSSEC state of both zone types.\n- `recordCount` matches a range of record counts, for example\n  `recordCount[gte]=10&recordCount[lte]=500`.\n- `isCertCentralEnabled`, `isValimailEnabled`, and\n  `isRegionalViewEnabled` match the integration state of `PRIMARY`\n  zones.\n\n**Sorting**\n\nBy default, zones are sorted by `name` in ascending order.\n`sortOrder` also applies to the default, so `sortOrder=desc` on its\nown is the same as `sortBy=name&sortOrder=desc`. You can sort by:\n\n- `name`, `recordCount`, or `status`, for both zone types. `status`\n  sorts alphabetically by value.\n- A bound set's display name: `nameserverSetName`,\n  `outboundIpSetName`, `inboundIpSetName`, or `tsigKeyName`. For\n  `PRIMARY` zones, `outboundIpSetName` and `tsigKeyName` use the\n  first entry in `primary.outboundIps`. For `SECONDARY` zones,\n  `tsigKeyName` uses `secondary.tsigKeyName`.\n- `lastTransferStatus` or `lastTransferAt`, for `SECONDARY` zones.\n  `lastTransferStatus` sorts alphabetically by value. `PRIMARY`\n  zones have no value for either key. For `lastTransferAt`,\n  `SECONDARY` zones without a completed transfer also have no\n  value, and zones without a value sort first in ascending order.\n- `isDnssecEnabled`, `isCertCentralEnabled`, `isValimailEnabled`,\n  or `isRegionalViewEnabled`.\n\n**Statistics**\n\nSet `includeStats=true` to add a `stats` object with the `total`,\n`primary`, `secondary`, and `dnssec` zone counts. Only the `name`\nfilter applies to these counts. Other filters, such as `type`,\n`status`, and `isDnssecEnabled`, don't change them.\n",
        "tags": [
          "Zones"
        ],
        "parameters": [
          {
            "$ref": "#/components/parameters/pageToken"
          },
          {
            "$ref": "#/components/parameters/pageSizeLarge"
          },
          {
            "$ref": "#/components/parameters/ZoneType"
          },
          {
            "$ref": "#/components/parameters/ZoneStatus"
          },
          {
            "$ref": "#/components/parameters/ZoneQuery"
          },
          {
            "$ref": "#/components/parameters/ZoneNameserverSetName"
          },
          {
            "$ref": "#/components/parameters/ZoneInboundIpSetName"
          },
          {
            "$ref": "#/components/parameters/ZoneOutboundIpSetName"
          },
          {
            "$ref": "#/components/parameters/ZoneTsigKeyName"
          },
          {
            "$ref": "#/components/parameters/ZoneLastTransferStatus"
          },
          {
            "$ref": "#/components/parameters/ZoneIncludeStats"
          },
          {
            "$ref": "#/components/parameters/ZoneIsDnssecEnabled"
          },
          {
            "$ref": "#/components/parameters/ZoneIsCertCentralEnabled"
          },
          {
            "$ref": "#/components/parameters/ZoneIsValimailEnabled"
          },
          {
            "$ref": "#/components/parameters/ZoneIsRegionalViewEnabled"
          },
          {
            "$ref": "#/components/parameters/ZoneRecordCount"
          },
          {
            "$ref": "#/components/parameters/ZoneSortBy"
          },
          {
            "$ref": "#/components/parameters/ZoneSortOrder"
          },
          {
            "$ref": "#/components/parameters/XRequestId"
          }
        ],
        "responses": {
          "200": {
            "description": "A page of zones.",
            "headers": {
              "X-Request-Id": {
                "$ref": "#/components/headers/XRequestId"
              },
              "X-RateLimit-Limit": {
                "$ref": "#/components/headers/XRateLimitLimit"
              },
              "X-RateLimit-Remaining": {
                "$ref": "#/components/headers/XRateLimitRemaining"
              },
              "X-RateLimit-Reset": {
                "$ref": "#/components/headers/XRateLimitReset"
              }
            },
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ZoneList"
                },
                "examples": {
                  "primaryZones": {
                    "summary": "Primary zones with stats (includeStats=true)",
                    "value": {
                      "data": [
                        {
                          "name": "example.com.",
                          "type": "PRIMARY",
                          "status": "ACTIVE",
                          "advancedConfig": {
                            "isCertCentralEnabled": true,
                            "isValimailEnabled": true,
                            "isRegionalViewEnabled": false
                          },
                          "primary": {
                            "nameserverSetName": "Nameserver set 1",
                            "outboundIps": [
                              {
                                "outboundIpSetName": "secondary-provider-a",
                                "tsigKeyName": "outbound-tsig"
                              }
                            ]
                          },
                          "isDnssecEnabled": false,
                          "recordCount": 10,
                          "createdAt": "2026-05-20T10:00:00Z",
                          "updatedAt": "2026-05-20T10:00:00Z"
                        }
                      ],
                      "stats": {
                        "total": 450,
                        "primary": 400,
                        "secondary": 50,
                        "dnssec": 120
                      },
                      "pagination": {
                        "hasMore": true,
                        "nextPageToken": "eyJsYXN0TmFtZSI6ImV4YW1wbGUuY29tLiJ9",
                        "prevPageToken": null,
                        "firstPageToken": null,
                        "lastPageToken": "eyJwYWdlIjoibGFzdCJ9"
                      }
                    }
                  },
                  "primaryZonesNoStats": {
                    "summary": "Primary zones without stats (includeStats=false)",
                    "value": {
                      "data": [
                        {
                          "name": "example.com.",
                          "type": "PRIMARY",
                          "status": "ACTIVE",
                          "advancedConfig": {
                            "isCertCentralEnabled": true,
                            "isValimailEnabled": true,
                            "isRegionalViewEnabled": false
                          },
                          "primary": {
                            "nameserverSetName": "Nameserver set 1",
                            "outboundIps": [
                              {
                                "outboundIpSetName": "secondary-provider-a",
                                "tsigKeyName": "outbound-tsig"
                              }
                            ]
                          },
                          "isDnssecEnabled": false,
                          "recordCount": 10,
                          "createdAt": "2026-05-20T10:00:00Z",
                          "updatedAt": "2026-05-20T10:00:00Z"
                        }
                      ],
                      "pagination": {
                        "hasMore": true,
                        "nextPageToken": "eyJsYXN0TmFtZSI6ImV4YW1wbGUuY29tLiJ9",
                        "prevPageToken": null,
                        "firstPageToken": null,
                        "lastPageToken": "eyJwYWdlIjoibGFzdCJ9"
                      }
                    }
                  },
                  "sortedByNameserverSetName": {
                    "summary": "Primary zones sorted by nameserverSetName (sortBy=nameserverSetName&sortOrder=asc)",
                    "description": "Result of `GET /zones?type=PRIMARY&sortBy=nameserverSetName&sortOrder=asc`.\nZones are ordered alphabetically by their bound Nameserver\nSet display name (`primary.nameserverSetName`), not by zone\n`name`.\n",
                    "value": {
                      "data": [
                        {
                          "name": "alpha.example.com.",
                          "type": "PRIMARY",
                          "status": "ACTIVE",
                          "primary": {
                            "nameserverSetName": "Nameserver set 1",
                            "outboundIps": [
                              {
                                "outboundIpSetName": "secondary-provider-a",
                                "tsigKeyName": "outbound-tsig"
                              }
                            ]
                          },
                          "isDnssecEnabled": false,
                          "recordCount": 12,
                          "createdAt": "2026-05-20T10:00:00Z",
                          "updatedAt": "2026-05-20T10:00:00Z"
                        },
                        {
                          "name": "beta.example.com.",
                          "type": "PRIMARY",
                          "status": "ACTIVE",
                          "primary": {
                            "nameserverSetName": "Nameserver set 2",
                            "outboundIps": [
                              {
                                "outboundIpSetName": "secondary-provider-b",
                                "tsigKeyName": null
                              }
                            ]
                          },
                          "isDnssecEnabled": false,
                          "recordCount": 4,
                          "createdAt": "2026-05-18T09:00:00Z",
                          "updatedAt": "2026-05-19T09:00:00Z"
                        }
                      ],
                      "pagination": {
                        "hasMore": false,
                        "nextPageToken": null,
                        "prevPageToken": null,
                        "firstPageToken": null,
                        "lastPageToken": null
                      }
                    }
                  },
                  "secondaryZones": {
                    "summary": "Secondary zones list",
                    "value": {
                      "data": [
                        {
                          "name": "secondary.example.com.",
                          "type": "SECONDARY",
                          "status": "ACTIVE",
                          "isDnssecEnabled": false,
                          "recordCount": 5,
                          "transferDetails": {
                            "lastTransferStatus": "SUCCEEDED",
                            "lastTransferAt": "2026-05-20T09:00:00Z",
                            "nextTransferAt": "2026-05-20T15:00:00Z",
                            "lastTransferStatusMessage": null
                          },
                          "secondary": {
                            "inboundIpSetName": "upstream-prod-ns",
                            "tsigKeyName": "primary-key"
                          },
                          "createdAt": "2026-05-19T08:00:00Z",
                          "updatedAt": "2026-05-20T09:00:00Z"
                        }
                      ],
                      "stats": {
                        "total": 450,
                        "primary": 400,
                        "secondary": 50,
                        "dnssec": 120
                      },
                      "pagination": {
                        "hasMore": false,
                        "nextPageToken": null,
                        "prevPageToken": null,
                        "firstPageToken": null,
                        "lastPageToken": null
                      }
                    }
                  },
                  "emptyResult": {
                    "summary": "No zones match the filter",
                    "value": {
                      "data": [],
                      "stats": {
                        "total": 0,
                        "primary": 0,
                        "secondary": 0,
                        "dnssec": 0
                      },
                      "pagination": {
                        "hasMore": false,
                        "nextPageToken": null,
                        "prevPageToken": null,
                        "firstPageToken": null,
                        "lastPageToken": null
                      }
                    }
                  }
                }
              }
            }
          },
          "400": {
            "$ref": "#/components/responses/BadRequest"
          },
          "401": {
            "$ref": "#/components/responses/Unauthorized"
          },
          "403": {
            "$ref": "#/components/responses/Forbidden"
          },
          "429": {
            "$ref": "#/components/responses/TooManyRequests"
          },
          "500": {
            "$ref": "#/components/responses/InternalServerError"
          },
          "502": {
            "$ref": "#/components/responses/BadGateway"
          },
          "503": {
            "$ref": "#/components/responses/ServiceUnavailable"
          },
          "504": {
            "$ref": "#/components/responses/GatewayTimeout"
          }
        }
      },
      "post": {
        "operationId": "createZone",
        "x-required-permission": "account.zones:create",
        "summary": "Create a zone",
        "description": "Creates a `PRIMARY` or `SECONDARY` zone in your account. The `type`\nfield in the request body decides which other fields apply.\n\nZone names are unique within an account, and invalid zone names\nare rejected. Creating a zone that already exists returns\n`409 Conflict`.\n\nTo retry safely after a dropped connection, resend the request with\nthe same `Idempotency-Key`. If the first attempt has finished, you\nget its original response. If it's still running, you get\n`409 Conflict`.\n\n**Immediate or background creation**\n\n- A `PRIMARY` zone with `recordImport.method` set to `NONE` is\n  created immediately. The response is `201 Created`, with the zone\n  in the body.\n- A `PRIMARY` zone with `recordImport.method` set to `AXFR`,\n  `EXISTING_ZONE`, or `ZONE_FILE` starts an import task. The\n  response is `202 Accepted`, with a `Location` header that points\n  to an `AsyncTask`. Poll the task for progress and the result.\n- A `SECONDARY` zone always returns `202 Accepted`, because its\n  first zone transfer (AXFR) from the upstream nameserver runs in\n  the background.\n\n**Initial status**\n\nA `PRIMARY` zone can start as `ACTIVE`, the default, or `DISABLED`.\nSet `status` in the request to choose. A `SECONDARY` zone always\nstarts as `ACTIVE`. `SUSPENDED` isn't accepted when you create a\nzone.\n\n**Nameserver Set**\n\nFor a `PRIMARY` zone, `primary.nameserverSetName` is:\n\n- Optional when `primary.recordImport.method` is `NONE`. If you\n  omit it, the zone uses your account's default Nameserver Set, if\n  one is configured.\n- Required when `primary.recordImport.method` is `EXISTING_ZONE`,\n  `AXFR`, or `ZONE_FILE`. If it's missing, the request returns\n  `400 Bad Request`, and no zone or import task is created.\n\n**Import from the parent zone**\n\n`recordImport.isImportFromParent` applies only to `PRIMARY` zones\nwith `recordImport.method` set to `NONE`. Otherwise, it's ignored.\n",
        "tags": [
          "Zones"
        ],
        "parameters": [
          {
            "$ref": "#/components/parameters/IdempotencyKey"
          },
          {
            "$ref": "#/components/parameters/XRequestId"
          }
        ],
        "requestBody": {
          "required": true,
          "description": "The zone to create. `type` selects the `PRIMARY` or `SECONDARY`\nrequest fields.\n\nTo import a BIND zone file (`ZONE_FILE`), send the request as\n`multipart/form-data` with 2 parts: `zone`, the JSON request\nbody, and `file`, the zone file. All other requests use\n`application/json`.\n",
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/CreateZoneRequest"
              },
              "examples": {
                "primaryNone": {
                  "summary": "Primary zone with NONE import",
                  "value": {
                    "type": "PRIMARY",
                    "zoneName": "example.com",
                    "status": "ACTIVE",
                    "reason": "Onboarding ecomm zone",
                    "advancedConfig": {
                      "isCertCentralEnabled": false,
                      "isValimailEnabled": true,
                      "isRegionalViewEnabled": false
                    },
                    "primary": {
                      "nameserverSetName": "prod-ns",
                      "outboundIps": [
                        {
                          "outboundIpSetName": "secondary-provider-a",
                          "tsigKeyName": "outbound-tsig"
                        }
                      ],
                      "recordImport": {
                        "method": "NONE",
                        "isImportFromParent": true
                      }
                    }
                  }
                },
                "primaryMultipleOutboundSets": {
                  "summary": "Primary zone bound to multiple Outbound IP Sets",
                  "value": {
                    "type": "PRIMARY",
                    "zoneName": "example.com",
                    "status": "ACTIVE",
                    "reason": "Onboarding ecomm zone with redundant transfer targets",
                    "primary": {
                      "nameserverSetName": "prod-ns",
                      "outboundIps": [
                        {
                          "outboundIpSetName": "secondary-provider-a",
                          "tsigKeyName": "outbound-tsig"
                        },
                        {
                          "outboundIpSetName": "secondary-provider-b",
                          "tsigKeyName": null
                        }
                      ],
                      "recordImport": {
                        "method": "NONE",
                        "isImportFromParent": true
                      }
                    }
                  }
                },
                "primaryCopyZone": {
                  "summary": "Primary zone with EXISTING_ZONE import",
                  "value": {
                    "type": "PRIMARY",
                    "zoneName": "example.com",
                    "advancedConfig": {
                      "isValimailEnabled": true
                    },
                    "primary": {
                      "nameserverSetName": "prod-ns",
                      "recordImport": {
                        "method": "EXISTING_ZONE",
                        "existingZone": {
                          "zoneName": "template.example.com"
                        }
                      }
                    }
                  }
                },
                "primaryAxfrWithTsig": {
                  "summary": "Primary zone with AXFR import",
                  "value": {
                    "type": "PRIMARY",
                    "zoneName": "example.com",
                    "reason": "ecomm zone",
                    "advancedConfig": {
                      "isValimailEnabled": true
                    },
                    "primary": {
                      "nameserverSetName": "prod-ns",
                      "recordImport": {
                        "method": "AXFR",
                        "axfr": {
                          "host": "192.0.2.10",
                          "tsigKeyId": "3f1c2d4e-5a6b-7c8d-9e0f-1a2b3c4d5e6f"
                        }
                      }
                    }
                  }
                },
                "secondaryZone": {
                  "summary": "Secondary zone",
                  "value": {
                    "type": "SECONDARY",
                    "zoneName": "example.com",
                    "secondary": {
                      "inboundIpSetName": "upstream-prod-ns",
                      "tsigKeyName": "primary-key"
                    }
                  }
                }
              }
            },
            "multipart/form-data": {
              "schema": {
                "type": "object",
                "description": "The request to create a `PRIMARY` zone from a BIND zone\nfile. Send the zone in the `zone` part and the zone file in\nthe `file` part.\n",
                "required": [
                  "zone",
                  "file"
                ],
                "properties": {
                  "file": {
                    "type": "string",
                    "format": "binary",
                    "description": "The BIND zone file."
                  },
                  "zone": {
                    "allOf": [
                      {
                        "$ref": "#/components/schemas/CreateZoneRequest"
                      }
                    ],
                    "description": "The zone to create, as JSON. Set `type` to `PRIMARY`\nand `primary.recordImport.method` to `ZONE_FILE`.\n"
                  }
                }
              },
              "encoding": {
                "file": {
                  "contentType": "text/plain"
                },
                "zone": {
                  "contentType": "application/json"
                }
              },
              "examples": {
                "primaryBindTextMultipart": {
                  "summary": "Primary zone from a BIND zone file, sent as multipart (returns 202 Accepted)",
                  "description": "`file` and `zone` are **separate multipart form parts**,\nnot one JSON request body.\n",
                  "value": {
                    "file": "(binary)",
                    "zone": {
                      "type": "PRIMARY",
                      "zoneName": "example.com",
                      "reason": "Import initial records from BIND zone file",
                      "primary": {
                        "nameserverSetName": "prod-ns",
                        "recordImport": {
                          "method": "ZONE_FILE"
                        }
                      }
                    }
                  }
                }
              }
            }
          }
        },
        "responses": {
          "201": {
            "description": "The zone was created. Returned only for `PRIMARY` zones with\n`recordImport.method` set to `NONE`. All other requests return\n`202 Accepted` with an `AsyncTask`. The `Location` header isn't\ncurrently returned with this response.\n",
            "headers": {
              "Location": {
                "$ref": "#/components/headers/Location"
              },
              "X-Request-Id": {
                "$ref": "#/components/headers/XRequestId"
              },
              "X-Idempotent-Replayed": {
                "$ref": "#/components/headers/XIdempotentReplayed"
              },
              "X-RateLimit-Limit": {
                "$ref": "#/components/headers/XRateLimitLimit"
              },
              "X-RateLimit-Remaining": {
                "$ref": "#/components/headers/XRateLimitRemaining"
              },
              "X-RateLimit-Reset": {
                "$ref": "#/components/headers/XRateLimitReset"
              }
            },
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/Zone"
                },
                "examples": {
                  "primaryCreated": {
                    "summary": "Primary zone created, no record import",
                    "value": {
                      "name": "example.com.",
                      "type": "PRIMARY",
                      "status": "ACTIVE",
                      "advancedConfig": {
                        "isCertCentralEnabled": true,
                        "isValimailEnabled": true,
                        "isRegionalViewEnabled": false
                      },
                      "primary": {
                        "nameserverSetName": "Nameserver set 1",
                        "outboundIps": [
                          {
                            "outboundIpSetName": "secondary-provider-a",
                            "tsigKeyName": "outbound-tsig"
                          }
                        ]
                      },
                      "createdAt": "2026-05-19T14:32:10Z",
                      "updatedAt": "2026-05-19T14:32:10Z"
                    }
                  }
                }
              }
            }
          },
          "202": {
            "description": "Zone creation was accepted and runs in the background. Returned\nfor every `SECONDARY` zone, and for `PRIMARY` zones with\n`recordImport.method` set to `AXFR`, `EXISTING_ZONE`, or\n`ZONE_FILE`. The body is the new task, and the `Location`\nheader points to it. Poll the task for progress and the result.\n\nFor `EXISTING_ZONE`, the source zone in `existingZone.zoneName`\nis checked before the request is accepted. If it doesn't exist,\nthe request returns `404 Not Found`. Errors during the copy are\nreported in the task: its `status` is `FAILED`, and `error`\nholds a `ProblemDetail`.\n",
            "headers": {
              "Location": {
                "$ref": "#/components/headers/Location"
              },
              "X-Request-Id": {
                "$ref": "#/components/headers/XRequestId"
              },
              "X-Idempotent-Replayed": {
                "$ref": "#/components/headers/XIdempotentReplayed"
              },
              "X-RateLimit-Limit": {
                "$ref": "#/components/headers/XRateLimitLimit"
              },
              "X-RateLimit-Remaining": {
                "$ref": "#/components/headers/XRateLimitRemaining"
              },
              "X-RateLimit-Reset": {
                "$ref": "#/components/headers/XRateLimitReset"
              }
            },
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/AsyncTask"
                },
                "examples": {
                  "existingZoneAccepted": {
                    "summary": "EXISTING_ZONE copy task representation",
                    "value": {
                      "id": "5b7d2c1a-3f8e-4a2c-9d1b-7f6e5a4c3b2a",
                      "status": "PENDING",
                      "type": "zone.records.import",
                      "submittedAt": "2026-06-03T16:45:06Z"
                    }
                  },
                  "axfrAccepted": {
                    "summary": "AXFR import task representation",
                    "value": {
                      "id": "8c1e9a4b-2d6f-4711-b3a8-1e2c7f9d8a4b",
                      "status": "PENDING",
                      "type": "zone.records.import",
                      "submittedAt": "2026-06-03T16:45:06Z"
                    }
                  },
                  "secondaryAccepted": {
                    "summary": "Secondary zone initial-AXFR task representation",
                    "value": {
                      "id": "3f1a7c29-88e4-4d2b-a501-9b3e6f7c1204",
                      "status": "PENDING",
                      "type": "zone.records.import",
                      "submittedAt": "2026-06-03T16:50:00Z"
                    }
                  }
                }
              }
            }
          },
          "400": {
            "$ref": "#/components/responses/BadRequest"
          },
          "401": {
            "$ref": "#/components/responses/Unauthorized"
          },
          "403": {
            "$ref": "#/components/responses/Forbidden"
          },
          "404": {
            "$ref": "#/components/responses/NotFound"
          },
          "409": {
            "$ref": "#/components/responses/Conflict"
          },
          "413": {
            "$ref": "#/components/responses/PayloadTooLarge"
          },
          "415": {
            "$ref": "#/components/responses/UnsupportedMediaType"
          },
          "422": {
            "$ref": "#/components/responses/UnprocessableEntity"
          },
          "429": {
            "$ref": "#/components/responses/TooManyRequests"
          },
          "500": {
            "$ref": "#/components/responses/InternalServerError"
          },
          "502": {
            "$ref": "#/components/responses/BadGateway"
          },
          "503": {
            "$ref": "#/components/responses/ServiceUnavailable"
          },
          "504": {
            "$ref": "#/components/responses/GatewayTimeout"
          }
        }
      }
    },
    "/zones/{zoneName}": {
      "description": "A single zone. Supports `GET`, `PATCH`, and `DELETE`.\n\n`PUT` isn't supported and returns `405 Method Not Allowed`. To change\na zone, send only the fields to change with `PATCH`. Replacing a whole\nzone would mean resending fields that DigiCert DNS manages, such as\n`type`, `status`, and `createdAt`, and could change its records.\nChanges that work like a replacement have their own operations:\n`:convert` and `:transfer`.\n",
      "parameters": [
        {
          "$ref": "#/components/parameters/ZoneName"
        }
      ],
      "get": {
        "operationId": "getZone",
        "x-required-permission": "account.zones:read",
        "summary": "Get a zone",
        "description": "Returns a zone and its zone-level settings, such as its status,\nDNSSEC state, integrations, and transfer configuration.\n\nIf the zone doesn't exist in your account, the request returns\n`404 Not Found`.\n",
        "tags": [
          "Zones"
        ],
        "parameters": [
          {
            "$ref": "#/components/parameters/XRequestId"
          }
        ],
        "responses": {
          "200": {
            "description": "The zone.",
            "headers": {
              "X-Request-Id": {
                "$ref": "#/components/headers/XRequestId"
              },
              "X-RateLimit-Limit": {
                "$ref": "#/components/headers/XRateLimitLimit"
              },
              "X-RateLimit-Remaining": {
                "$ref": "#/components/headers/XRateLimitRemaining"
              },
              "X-RateLimit-Reset": {
                "$ref": "#/components/headers/XRateLimitReset"
              }
            },
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/Zone"
                },
                "examples": {
                  "primaryZone": {
                    "summary": "Primary zone",
                    "value": {
                      "name": "example.com.",
                      "type": "PRIMARY",
                      "status": "ACTIVE",
                      "isDnssecEnabled": false,
                      "advancedConfig": {
                        "isCertCentralEnabled": true,
                        "isValimailEnabled": true,
                        "isRegionalViewEnabled": false
                      },
                      "primary": {
                        "nameserverSetName": "Nameserver set 1",
                        "outboundIps": [
                          {
                            "outboundIpSetName": "secondary-provider-a",
                            "tsigKeyName": "outbound-tsig"
                          }
                        ]
                      },
                      "recordCount": 10,
                      "createdAt": "2026-05-20T10:00:00Z",
                      "updatedAt": "2026-05-20T10:00:00Z"
                    }
                  },
                  "secondaryZone": {
                    "summary": "Secondary zone",
                    "value": {
                      "name": "secondary.example.com.",
                      "type": "SECONDARY",
                      "status": "ACTIVE",
                      "isDnssecEnabled": false,
                      "transferDetails": {
                        "lastTransferStatus": "IN_PROGRESS",
                        "lastTransferAt": null,
                        "nextTransferAt": "2026-05-19T14:00:00Z",
                        "lastTransferStatusMessage": "Transfer in progress"
                      },
                      "secondary": {
                        "inboundIpSetName": "upstream-prod-ns",
                        "tsigKeyName": "primary-key"
                      },
                      "recordCount": 5,
                      "createdAt": "2026-05-19T08:00:00Z",
                      "updatedAt": "2026-05-19T08:00:00Z"
                    }
                  }
                }
              }
            }
          },
          "401": {
            "$ref": "#/components/responses/Unauthorized"
          },
          "403": {
            "$ref": "#/components/responses/Forbidden"
          },
          "404": {
            "$ref": "#/components/responses/NotFound"
          },
          "429": {
            "$ref": "#/components/responses/TooManyRequests"
          },
          "500": {
            "$ref": "#/components/responses/InternalServerError"
          },
          "502": {
            "$ref": "#/components/responses/BadGateway"
          },
          "503": {
            "$ref": "#/components/responses/ServiceUnavailable"
          },
          "504": {
            "$ref": "#/components/responses/GatewayTimeout"
          }
        }
      },
      "patch": {
        "operationId": "updateZone",
        "x-required-permission": "account.zones:update",
        "summary": "Update a zone",
        "description": "Changes some of a zone's settings. Send only the fields to change,\nas a JSON object with `application/json`. Fields you omit stay\nunchanged. JSON Patch isn't supported.\n\nYou can change:\n\n- `status`. `PRIMARY` zones accept `ACTIVE`, `DISABLED`, and\n  `SUSPENDED`. `SECONDARY` zones accept `ACTIVE` and `SUSPENDED`.\n- Integrations in `advancedConfig`, such as CertCentral and\n  Valimail, on `PRIMARY` zones.\n- Transfer configuration in `primary` on `PRIMARY` zones, or in\n  `secondary` on `SECONDARY` zones.\n\nUpdating a zone never changes its records. Some settings have their\nown operations:\n\n- To sign a zone with DNSSEC, use `POST /zones/{zoneName}:dnssec`.\n  To unsign it, use `DELETE /zones/{zoneName}:dnssec`.\n- To change SOA values, update the zone's SOA record.\n\nSending a field that doesn't apply to the zone's type returns\n`422 Unprocessable Entity`.\n",
        "tags": [
          "Zones"
        ],
        "parameters": [
          {
            "$ref": "#/components/parameters/IdempotencyKey"
          },
          {
            "$ref": "#/components/parameters/XRequestId"
          }
        ],
        "requestBody": {
          "required": true,
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/ZoneUpdate"
              },
              "examples": {
                "disableZone": {
                  "summary": "Disable a zone (primary only)",
                  "value": {
                    "status": "DISABLED",
                    "reason": "Scheduled maintenance window"
                  }
                },
                "suspendZone": {
                  "summary": "Suspend a zone via PATCH",
                  "value": {
                    "status": "SUSPENDED",
                    "reason": "Billing policy action"
                  }
                },
                "enableCertCentral": {
                  "summary": "Enable CertCentral integration (primary zone)",
                  "value": {
                    "advancedConfig": {
                      "isCertCentralEnabled": true
                    },
                    "reason": "Onboarding managed certificates"
                  }
                },
                "toggleIntegrations": {
                  "summary": "Toggle multiple integrations (primary zone)",
                  "value": {
                    "advancedConfig": {
                      "isCertCentralEnabled": true,
                      "isValimailEnabled": false
                    },
                    "reason": "Switching DMARC provider"
                  }
                },
                "enableRegionalView": {
                  "summary": "Enable regional views (primary zone)",
                  "value": {
                    "advancedConfig": {
                      "isRegionalViewEnabled": true
                    },
                    "reason": "Enabling geo-targeted content delivery"
                  }
                },
                "updatePrimaryBinding": {
                  "summary": "Re-bind a primary zone's outbound sets and TSIG key",
                  "value": {
                    "primary": {
                      "nameserverSetName": "prod-ns",
                      "outboundIps": [
                        {
                          "outboundIpSetName": "secondary-provider-a",
                          "tsigKeyName": "outbound-tsig"
                        }
                      ]
                    },
                    "reason": "Updating outbound transfer configuration"
                  }
                },
                "updatePrimaryNameserverSet": {
                  "summary": "Re-bind a primary zone to a different Nameserver Set",
                  "value": {
                    "primary": {
                      "nameserverSetName": "prod-ns-2"
                    },
                    "reason": "Switching primary nameserver set"
                  }
                },
                "reEnableZone": {
                  "summary": "Re-enable a disabled zone",
                  "value": {
                    "status": "ACTIVE"
                  }
                },
                "updateSecondaryConfig": {
                  "summary": "Re-bind a secondary zone to a different Inbound IP Set",
                  "value": {
                    "secondary": {
                      "inboundIpSetName": "upstream-dr",
                      "tsigKeyName": "primary-key"
                    },
                    "reason": "Switching upstream provider"
                  }
                },
                "detachZoneTsig": {
                  "summary": "Detach TSIG from a secondary zone",
                  "value": {
                    "secondary": {
                      "inboundIpSetName": "upstream-dr",
                      "tsigKeyName": null
                    },
                    "reason": "Rotating upstream TSIG credentials"
                  }
                }
              }
            }
          }
        },
        "responses": {
          "200": {
            "description": "The updated zone.",
            "headers": {
              "X-Request-Id": {
                "$ref": "#/components/headers/XRequestId"
              },
              "X-Idempotent-Replayed": {
                "$ref": "#/components/headers/XIdempotentReplayed"
              },
              "X-RateLimit-Limit": {
                "$ref": "#/components/headers/XRateLimitLimit"
              },
              "X-RateLimit-Remaining": {
                "$ref": "#/components/headers/XRateLimitRemaining"
              },
              "X-RateLimit-Reset": {
                "$ref": "#/components/headers/XRateLimitReset"
              }
            },
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/Zone"
                },
                "examples": {
                  "primaryZoneUpdated": {
                    "summary": "Primary zone updated response",
                    "value": {
                      "name": "example.com.",
                      "type": "PRIMARY",
                      "status": "ACTIVE",
                      "advancedConfig": {
                        "isCertCentralEnabled": true,
                        "isValimailEnabled": false,
                        "isRegionalViewEnabled": false
                      },
                      "primary": {
                        "nameserverSetName": "Nameserver set 1",
                        "outboundIps": [
                          {
                            "outboundIpSetName": "secondary-provider-a",
                            "tsigKeyName": "outbound-tsig"
                          }
                        ]
                      },
                      "createdAt": "2026-05-20T10:00:00Z",
                      "updatedAt": "2026-06-18T11:00:00Z"
                    }
                  },
                  "secondaryZoneUpdated": {
                    "summary": "Secondary zone updated response",
                    "value": {
                      "name": "secondary.example.com.",
                      "type": "SECONDARY",
                      "status": "ACTIVE",
                      "transferDetails": {
                        "lastTransferStatus": "SUCCEEDED",
                        "lastTransferAt": "2026-06-18T10:30:00Z"
                      },
                      "secondary": {
                        "inboundIpSetName": "upstream-dr",
                        "tsigKeyName": "primary-key"
                      },
                      "createdAt": "2026-05-19T08:00:00Z",
                      "updatedAt": "2026-06-18T11:00:00Z"
                    }
                  }
                }
              }
            }
          },
          "400": {
            "$ref": "#/components/responses/BadRequest"
          },
          "401": {
            "$ref": "#/components/responses/Unauthorized"
          },
          "403": {
            "$ref": "#/components/responses/Forbidden"
          },
          "404": {
            "$ref": "#/components/responses/NotFound"
          },
          "409": {
            "$ref": "#/components/responses/Conflict"
          },
          "422": {
            "$ref": "#/components/responses/UnprocessableEntity"
          },
          "429": {
            "$ref": "#/components/responses/TooManyRequests"
          },
          "500": {
            "$ref": "#/components/responses/InternalServerError"
          },
          "502": {
            "$ref": "#/components/responses/BadGateway"
          },
          "503": {
            "$ref": "#/components/responses/ServiceUnavailable"
          },
          "504": {
            "$ref": "#/components/responses/GatewayTimeout"
          }
        }
      },
      "delete": {
        "operationId": "deleteZone",
        "x-required-permission": "account.zones:delete",
        "summary": "Delete a zone",
        "description": "Permanently deletes a zone, including its records and settings.\nDigiCert DNS stops serving the zone, and you can't retrieve it\nafterward. You can't undo a deletion.\n",
        "tags": [
          "Zones"
        ],
        "parameters": [
          {
            "$ref": "#/components/parameters/IdempotencyKeyOptional"
          },
          {
            "$ref": "#/components/parameters/XRequestId"
          }
        ],
        "requestBody": {
          "required": false,
          "content": {
            "application/json": {
              "schema": {
                "type": "object",
                "additionalProperties": false,
                "properties": {
                  "reason": {
                    "type": "string",
                    "maxLength": 512,
                    "description": "A comment to record in the audit log."
                  }
                }
              },
              "examples": {
                "withReason": {
                  "summary": "Delete with an audit comment",
                  "value": {
                    "reason": "Decommissioning zone after migration"
                  }
                }
              }
            }
          }
        },
        "responses": {
          "204": {
            "description": "The zone was deleted. The response has no body.",
            "headers": {
              "X-Request-Id": {
                "$ref": "#/components/headers/XRequestId"
              },
              "X-Idempotent-Replayed": {
                "$ref": "#/components/headers/XIdempotentReplayed"
              },
              "X-RateLimit-Limit": {
                "$ref": "#/components/headers/XRateLimitLimit"
              },
              "X-RateLimit-Remaining": {
                "$ref": "#/components/headers/XRateLimitRemaining"
              },
              "X-RateLimit-Reset": {
                "$ref": "#/components/headers/XRateLimitReset"
              }
            }
          },
          "401": {
            "$ref": "#/components/responses/Unauthorized"
          },
          "403": {
            "$ref": "#/components/responses/Forbidden"
          },
          "404": {
            "$ref": "#/components/responses/NotFound"
          },
          "409": {
            "$ref": "#/components/responses/Conflict"
          },
          "429": {
            "$ref": "#/components/responses/TooManyRequests"
          },
          "500": {
            "$ref": "#/components/responses/InternalServerError"
          },
          "502": {
            "$ref": "#/components/responses/BadGateway"
          },
          "503": {
            "$ref": "#/components/responses/ServiceUnavailable"
          },
          "504": {
            "$ref": "#/components/responses/GatewayTimeout"
          }
        }
      }
    },
    "/zones/{zoneName}:convert": {
      "parameters": [
        {
          "$ref": "#/components/parameters/ZoneName"
        }
      ],
      "post": {
        "operationId": "convertZone",
        "x-required-permission": "account.zones:update",
        "summary": "Convert a secondary zone to primary",
        "description": "Converts a `SECONDARY` zone to a `PRIMARY` zone. The zone keeps the\nrecords from its most recent transfer, and from then on you manage\nthose records in DigiCert DNS. Conversion to `PRIMARY` is the only\nconversion available.\n",
        "tags": [
          "Zones"
        ],
        "parameters": [
          {
            "$ref": "#/components/parameters/IdempotencyKey"
          },
          {
            "$ref": "#/components/parameters/XRequestId"
          }
        ],
        "requestBody": {
          "required": true,
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/ZoneConvertRequest"
              },
              "examples": {
                "convertToPrimary": {
                  "summary": "Convert a secondary zone to primary",
                  "value": {
                    "targetType": "PRIMARY",
                    "reason": "Promote secondary to platform-managed primary"
                  }
                }
              }
            }
          }
        },
        "responses": {
          "200": {
            "description": "The converted zone.",
            "headers": {
              "X-Request-Id": {
                "$ref": "#/components/headers/XRequestId"
              },
              "X-Idempotent-Replayed": {
                "$ref": "#/components/headers/XIdempotentReplayed"
              },
              "X-RateLimit-Limit": {
                "$ref": "#/components/headers/XRateLimitLimit"
              },
              "X-RateLimit-Remaining": {
                "$ref": "#/components/headers/XRateLimitRemaining"
              },
              "X-RateLimit-Reset": {
                "$ref": "#/components/headers/XRateLimitReset"
              }
            },
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/Zone"
                }
              }
            }
          },
          "400": {
            "$ref": "#/components/responses/BadRequest"
          },
          "401": {
            "$ref": "#/components/responses/Unauthorized"
          },
          "403": {
            "$ref": "#/components/responses/Forbidden"
          },
          "404": {
            "$ref": "#/components/responses/NotFound"
          },
          "409": {
            "$ref": "#/components/responses/Conflict"
          },
          "422": {
            "$ref": "#/components/responses/UnprocessableEntity"
          },
          "429": {
            "$ref": "#/components/responses/TooManyRequests"
          },
          "500": {
            "$ref": "#/components/responses/InternalServerError"
          },
          "502": {
            "$ref": "#/components/responses/BadGateway"
          },
          "503": {
            "$ref": "#/components/responses/ServiceUnavailable"
          },
          "504": {
            "$ref": "#/components/responses/GatewayTimeout"
          }
        }
      }
    },
    "/zones/{zoneName}:transfer": {
      "parameters": [
        {
          "$ref": "#/components/parameters/ZoneName"
        }
      ],
      "post": {
        "operationId": "requestZoneTransfer",
        "x-required-permission": "account.zones:update",
        "summary": "Refresh a secondary zone",
        "description": "Starts a zone transfer (AXFR) from the upstream primary nameservers\nto refresh a `SECONDARY` zone's records. The transfer runs in the\nbackground. The response is `202 Accepted`, with a `Location`\nheader that points to an `AsyncTask`. Poll the task for the result.\n\n**Requirements**\n\n- The zone must be a `SECONDARY` zone. For a `PRIMARY` zone, the\n  request returns `422 Unprocessable Entity`.\n- If a transfer for the zone is already `PENDING` or `RUNNING`,\n  the request returns `409 Conflict` and doesn't start another.\n\n**Results**\n\n- `SUCCEEDED`: the zone's records are replaced with the transferred\n  records. The task's `result` is the refreshed zone, in the same\n  form as `GET /zones/{zoneName}`, and `resourceUrl` points to it.\n- `FAILED`: the task's `error` holds a `ProblemDetail` that\n  describes the cause. Common causes are an unreachable upstream\n  nameserver, a refused transfer because of an access control list\n  (ACL) or Transaction Signature (TSIG) key mismatch, a zone that's\n  too large, an SOA serial number lower than the current one, and\n  errors parsing the transferred zone.\n",
        "tags": [
          "Zones"
        ],
        "parameters": [
          {
            "$ref": "#/components/parameters/IdempotencyKey"
          },
          {
            "$ref": "#/components/parameters/XRequestId"
          }
        ],
        "requestBody": {
          "required": false,
          "content": {
            "application/json": {
              "schema": {
                "type": "object",
                "additionalProperties": false
              }
            }
          }
        },
        "responses": {
          "202": {
            "description": "The transfer was accepted and runs in the background. The\n`Location` header points to the task. Poll it for the result.\n",
            "headers": {
              "Location": {
                "$ref": "#/components/headers/Location"
              },
              "X-Request-Id": {
                "$ref": "#/components/headers/XRequestId"
              },
              "X-Idempotent-Replayed": {
                "$ref": "#/components/headers/XIdempotentReplayed"
              },
              "X-RateLimit-Limit": {
                "$ref": "#/components/headers/XRateLimitLimit"
              },
              "X-RateLimit-Remaining": {
                "$ref": "#/components/headers/XRateLimitRemaining"
              },
              "X-RateLimit-Reset": {
                "$ref": "#/components/headers/XRateLimitReset"
              }
            },
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/AsyncTask"
                },
                "examples": {
                  "accepted": {
                    "summary": "Zone transfer task representation",
                    "value": {
                      "id": "550e8400-e29b-41d4-a716-446655440000",
                      "status": "PENDING",
                      "type": "zone.transfer",
                      "submittedAt": "2026-06-05T14:00:00Z"
                    }
                  }
                }
              }
            }
          },
          "400": {
            "$ref": "#/components/responses/BadRequest"
          },
          "401": {
            "$ref": "#/components/responses/Unauthorized"
          },
          "403": {
            "$ref": "#/components/responses/Forbidden"
          },
          "404": {
            "$ref": "#/components/responses/NotFound"
          },
          "409": {
            "$ref": "#/components/responses/Conflict"
          },
          "422": {
            "$ref": "#/components/responses/UnprocessableEntity"
          },
          "429": {
            "$ref": "#/components/responses/TooManyRequests"
          },
          "500": {
            "$ref": "#/components/responses/InternalServerError"
          },
          "502": {
            "$ref": "#/components/responses/BadGateway"
          },
          "503": {
            "$ref": "#/components/responses/ServiceUnavailable"
          },
          "504": {
            "$ref": "#/components/responses/GatewayTimeout"
          }
        }
      }
    },
    "/zones/{zoneName}/health": {
      "parameters": [
        {
          "$ref": "#/components/parameters/ZoneName"
        }
      ],
      "get": {
        "operationId": "getZoneHealth",
        "x-required-permission": "account.zones:read",
        "summary": "Get zone health",
        "description": "Compares what DigiCert DNS holds for the zone with what DNS serves\nfor it. Returns an overall `healthStatus` and the result of each of\nthe 3 checks behind it:\n\n- `serialHealthCheck`: whether every delegated nameserver reports\n  the same SOA serial number as DigiCert DNS.\n- `nameServerDelegationCheck`: whether the zone's delegated\n  nameservers match the nameservers DigiCert DNS holds for it.\n- `zoneTransferCheck`: the outcome of the zone's most recent zone\n  transfer.\n\nEach check is `Healthy` or `Unhealthy`. The `healthStatus`\ndescription explains how the overall status is derived from them.\n\nThe delegated nameservers come from an NS lookup of the zone name,\nwhich the API can reuse for up to 30 seconds. Each delegated\nnameserver is then queried live for the zone's SOA record.\n\nUse the `type` query parameter to check the zone as `primary`\n(default) or `secondary`. If the zone doesn't exist as that type,\nthe API returns `404 Not Found`.\n\nThe check doesn't change the zone.\n",
        "tags": [
          "DNS Health"
        ],
        "parameters": [
          {
            "$ref": "#/components/parameters/HealthDomainType"
          },
          {
            "$ref": "#/components/parameters/XRequestId"
          }
        ],
        "responses": {
          "200": {
            "description": "The zone's overall health status and the result of each check.",
            "headers": {
              "X-Request-Id": {
                "$ref": "#/components/headers/XRequestId"
              },
              "X-RateLimit-Limit": {
                "$ref": "#/components/headers/XRateLimitLimit"
              },
              "X-RateLimit-Remaining": {
                "$ref": "#/components/headers/XRateLimitRemaining"
              },
              "X-RateLimit-Reset": {
                "$ref": "#/components/headers/XRateLimitReset"
              }
            },
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HealthResponse"
                },
                "examples": {
                  "primaryHealthy": {
                    "summary": "Primary zone, all checks healthy",
                    "value": {
                      "domain": "example.com.",
                      "type": "primary",
                      "healthStatus": "Healthy",
                      "serialHealthCheck": {
                        "delegatedNsRecords": [
                          {
                            "nameserver": "ns10.digicertdns.com",
                            "serialNumber": "2009010108"
                          },
                          {
                            "nameserver": "ns11.digicertdns.com",
                            "serialNumber": "2009010108"
                          }
                        ],
                        "status": "Healthy"
                      },
                      "nameServerDelegationCheck": {
                        "digicertDNS": [
                          {
                            "nameserver": "ns10.digicertdns.com."
                          },
                          {
                            "nameserver": "ns11.digicertdns.com."
                          }
                        ],
                        "delegatedNsRecords": [
                          {
                            "nameserver": "ns10.digicertdns.com"
                          },
                          {
                            "nameserver": "ns11.digicertdns.com"
                          }
                        ],
                        "status": "Healthy"
                      },
                      "zoneTransferCheck": {
                        "lastTransferStatus": "SUCCESSFUL",
                        "lastTransferTimestamp": "2026-05-20T09:32:00.000Z",
                        "status": "Healthy"
                      }
                    }
                  },
                  "primaryWarningNoRecentTransfer": {
                    "summary": "Primary zone, no recent outbound zone transfer (Warning)",
                    "description": "The serial and delegation checks pass, but the zone had\nno outbound zone transfer in the last 30 days, for\nexample because it has no secondary servers. So\n`lastTransferStatus` is `FAILED` and `zoneTransferCheck`\nis `Unhealthy`. 2 of the 3 checks are `Healthy`, so\n`healthStatus` is `Warning`.\n",
                    "value": {
                      "domain": "example.com.",
                      "type": "primary",
                      "healthStatus": "Warning",
                      "serialHealthCheck": {
                        "delegatedNsRecords": [
                          {
                            "nameserver": "ns10.digicertdns.com",
                            "serialNumber": "2009010108"
                          },
                          {
                            "nameserver": "ns11.digicertdns.com",
                            "serialNumber": "2009010108"
                          }
                        ],
                        "status": "Healthy"
                      },
                      "nameServerDelegationCheck": {
                        "digicertDNS": [
                          {
                            "nameserver": "ns10.digicertdns.com."
                          },
                          {
                            "nameserver": "ns11.digicertdns.com."
                          }
                        ],
                        "delegatedNsRecords": [
                          {
                            "nameserver": "ns10.digicertdns.com"
                          },
                          {
                            "nameserver": "ns11.digicertdns.com"
                          }
                        ],
                        "status": "Healthy"
                      },
                      "zoneTransferCheck": {
                        "lastTransferStatus": "FAILED",
                        "status": "Unhealthy"
                      }
                    }
                  },
                  "primaryUnhealthyNotDelegated": {
                    "summary": "Primary zone not delegated to DigiCert DNS yet (Unhealthy)",
                    "description": "The zone is still delegated to another provider's\nnameservers. They don't match the nameservers DigiCert\nDNS holds for the zone, and they serve a different SOA\nserial number. The zone also had no recent outbound zone\ntransfer. No check is `Healthy`, so `healthStatus` is\n`Unhealthy`.\n",
                    "value": {
                      "domain": "example.com.",
                      "type": "primary",
                      "healthStatus": "Unhealthy",
                      "serialHealthCheck": {
                        "delegatedNsRecords": [
                          {
                            "nameserver": "ns1.other-provider.example",
                            "serialNumber": "2024110301"
                          },
                          {
                            "nameserver": "ns2.other-provider.example",
                            "serialNumber": "2024110301"
                          }
                        ],
                        "status": "Unhealthy"
                      },
                      "nameServerDelegationCheck": {
                        "digicertDNS": [
                          {
                            "nameserver": "ns10.digicertdns.com."
                          },
                          {
                            "nameserver": "ns11.digicertdns.com."
                          }
                        ],
                        "delegatedNsRecords": [
                          {
                            "nameserver": "ns1.other-provider.example"
                          },
                          {
                            "nameserver": "ns2.other-provider.example"
                          }
                        ],
                        "status": "Unhealthy"
                      },
                      "zoneTransferCheck": {
                        "lastTransferStatus": "FAILED",
                        "status": "Unhealthy"
                      }
                    }
                  },
                  "secondaryWarningTransferFailed": {
                    "summary": "Secondary zone, last inbound zone transfer failed (Warning)",
                    "description": "For `type=secondary`, `zoneTransferCheck` describes the\nmost recent zone transfer from the upstream primary\nserver, and `lastTransferTimestamp` uses the\n`MM/DD/YY hh:mm:ss AM/PM TZ` format. The transfer\nfailed, so `zoneTransferCheck` is `Unhealthy`. The\nother 2 checks pass, so `healthStatus` is `Warning`.\n",
                    "value": {
                      "domain": "secondary.example.com.",
                      "type": "secondary",
                      "healthStatus": "Warning",
                      "serialHealthCheck": {
                        "delegatedNsRecords": [
                          {
                            "nameserver": "ns10.digicertdns.com",
                            "serialNumber": "2026060101"
                          },
                          {
                            "nameserver": "ns11.digicertdns.com",
                            "serialNumber": "2026060101"
                          }
                        ],
                        "status": "Healthy"
                      },
                      "nameServerDelegationCheck": {
                        "digicertDNS": [
                          {
                            "nameserver": "ns10.digicertdns.com."
                          },
                          {
                            "nameserver": "ns11.digicertdns.com."
                          }
                        ],
                        "delegatedNsRecords": [
                          {
                            "nameserver": "ns10.digicertdns.com"
                          },
                          {
                            "nameserver": "ns11.digicertdns.com"
                          }
                        ],
                        "status": "Healthy"
                      },
                      "zoneTransferCheck": {
                        "lastTransferStatus": "FAILED",
                        "lastTransferTimestamp": "05/19/26 09:00:00 AM GMT",
                        "status": "Unhealthy"
                      }
                    }
                  }
                }
              }
            }
          },
          "400": {
            "$ref": "#/components/responses/BadRequest"
          },
          "401": {
            "$ref": "#/components/responses/Unauthorized"
          },
          "403": {
            "$ref": "#/components/responses/Forbidden"
          },
          "404": {
            "$ref": "#/components/responses/NotFound"
          },
          "429": {
            "$ref": "#/components/responses/TooManyRequests"
          },
          "500": {
            "$ref": "#/components/responses/InternalServerError"
          },
          "502": {
            "$ref": "#/components/responses/BadGateway"
          },
          "503": {
            "$ref": "#/components/responses/ServiceUnavailable"
          },
          "504": {
            "$ref": "#/components/responses/GatewayTimeout"
          }
        }
      }
    },
    "/zones/{zoneName}/health/nameservers": {
      "parameters": [
        {
          "$ref": "#/components/parameters/ZoneName"
        }
      ],
      "get": {
        "operationId": "getNameserverHealth",
        "x-required-permission": "account.zones:read",
        "summary": "Get nameserver health for a zone",
        "description": "Returns the SOA values (serial, refresh, retry, and expire) that\neach of the zone's delegated nameservers reports. Each nameserver\nis queried live for the zone's SOA record.\n\n`GET /zones/{zoneName}/health` returns only each nameserver's SOA\nserial, in `serialHealthCheck.delegatedNsRecords`. The response\nhere includes all the SOA timers for each nameserver. It doesn't\nreturn a health status. For that, use `GET /zones/{zoneName}/health`.\n\nThe delegated nameservers come from an NS lookup of the zone name,\nwhich the API can reuse for up to 30 seconds. If a nameserver\ndoesn't answer the SOA query, its `serial` is `N/A` and its timers\nare `0`.\n\nUse the `type` query parameter to check the zone as `primary`\n(default) or `secondary`. If the zone doesn't exist as that type,\nthe API returns `404 Not Found`.\n\nThe check doesn't change the zone.\n",
        "tags": [
          "DNS Health"
        ],
        "parameters": [
          {
            "$ref": "#/components/parameters/HealthDomainType"
          },
          {
            "$ref": "#/components/parameters/XRequestId"
          }
        ],
        "responses": {
          "200": {
            "description": "The SOA values reported by each delegated nameserver.",
            "headers": {
              "X-Request-Id": {
                "$ref": "#/components/headers/XRequestId"
              },
              "X-RateLimit-Limit": {
                "$ref": "#/components/headers/XRateLimitLimit"
              },
              "X-RateLimit-Remaining": {
                "$ref": "#/components/headers/XRateLimitRemaining"
              },
              "X-RateLimit-Reset": {
                "$ref": "#/components/headers/XRateLimitReset"
              }
            },
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/NameserverHealthResponse"
                },
                "examples": {
                  "primaryNameservers": {
                    "summary": "Primary zone nameserver SOA detail",
                    "value": {
                      "type": "primary",
                      "data": [
                        {
                          "nameserver": "ns10.digicertdns.com",
                          "type": "primary",
                          "soa": {
                            "serial": "2009010109",
                            "refresh": 43200,
                            "retry": 3600,
                            "expire": 1209600
                          }
                        },
                        {
                          "nameserver": "ns11.digicertdns.com",
                          "type": "primary",
                          "soa": {
                            "serial": "2009010109",
                            "refresh": 43200,
                            "retry": 3600,
                            "expire": 1209600
                          }
                        }
                      ]
                    }
                  },
                  "secondaryNameserversSerialMismatch": {
                    "summary": "Secondary zone nameserver SOA detail, serial mismatch",
                    "description": "For `type=secondary`, one delegated nameserver\n(`ns14.digicertdns.net`) hasn't received the latest zone\ntransfer yet, so it still reports the previous `serial`.\n`serialHealthCheck.status` on\n`GET /zones/{zoneName}/health` is `Unhealthy` for the\nsame reason.\n",
                    "value": {
                      "type": "secondary",
                      "data": [
                        {
                          "nameserver": "ns12.digicertdns.com",
                          "type": "secondary",
                          "soa": {
                            "serial": "2009010118",
                            "refresh": 43200,
                            "retry": 3600,
                            "expire": 1209600
                          }
                        },
                        {
                          "nameserver": "ns14.digicertdns.net",
                          "type": "secondary",
                          "soa": {
                            "serial": "2009010117",
                            "refresh": 43200,
                            "retry": 3600,
                            "expire": 1209600
                          }
                        }
                      ]
                    }
                  },
                  "nameserverNotAnswering": {
                    "summary": "One nameserver didn't answer the SOA query",
                    "description": "`ns11.digicertdns.com` didn't answer, so its `serial` is\n`N/A` and its timers are `0`.\n",
                    "value": {
                      "type": "primary",
                      "data": [
                        {
                          "nameserver": "ns10.digicertdns.com",
                          "type": "primary",
                          "soa": {
                            "serial": "2009010109",
                            "refresh": 43200,
                            "retry": 3600,
                            "expire": 1209600
                          }
                        },
                        {
                          "nameserver": "ns11.digicertdns.com",
                          "type": "primary",
                          "soa": {
                            "serial": "N/A",
                            "refresh": 0,
                            "retry": 0,
                            "expire": 0
                          }
                        }
                      ]
                    }
                  }
                }
              }
            }
          },
          "400": {
            "$ref": "#/components/responses/BadRequest"
          },
          "401": {
            "$ref": "#/components/responses/Unauthorized"
          },
          "403": {
            "$ref": "#/components/responses/Forbidden"
          },
          "404": {
            "$ref": "#/components/responses/NotFound"
          },
          "429": {
            "$ref": "#/components/responses/TooManyRequests"
          },
          "500": {
            "$ref": "#/components/responses/InternalServerError"
          },
          "502": {
            "$ref": "#/components/responses/BadGateway"
          },
          "503": {
            "$ref": "#/components/responses/ServiceUnavailable"
          },
          "504": {
            "$ref": "#/components/responses/GatewayTimeout"
          }
        }
      }
    },
    "/zones/{zoneName}/nameservers": {
      "parameters": [
        {
          "$ref": "#/components/parameters/ZoneName"
        }
      ],
      "get": {
        "operationId": "getZoneNameservers",
        "x-required-permission": "account.zones:read",
        "summary": "Get a zone's nameservers and delegation status",
        "description": "Returns the DigiCert nameservers assigned to a zone and checks\nwhether the zone is delegated to each one. Use it to confirm that\nthe zone's registrar points to DigiCert DNS.\n\n- `nameservers` lists the nameservers in the zone's NS record set\n  at the apex. Each one has its current IPv4 and IPv6 addresses\n  and a `status` of `DELEGATED` or `NOT_DELEGATED`.\n- `registrarNameservers` lists the nameservers that the zone is\n  delegated to, from a live NS lookup. It can include another DNS\n  provider's nameservers. It's empty if the lookup finds no\n  nameservers or fails, for example because the zone isn't\n  delegated yet.\n\nUse the `type` query parameter to get the zone as `PRIMARY`\n(default) or `SECONDARY`. If the zone doesn't exist as that type,\nthe API returns `404 Not Found`.\n\nThe API can reuse a zone's delegation lookup for up to 30\nseconds, so a recent registrar change can take that long to show.\nThe operation doesn't change the zone.\n",
        "tags": [
          "Nameservers"
        ],
        "parameters": [
          {
            "$ref": "#/components/parameters/ZoneTypeDisambiguator"
          },
          {
            "$ref": "#/components/parameters/XRequestId"
          }
        ],
        "responses": {
          "200": {
            "description": "The zone's nameservers and the nameservers it's delegated to.",
            "headers": {
              "X-Request-Id": {
                "$ref": "#/components/headers/XRequestId"
              },
              "X-RateLimit-Limit": {
                "$ref": "#/components/headers/XRateLimitLimit"
              },
              "X-RateLimit-Remaining": {
                "$ref": "#/components/headers/XRateLimitRemaining"
              },
              "X-RateLimit-Reset": {
                "$ref": "#/components/headers/XRateLimitReset"
              }
            },
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ZoneNameserversResponse"
                },
                "examples": {
                  "fullyDelegated": {
                    "summary": "Zone fully delegated to DigiCert nameservers",
                    "value": {
                      "zone": "example.com.",
                      "nameservers": [
                        {
                          "nameserver": "ns10.digicertdns.com.",
                          "ipv4Address": "192.0.2.10",
                          "ipv6Address": "2001:db8:0:0:0:0:0:10",
                          "status": "DELEGATED"
                        },
                        {
                          "nameserver": "ns11.digicertdns.com.",
                          "ipv4Address": "198.51.100.11",
                          "ipv6Address": "2001:db8:1:0:0:0:0:11",
                          "status": "DELEGATED"
                        }
                      ],
                      "registrarNameservers": [
                        {
                          "nameserver": "ns10.digicertdns.com.",
                          "ipv4Address": "192.0.2.10",
                          "ipv6Address": "2001:db8:0:0:0:0:0:10"
                        },
                        {
                          "nameserver": "ns11.digicertdns.com.",
                          "ipv4Address": "198.51.100.11",
                          "ipv6Address": "2001:db8:1:0:0:0:0:11"
                        }
                      ]
                    }
                  }
                }
              }
            }
          },
          "400": {
            "$ref": "#/components/responses/BadRequest"
          },
          "401": {
            "$ref": "#/components/responses/Unauthorized"
          },
          "403": {
            "$ref": "#/components/responses/Forbidden"
          },
          "404": {
            "$ref": "#/components/responses/NotFound"
          },
          "429": {
            "$ref": "#/components/responses/TooManyRequests"
          },
          "500": {
            "$ref": "#/components/responses/InternalServerError"
          },
          "502": {
            "$ref": "#/components/responses/BadGateway"
          },
          "503": {
            "$ref": "#/components/responses/ServiceUnavailable"
          },
          "504": {
            "$ref": "#/components/responses/GatewayTimeout"
          }
        }
      }
    },
    "/zones/{zoneName}/health/zone-transfers": {
      "parameters": [
        {
          "$ref": "#/components/parameters/ZoneName"
        }
      ],
      "get": {
        "operationId": "getDnsHealthZoneTransfers",
        "x-required-permission": "account.zones:read",
        "summary": "Get the most recent zone transfer with each peer",
        "description": "Returns the most recent zone transfer with each peer that the zone\ntransferred with recently: the IP set name, the peer's IP address,\nthe SOA `serial`, the `lastTransferAt` time, and whether the\ntransfer succeeded.\n\nThe list is built from up to the 10 most recent zone transfers in\nthe last 30 days, grouped by peer. A peer that hasn't transferred\nthe zone in that time isn't listed. If there was no transfer in that\ntime, the list has 1 entry with `remoteIp` set to `N/A`, based on\nthe zone's own transfer status.\n\n`GET /zones/{zoneName}/health` returns one `lastTransferStatus` for\nthe whole zone. The response here lists the transfers behind it, one\nentry for each peer. It doesn't return the overall health status.\n\nThe `type` query parameter is required:\n\n- `primary`: peers are the downstream servers that transferred the\n  zone from DigiCert DNS.\n- `secondary`: peers are the upstream primary servers that DigiCert\n  DNS transferred the zone from.\n\nIf the zone doesn't exist as that type, the API returns\n`404 Not Found`. The check doesn't change the zone.\n",
        "tags": [
          "DNS Health"
        ],
        "parameters": [
          {
            "$ref": "#/components/parameters/DnsHealthTypeRequired"
          },
          {
            "$ref": "#/components/parameters/XRequestId"
          }
        ],
        "responses": {
          "200": {
            "description": "The most recent zone transfer with each peer.",
            "headers": {
              "X-Request-Id": {
                "$ref": "#/components/headers/XRequestId"
              },
              "X-RateLimit-Limit": {
                "$ref": "#/components/headers/XRateLimitLimit"
              },
              "X-RateLimit-Remaining": {
                "$ref": "#/components/headers/XRateLimitRemaining"
              },
              "X-RateLimit-Reset": {
                "$ref": "#/components/headers/XRateLimitReset"
              }
            },
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/DnsHealthZoneTransferList"
                },
                "examples": {
                  "primaryTransfers": {
                    "summary": "Primary zone, 2 downstream servers",
                    "value": {
                      "type": "primary",
                      "data": [
                        {
                          "ipSetName": "secondary-peers",
                          "remoteIp": "192.0.2.10",
                          "serial": "2026021303",
                          "lastTransferAt": "2026-02-12T08:27:59Z",
                          "reachability": "Healthy"
                        },
                        {
                          "ipSetName": "secondary-peers",
                          "remoteIp": "192.0.2.11",
                          "serial": "2026021303",
                          "lastTransferAt": "2026-02-12T08:26:57Z",
                          "reachability": "Healthy"
                        }
                      ]
                    }
                  },
                  "secondaryTransferRefused": {
                    "summary": "Secondary zone, the upstream server refused the last transfer",
                    "description": "For `type=secondary`, peers are the zone's upstream\nprimary servers. The second server refused its most\nrecent transfer, so its `reachability` is `Unhealthy`\nand its `reasonCode` is `REFUSED`.\n",
                    "value": {
                      "type": "secondary",
                      "data": [
                        {
                          "ipSetName": "upstream-primaries",
                          "remoteIp": "198.51.100.1",
                          "serial": "2025031201",
                          "lastTransferAt": "2025-10-20T09:32:00Z",
                          "reachability": "Healthy"
                        },
                        {
                          "ipSetName": "upstream-primaries",
                          "remoteIp": "198.51.100.2",
                          "serial": "2025031105",
                          "lastTransferAt": "2025-10-19T09:32:00Z",
                          "reachability": "Unhealthy",
                          "reasonCode": "REFUSED"
                        }
                      ]
                    }
                  },
                  "primaryNoRecentTransfers": {
                    "summary": "Primary zone with no zone transfers in the last 30 days",
                    "description": "There was no transfer to report, so the list has 1 entry\nwith `remoteIp` set to `N/A`. It reflects the zone's own\ntransfer status, which is `Healthy` only after a\nrecorded successful transfer and otherwise `Unhealthy`,\nand `serial` is the zone's current serial.\n",
                    "value": {
                      "type": "primary",
                      "data": [
                        {
                          "ipSetName": "secondary-peers",
                          "remoteIp": "N/A",
                          "serial": "2026021303",
                          "reachability": "Unhealthy"
                        }
                      ]
                    }
                  }
                }
              }
            }
          },
          "400": {
            "$ref": "#/components/responses/BadRequest"
          },
          "401": {
            "$ref": "#/components/responses/Unauthorized"
          },
          "403": {
            "$ref": "#/components/responses/Forbidden"
          },
          "404": {
            "$ref": "#/components/responses/NotFound"
          },
          "429": {
            "$ref": "#/components/responses/TooManyRequests"
          },
          "500": {
            "$ref": "#/components/responses/InternalServerError"
          },
          "502": {
            "$ref": "#/components/responses/BadGateway"
          },
          "503": {
            "$ref": "#/components/responses/ServiceUnavailable"
          },
          "504": {
            "$ref": "#/components/responses/GatewayTimeout"
          }
        }
      }
    },
    "/zones/{zoneName}/health/axfr-hosts": {
      "parameters": [
        {
          "$ref": "#/components/parameters/ZoneName"
        }
      ],
      "get": {
        "operationId": "getDnsHealthAxfrHosts",
        "x-required-permission": "account.zones:read",
        "summary": "Get the DigiCert DNS transfer host for a zone",
        "description": "Returns DigiCert DNS transfer host addresses, with the zone's\ncurrent SOA `serial` and its zone transfer status.\n\nFor `secondary` zones, `hostIp` is the public (NAT) IP address that\nDigiCert DNS transfers the zone from. Allow it on the zone's primary\nserver. `status` and `lastTransferAt` describe the zone's most\nrecent inbound zone transfer.\n\nFor `primary` zones, the DigiCert DNS transfer hosts that may send\ntransfers to downstream secondary servers are returned whether or\nnot an Outbound IP Set is bound or a recent transfer is recorded.\nAllow each returned `hostIp` on the downstream secondary servers so\nthey can accept transfers and `NOTIFY` messages. `fqdn` is `N/A`\nwhen a hostname is unavailable, and `hostIp` is `N/A` when an\naddress is unknown. `lastTransferAt` is the newest recorded outbound\ntransfer to any downstream secondary server and is the same in every\nhost entry. If no outbound transfer time is available, it's the\nzone's most recent transfer time instead. `status` reflects zone-wide\ntransfer details, not a live check of each host, and doesn't depend\non `lastTransferAt`. `status` is `Healthy` only after a recorded\nsuccessful transfer; otherwise it is `Unhealthy`.\nTo check transfers to downstream peers, use\n`GET /zones/{zoneName}/health/zone-transfers`.\n\nThe `type` query parameter is required and checks the zone as\n`primary` or `secondary`. If the zone doesn't exist as that type,\nthe API returns `404 Not Found`. The check doesn't change the zone.\n",
        "tags": [
          "DNS Health"
        ],
        "parameters": [
          {
            "$ref": "#/components/parameters/DnsHealthTypeRequired"
          },
          {
            "$ref": "#/components/parameters/XRequestId"
          }
        ],
        "responses": {
          "200": {
            "description": "The zone's DigiCert DNS transfer host.",
            "headers": {
              "X-Request-Id": {
                "$ref": "#/components/headers/XRequestId"
              },
              "X-RateLimit-Limit": {
                "$ref": "#/components/headers/XRateLimitLimit"
              },
              "X-RateLimit-Remaining": {
                "$ref": "#/components/headers/XRateLimitRemaining"
              },
              "X-RateLimit-Reset": {
                "$ref": "#/components/headers/XRateLimitReset"
              }
            },
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/DnsHealthAxfrHostList"
                },
                "examples": {
                  "secondaryAxfrHost": {
                    "summary": "Secondary zone transfer host",
                    "value": {
                      "type": "secondary",
                      "data": [
                        {
                          "fqdn": "N/A",
                          "hostIp": "198.51.100.53",
                          "serial": "2025031201",
                          "lastTransferAt": "2025-10-20T09:32:00Z",
                          "status": "Healthy"
                        }
                      ]
                    }
                  },
                  "secondaryAxfrHostTransferRunning": {
                    "summary": "Secondary zone transfer host, transfer still running",
                    "description": "The zone's most recent inbound zone transfer hasn't\nfinished, so `status` is `Unknown`.\n",
                    "value": {
                      "type": "secondary",
                      "data": [
                        {
                          "fqdn": "N/A",
                          "hostIp": "198.51.100.53",
                          "serial": "2025031201",
                          "lastTransferAt": "2025-10-20T09:32:00Z",
                          "status": "Unknown"
                        }
                      ]
                    }
                  },
                  "primaryAxfrHost": {
                    "summary": "Primary zone transfer host",
                    "description": "Configured hosts are shown even without transfer\nhistory. This zone has no successful transfer recorded.\n",
                    "value": {
                      "type": "primary",
                      "data": [
                        {
                          "fqdn": "axfr1.example.com",
                          "hostIp": "198.51.100.53",
                          "serial": "2026021303",
                          "status": "Unhealthy"
                        }
                      ]
                    }
                  }
                }
              }
            }
          },
          "400": {
            "$ref": "#/components/responses/BadRequest"
          },
          "401": {
            "$ref": "#/components/responses/Unauthorized"
          },
          "403": {
            "$ref": "#/components/responses/Forbidden"
          },
          "404": {
            "$ref": "#/components/responses/NotFound"
          },
          "429": {
            "$ref": "#/components/responses/TooManyRequests"
          },
          "500": {
            "$ref": "#/components/responses/InternalServerError"
          },
          "502": {
            "$ref": "#/components/responses/BadGateway"
          },
          "503": {
            "$ref": "#/components/responses/ServiceUnavailable"
          },
          "504": {
            "$ref": "#/components/responses/GatewayTimeout"
          }
        }
      }
    },
    "/zones/{zoneName}/health/outbound-notifications": {
      "parameters": [
        {
          "$ref": "#/components/parameters/ZoneName"
        }
      ],
      "get": {
        "operationId": "getDnsHealthOutboundNotifications",
        "x-required-permission": "account.zones:read",
        "summary": "Get outbound NOTIFY status for a zone",
        "description": "Returns the latest recorded DNS `NOTIFY` details for each address,\nincluding the hostname (`fqdn`), IP address (`ip`), SOA serial\nnumber (`serial`), timestamp (`lastNotifyAt`), and status\n(`status`). For `primary` zones with no recorded `NOTIFY`, returns\nconfigured transfer host details instead.\n\n- For `primary` zones, each entry represents a DigiCert DNS\n  transfer host that sends `NOTIFY` to downstream secondary\n  servers when the zone changes. The `status` reflects the result\n  of the latest `NOTIFY` that the host sent to any downstream\n  secondary server; it doesn't identify which recipient failed.\n- For `secondary` zones, each entry represents the DigiCert DNS\n  address that received `NOTIFY` from an upstream primary server.\n  A `NOTIFY` starts an inbound zone transfer (AXFR or IXFR). To\n  identify the upstream primary server that sent the `NOTIFY`, use\n  `GET /zones/{zoneName}/health/inbound-notifications`.\n\nFor recorded `NOTIFY` messages, `ip` is the DigiCert DNS sender\naddress for `primary` zones and the DigiCert DNS receiver address\nfor `secondary` zones.\n\nFor `primary` zones, `fqdn` is the transfer host's hostname, found\nby matching `ip` against the configured transfer hosts returned by\n`GET /zones/{zoneName}/health/axfr-hosts`. Equivalent IPv6\naddresses match regardless of their textual representation. If no\nconfigured transfer host matches the address, `fqdn` is `N/A`. For\n`secondary` zones, `fqdn` is always `N/A`.\n\nIf no `NOTIFY` has been recorded for a `primary` zone, for example\nbecause the zone has no outbound IP set, `data` contains one entry\nper configured transfer host. Each entry uses the host's\nconfigured `fqdn` and `ip`, with `ip` set to `N/A` if no address is\nconfigured. The `serial` is the zone's current SOA serial number,\nor `null` if it can't be read. Both `lastNotifyAt` and `reasonCode`\nare `null`, and `status` is `Unknown`. Once at least one `NOTIFY`\nis recorded for the zone, only recorded entries are returned; no\nentries are added for other configured transfer hosts. When no\n`NOTIFY` is recorded, `secondary` zones and `primary` zones with\nno configured transfer hosts return an empty `data` array.\n\nEach related operation tracks a different step of zone\npropagation: `GET /zones/{zoneName}/health/zone-transfers` tracks\neach IP set peer, `GET /zones/{zoneName}/health/axfr-hosts` tracks\neach host IP address, and\n`GET /zones/{zoneName}/health/outbound-notifications` reports\n`NOTIFY` details for each address. For the zone's overall health\nstatus, use `GET /zones/{zoneName}/health`.\n\nThe `type` query parameter is required and checks the zone as\n`primary` or `secondary`. If the zone doesn't exist as that type,\nthe API returns `404 Not Found`.\n\nEach call runs the check live. It doesn't change the zone.\n",
        "tags": [
          "DNS Health"
        ],
        "parameters": [
          {
            "$ref": "#/components/parameters/DnsHealthTypeRequired"
          },
          {
            "$ref": "#/components/parameters/XRequestId"
          }
        ],
        "responses": {
          "200": {
            "description": "The latest recorded `NOTIFY` details for each address. If no\n`NOTIFY` has been recorded for a `primary` zone, this returns one\nentry per configured transfer host with `status` `Unknown`.\n",
            "headers": {
              "X-Request-Id": {
                "$ref": "#/components/headers/XRequestId"
              },
              "X-RateLimit-Limit": {
                "$ref": "#/components/headers/XRateLimitLimit"
              },
              "X-RateLimit-Remaining": {
                "$ref": "#/components/headers/XRateLimitRemaining"
              },
              "X-RateLimit-Reset": {
                "$ref": "#/components/headers/XRateLimitReset"
              }
            },
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/DnsHealthOutboundNotificationList"
                },
                "examples": {
                  "primaryNotify": {
                    "summary": "Primary zone NOTIFY detail",
                    "value": {
                      "type": "primary",
                      "data": [
                        {
                          "fqdn": "axfr1.example.net",
                          "ip": "192.0.2.20",
                          "serial": "2008765783",
                          "lastNotifyAt": "2026-01-07T09:50:40Z",
                          "status": "Healthy",
                          "reasonCode": null
                        }
                      ]
                    }
                  },
                  "secondaryNotifyUnhealthy": {
                    "summary": "Secondary zone NOTIFY detail, upstream unreachable",
                    "description": "For `type=secondary`, the most recent `NOTIFY` from the\nupstream primary server wasn't received or\nacknowledged, so `status` is `Unhealthy` and\n`reasonCode` is `TIMEOUT`.\n",
                    "value": {
                      "type": "secondary",
                      "data": [
                        {
                          "fqdn": "N/A",
                          "ip": "198.51.100.1",
                          "serial": "2025031105",
                          "lastNotifyAt": "2025-10-19T09:32:00Z",
                          "status": "Unhealthy",
                          "reasonCode": "TIMEOUT"
                        }
                      ]
                    }
                  },
                  "primaryNotifyUnknownHost": {
                    "summary": "Primary zone NOTIFY details for an unmatched address",
                    "description": "The recorded address doesn't match a configured transfer\nhost, so `fqdn` is `N/A`.\n",
                    "value": {
                      "type": "primary",
                      "data": [
                        {
                          "fqdn": "axfr1.example.net",
                          "ip": "192.0.2.20",
                          "serial": "2008765783",
                          "lastNotifyAt": "2026-01-07T09:50:40Z",
                          "status": "Healthy",
                          "reasonCode": null
                        },
                        {
                          "fqdn": "N/A",
                          "ip": "198.51.100.22",
                          "serial": "2008765783",
                          "lastNotifyAt": "2026-01-07T09:48:10Z",
                          "status": "Unhealthy",
                          "reasonCode": "REFUSED"
                        }
                      ]
                    }
                  },
                  "primaryNotifyIncompleteRecord": {
                    "summary": "Primary zone NOTIFY details with an incomplete record",
                    "description": "The recorded `NOTIFY` has no SOA serial number and no\nreadable timestamp, so `serial` and `lastNotifyAt` are\nboth `null`.\n",
                    "value": {
                      "type": "primary",
                      "data": [
                        {
                          "fqdn": "axfr1.example.net",
                          "ip": "192.0.2.20",
                          "serial": null,
                          "lastNotifyAt": null,
                          "status": "Healthy",
                          "reasonCode": null
                        }
                      ]
                    }
                  },
                  "primaryNoNotifyRecorded": {
                    "summary": "Primary zone with no recorded NOTIFY",
                    "description": "No `NOTIFY` has been recorded for the zone, for example\nbecause it has no outbound IP set. Each configured\ntransfer host is returned with its configured hostname\nand IP address, the zone's current SOA serial number,\n`lastNotifyAt` and `reasonCode` set to `null`, and\n`status` set to `Unknown`.\n",
                    "value": {
                      "type": "primary",
                      "data": [
                        {
                          "fqdn": "axfr1.example.net",
                          "ip": "192.0.2.20",
                          "serial": "2026102704",
                          "lastNotifyAt": null,
                          "status": "Unknown",
                          "reasonCode": null
                        }
                      ]
                    }
                  }
                }
              }
            }
          },
          "400": {
            "$ref": "#/components/responses/BadRequest"
          },
          "401": {
            "$ref": "#/components/responses/Unauthorized"
          },
          "403": {
            "$ref": "#/components/responses/Forbidden"
          },
          "404": {
            "$ref": "#/components/responses/NotFound"
          },
          "429": {
            "$ref": "#/components/responses/TooManyRequests"
          },
          "500": {
            "$ref": "#/components/responses/InternalServerError"
          },
          "502": {
            "$ref": "#/components/responses/BadGateway"
          },
          "503": {
            "$ref": "#/components/responses/ServiceUnavailable"
          },
          "504": {
            "$ref": "#/components/responses/GatewayTimeout"
          }
        }
      }
    },
    "/zones/{zoneName}/health/inbound-notifications": {
      "parameters": [
        {
          "$ref": "#/components/parameters/ZoneName"
        }
      ],
      "get": {
        "operationId": "getDnsHealthInboundNotifications",
        "x-required-permission": "account.zones:read",
        "summary": "Get inbound NOTIFY activity for a zone",
        "description": "Returns the most recent DNS `NOTIFY` message received from each of\nthe zone's peers: the peer's IP address (`ip`), the IP set it\nbelongs to (`ipSetName`), and the `lastNotifyAt` time.\n\n- For `secondary` zones, peers are the upstream primary servers\n  whose `NOTIFY` starts an inbound zone transfer (AXFR or IXFR).\n- For `primary` zones, peers are downstream secondary servers\n  acknowledging a zone change.\n\n`GET /zones/{zoneName}/health/outbound-notifications` covers the\nsending side and adds `fqdn`, `serial`, and `status`. Inbound\nnotifications cover the receiving side and return only the peer and\nthe time. Neither returns the overall health status. For that, use\n`GET /zones/{zoneName}/health`.\n\nThe `type` query parameter is required and checks the zone as\n`primary` or `secondary`. If the zone doesn't exist as that type,\nthe API returns `404 Not Found`.\n\nEach call runs the check live. It doesn't change the zone.\n",
        "tags": [
          "DNS Health"
        ],
        "parameters": [
          {
            "$ref": "#/components/parameters/DnsHealthTypeRequired"
          },
          {
            "$ref": "#/components/parameters/XRequestId"
          }
        ],
        "responses": {
          "200": {
            "description": "The most recent `NOTIFY` message received from each peer.",
            "headers": {
              "X-Request-Id": {
                "$ref": "#/components/headers/XRequestId"
              },
              "X-RateLimit-Limit": {
                "$ref": "#/components/headers/XRateLimitLimit"
              },
              "X-RateLimit-Remaining": {
                "$ref": "#/components/headers/XRateLimitRemaining"
              },
              "X-RateLimit-Reset": {
                "$ref": "#/components/headers/XRateLimitReset"
              }
            },
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/DnsHealthInboundNotificationList"
                },
                "examples": {
                  "secondaryInboundNotify": {
                    "summary": "Secondary zone inbound NOTIFY detail",
                    "value": {
                      "type": "secondary",
                      "data": [
                        {
                          "ip": "198.51.100.20",
                          "ipSetName": "upstream-primaries",
                          "lastNotifyAt": "2026-01-07T09:50:40Z"
                        }
                      ]
                    }
                  },
                  "primaryInboundNotify": {
                    "summary": "Primary zone inbound NOTIFY acknowledgement detail",
                    "value": {
                      "type": "primary",
                      "data": [
                        {
                          "ip": "192.0.2.30",
                          "ipSetName": "secondary-peers",
                          "lastNotifyAt": "2026-05-20T09:32:00Z"
                        }
                      ]
                    }
                  },
                  "secondaryInboundNotifyNeverReceived": {
                    "summary": "Secondary zone inbound NOTIFY detail, newly added peer",
                    "description": "An upstream primary server that was just added and\nhasn't sent a `NOTIFY` yet has `lastNotifyAt` set to\n`null`.\n",
                    "value": {
                      "type": "secondary",
                      "data": [
                        {
                          "ip": "198.51.100.20",
                          "ipSetName": "upstream-primaries",
                          "lastNotifyAt": "2026-01-07T09:50:40Z"
                        },
                        {
                          "ip": "198.51.100.44",
                          "ipSetName": "upstream-primaries",
                          "lastNotifyAt": null
                        }
                      ]
                    }
                  }
                }
              }
            }
          },
          "400": {
            "$ref": "#/components/responses/BadRequest"
          },
          "401": {
            "$ref": "#/components/responses/Unauthorized"
          },
          "403": {
            "$ref": "#/components/responses/Forbidden"
          },
          "404": {
            "$ref": "#/components/responses/NotFound"
          },
          "429": {
            "$ref": "#/components/responses/TooManyRequests"
          },
          "500": {
            "$ref": "#/components/responses/InternalServerError"
          },
          "502": {
            "$ref": "#/components/responses/BadGateway"
          },
          "503": {
            "$ref": "#/components/responses/ServiceUnavailable"
          },
          "504": {
            "$ref": "#/components/responses/GatewayTimeout"
          }
        }
      }
    },
    "/zones/{zoneName}/health/notify-events": {
      "parameters": [
        {
          "$ref": "#/components/parameters/ZoneName"
        }
      ],
      "get": {
        "operationId": "getDnsHealthNotifyEvents",
        "x-required-permission": "account.zones:read",
        "summary": "Get the latest NOTIFY event for each peer",
        "description": "Returns the most recent DNS `NOTIFY` event for each of the zone's\npeers: the peer's `ip`, the `lastNotifyAt` time, the `status` (with\na `reasonCode` if it failed), the direction (`eventType`:\n`NOTIFY_OUT` or `NOTIFY_IN`), and an `eventId`.\n\n**This isn't an event history.** It returns at most 1 event per\npeer. A newer event replaces the previous one, and older events\naren't kept. It also doesn't link a `NOTIFY` to the SOA query or\nzone transfer (AXFR or IXFR) that it started.\n\nIt combines `GET /zones/{zoneName}/health/outbound-notifications`\nand `GET /zones/{zoneName}/health/inbound-notifications` into one\nlist, so you can see the latest `NOTIFY` activity in both\ndirections with one call. It doesn't return the overall health\nstatus. For that, use `GET /zones/{zoneName}/health`.\n\nThe `type` query parameter is required and checks the zone as\n`primary` or `secondary`. If the zone doesn't exist as that type,\nthe API returns `404 Not Found`.\n\nEach call runs the check live. It doesn't change the zone.\n",
        "tags": [
          "DNS Health"
        ],
        "parameters": [
          {
            "$ref": "#/components/parameters/DnsHealthTypeRequired"
          },
          {
            "$ref": "#/components/parameters/XRequestId"
          }
        ],
        "responses": {
          "200": {
            "description": "The latest `NOTIFY` event for each peer.",
            "headers": {
              "X-Request-Id": {
                "$ref": "#/components/headers/XRequestId"
              },
              "X-RateLimit-Limit": {
                "$ref": "#/components/headers/XRateLimitLimit"
              },
              "X-RateLimit-Remaining": {
                "$ref": "#/components/headers/XRateLimitRemaining"
              },
              "X-RateLimit-Reset": {
                "$ref": "#/components/headers/XRateLimitReset"
              }
            },
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/DnsHealthNotifyEventList"
                },
                "examples": {
                  "primaryNotifyOut": {
                    "summary": "Primary zone, outbound NOTIFY event",
                    "value": {
                      "type": "primary",
                      "data": [
                        {
                          "eventId": "6f1a2b3c-4d5e-4f60-8a1b-2c3d4e5f6071",
                          "ip": "192.0.2.20",
                          "lastNotifyAt": "2026-01-07T09:50:40Z",
                          "status": "Healthy",
                          "reasonCode": null,
                          "eventType": "NOTIFY_OUT"
                        }
                      ]
                    }
                  },
                  "secondaryNotifyInUnhealthy": {
                    "summary": "Secondary zone, inbound NOTIFY event, failed",
                    "description": "For `type=secondary`, the most recent `NOTIFY` from the\nupstream primary server couldn't be processed, so\n`status` is `Unhealthy` and `reasonCode` is\n`CONNECTION_ERROR`.\n",
                    "value": {
                      "type": "secondary",
                      "data": [
                        {
                          "eventId": "7a2b3c4d-5e6f-4071-9a2b-3c4d5e6f7182",
                          "ip": "198.51.100.1",
                          "lastNotifyAt": "2025-10-19T09:32:00Z",
                          "status": "Unhealthy",
                          "reasonCode": "CONNECTION_ERROR",
                          "eventType": "NOTIFY_IN"
                        }
                      ]
                    }
                  }
                }
              }
            }
          },
          "400": {
            "$ref": "#/components/responses/BadRequest"
          },
          "401": {
            "$ref": "#/components/responses/Unauthorized"
          },
          "403": {
            "$ref": "#/components/responses/Forbidden"
          },
          "404": {
            "$ref": "#/components/responses/NotFound"
          },
          "429": {
            "$ref": "#/components/responses/TooManyRequests"
          },
          "500": {
            "$ref": "#/components/responses/InternalServerError"
          },
          "502": {
            "$ref": "#/components/responses/BadGateway"
          },
          "503": {
            "$ref": "#/components/responses/ServiceUnavailable"
          },
          "504": {
            "$ref": "#/components/responses/GatewayTimeout"
          }
        }
      }
    },
    "/zones/{zoneName}/health/dnssec": {
      "parameters": [
        {
          "$ref": "#/components/parameters/ZoneName"
        }
      ],
      "get": {
        "operationId": "getDnsHealthDnsSec",
        "x-required-permission": "account.zones:read",
        "summary": "Get DNSSEC health for a zone",
        "description": "Compares the DS records that should be published for the zone,\nbased on its active DNSSEC key signing keys (KSKs), with the DS\nrecords actually published in the parent zone, from a live DNS\nlookup.\n\nThe result doesn't affect the `healthStatus` returned by\n`GET /zones/{zoneName}/health`.\n\n`status` tells you what to fix. For example, `MISMATCH` means the\npublished DS record must be replaced, and `PENDING` means one must\nbe added. `LOOKUP_FAILURE` means the lookup failed, not that no DS\nrecord is published.\n\n**Primary zones only.** DigiCert DNS doesn't hold DNSSEC keys for\na secondary zone unless secondary zone signing is enabled for the\naccount. Even then, the zone's primary server might sign the zone,\nso there's nothing reliable to compare. If the zone exists only as\na secondary zone, the API returns `404 Not Found`.\n\nEach call runs the check live. It doesn't change the zone.\n",
        "tags": [
          "DNS Health"
        ],
        "parameters": [
          {
            "$ref": "#/components/parameters/XRequestId"
          }
        ],
        "responses": {
          "200": {
            "description": "The zone's expected and published DS records, and whether they match.",
            "headers": {
              "X-Request-Id": {
                "$ref": "#/components/headers/XRequestId"
              },
              "X-RateLimit-Limit": {
                "$ref": "#/components/headers/XRateLimitLimit"
              },
              "X-RateLimit-Remaining": {
                "$ref": "#/components/headers/XRateLimitRemaining"
              },
              "X-RateLimit-Reset": {
                "$ref": "#/components/headers/XRateLimitReset"
              }
            },
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/DnsHealthDnsSecCheck"
                },
                "examples": {
                  "active": {
                    "summary": "Published DS matches DigiCert's expected DS",
                    "value": {
                      "status": "ACTIVE",
                      "expectedDsRecords": [
                        "63745 13 2 F1E184C0E1D615D20EB3C223ACED3B03676BBB2DA1721A57F58F82F92B4AAB55"
                      ],
                      "liveDsRecords": [
                        "63745 13 2 F1E184C0E1D615D20EB3C223ACED3B03676BBB2DA1721A57F58F82F92B4AAB55"
                      ]
                    }
                  },
                  "pending": {
                    "summary": "Signed, but no DS published at the registrar yet",
                    "description": "The parent zone confirmed that no DS record is\npublished (NXDOMAIN or NODATA). This is expected until\nthe DS record is added at the registrar.\n",
                    "value": {
                      "status": "PENDING",
                      "expectedDsRecords": [
                        "63745 13 2 F1E184C0E1D615D20EB3C223ACED3B03676BBB2DA1721A57F58F82F92B4AAB55"
                      ],
                      "liveDsRecords": []
                    }
                  },
                  "mismatch": {
                    "summary": "Published DS does not match DigiCert's expected DS",
                    "value": {
                      "status": "MISMATCH",
                      "expectedDsRecords": [
                        "63745 13 2 F1E184C0E1D615D20EB3C223ACED3B03676BBB2DA1721A57F58F82F92B4AAB55"
                      ],
                      "liveDsRecords": [
                        "51331 13 2 A1B2C3D4E5F60718293A4B5C6D7E8F901A2B3C4D5E6F708192A3B4C5D6E7F809"
                      ]
                    }
                  },
                  "lookupFailure": {
                    "summary": "The live DS lookup could not be completed",
                    "description": "A resolver or network error, not a confirmed absence\nof DS records. Different from `PENDING`.\n",
                    "value": {
                      "status": "LOOKUP_FAILURE",
                      "expectedDsRecords": [
                        "63745 13 2 F1E184C0E1D615D20EB3C223ACED3B03676BBB2DA1721A57F58F82F92B4AAB55"
                      ],
                      "liveDsRecords": []
                    }
                  },
                  "unsignedZone": {
                    "summary": "Zone is not signed",
                    "description": "The zone has no active KSK, so there's no expected DS\nrecord to compare.\n",
                    "value": {
                      "status": "UNSIGNED",
                      "expectedDsRecords": [],
                      "liveDsRecords": []
                    }
                  }
                }
              }
            }
          },
          "400": {
            "$ref": "#/components/responses/BadRequest"
          },
          "401": {
            "$ref": "#/components/responses/Unauthorized"
          },
          "403": {
            "$ref": "#/components/responses/Forbidden"
          },
          "404": {
            "$ref": "#/components/responses/NotFound"
          },
          "429": {
            "$ref": "#/components/responses/TooManyRequests"
          },
          "500": {
            "$ref": "#/components/responses/InternalServerError"
          },
          "502": {
            "$ref": "#/components/responses/BadGateway"
          },
          "503": {
            "$ref": "#/components/responses/ServiceUnavailable"
          },
          "504": {
            "$ref": "#/components/responses/GatewayTimeout"
          }
        }
      }
    },
    "/zones:export": {
      "post": {
        "operationId": "exportZones",
        "x-required-permission": "account.zones:read",
        "summary": "Export zones as BIND zone files",
        "description": "Starts a task that exports up to 250 zones as BIND zone files in one\nZIP archive. The response is `202 Accepted`, with a `Location`\nheader that points to an `AsyncTask`. When the task finishes, it\nprovides a URL to download the archive.\n\n**Zones that can't be exported are skipped**\n\nZones that don't exist, or that you don't have permission to read,\nare left out of the archive without an error. The task still ends\nas `SUCCEEDED`, so the archive can contain fewer zones than you\nrequested, or none. To find skipped zones, compare the files in the\narchive with the zones you requested.\n\nIf the export can't run at all, for example because a service is\nunavailable, the task ends as `FAILED` and no archive is created.\n",
        "tags": [
          "Zones"
        ],
        "parameters": [
          {
            "$ref": "#/components/parameters/IdempotencyKey"
          },
          {
            "$ref": "#/components/parameters/XRequestId"
          }
        ],
        "requestBody": {
          "required": true,
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/ZoneExportRequest"
              },
              "examples": {
                "exportSelectedZones": {
                  "summary": "Export two zones",
                  "value": {
                    "zoneNames": [
                      "example.com.",
                      "another.example.net."
                    ]
                  }
                }
              }
            }
          }
        },
        "responses": {
          "202": {
            "description": "The export was accepted and runs in the background. The\n`Location` header points to the task. Poll it for the result\nand the download URL.\n",
            "headers": {
              "Location": {
                "$ref": "#/components/headers/Location"
              },
              "X-Request-Id": {
                "$ref": "#/components/headers/XRequestId"
              },
              "X-Idempotent-Replayed": {
                "$ref": "#/components/headers/XIdempotentReplayed"
              },
              "X-RateLimit-Limit": {
                "$ref": "#/components/headers/XRateLimitLimit"
              },
              "X-RateLimit-Remaining": {
                "$ref": "#/components/headers/XRateLimitRemaining"
              },
              "X-RateLimit-Reset": {
                "$ref": "#/components/headers/XRateLimitReset"
              }
            },
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/AsyncTask"
                },
                "examples": {
                  "accepted": {
                    "summary": "Zone export task representation",
                    "value": {
                      "id": "550e8400-e29b-41d4-a716-446655440000",
                      "status": "PENDING",
                      "type": "zone.export",
                      "submittedAt": "2026-06-05T14:00:00Z"
                    }
                  }
                }
              }
            }
          },
          "400": {
            "$ref": "#/components/responses/BadRequest"
          },
          "401": {
            "$ref": "#/components/responses/Unauthorized"
          },
          "403": {
            "$ref": "#/components/responses/Forbidden"
          },
          "422": {
            "$ref": "#/components/responses/UnprocessableEntity"
          },
          "429": {
            "$ref": "#/components/responses/TooManyRequests"
          },
          "500": {
            "$ref": "#/components/responses/InternalServerError"
          },
          "502": {
            "$ref": "#/components/responses/BadGateway"
          },
          "503": {
            "$ref": "#/components/responses/ServiceUnavailable"
          },
          "504": {
            "$ref": "#/components/responses/GatewayTimeout"
          }
        }
      }
    },
    "/zones/{zoneName}/records": {
      "parameters": [
        {
          "$ref": "#/components/parameters/ZoneName"
        }
      ],
      "get": {
        "operationId": "listResourceRecordSets",
        "x-required-permission": "account.zones.records:read",
        "summary": "List record sets",
        "description": "Returns the record sets in a zone, of every record type. To list\nthe record sets of one record type, use\n`GET /zones/{zoneName}/records/{rrtype}`.\n\n**Filters and search**\n\n- `name` matches text in the owner name.\n- `ttl` matches a range of TTLs, such as\n  `ttl[gte]=300&ttl[lte]=3600`.\n- `content` matches text in the record data of `NONE` record sets.\n- `globalSearch` matches text across the owner name, record type,\n  TTL, and record data in one query. You can't combine it with\n  `name`, `ttl`, `content`, `sortBy`, or `sortOrder`.\n\nMatching ignores case. If the filters can't all match at once, or\nyou combine `globalSearch` with a filter it doesn't allow, the API\nreturns `400 Bad Request`.\n\n**Regional views**\n\nFor a zone with regional views, the list returns the `GLOBAL`\nrecord sets by default. To see the zone as a region resolves it,\nsend `region`. The region's regional record sets replace the\nmatching `GLOBAL` record sets, and the rest fall back to `GLOBAL`.\nTo get only the region's regional record sets, also send\n`overrideRecordOnly=true`.\n\nThe API resolves the region's view first, then applies `ttl`,\n`content`, and `globalSearch` to it. So `ttl` matches the TTL that\nthe region uses. `name` matches the same way in every region,\nbecause a regional record set has the same owner name as its\n`GLOBAL` record set.\n\n**Who created each value**\n\nSend `systemGeneratedStatus=true` to add `routing.systemGenerated`\nto each `NONE` record set. It shows whether you or DigiCert DNS\ncreated each value in `routing.content`. `SIMPLE_FAILOVER` record\nsets always include `routing.systemGenerated`.\n",
        "tags": [
          "RRSets"
        ],
        "parameters": [
          {
            "$ref": "#/components/parameters/pageToken"
          },
          {
            "$ref": "#/components/parameters/pageSizeLarge"
          },
          {
            "$ref": "#/components/parameters/RegionQuery"
          },
          {
            "$ref": "#/components/parameters/OverrideRecordOnly"
          },
          {
            "$ref": "#/components/parameters/RRSetName"
          },
          {
            "$ref": "#/components/parameters/RRSetTtl"
          },
          {
            "$ref": "#/components/parameters/RRSetContent"
          },
          {
            "$ref": "#/components/parameters/SystemGeneratedStatus"
          },
          {
            "$ref": "#/components/parameters/RRSetSortBy"
          },
          {
            "$ref": "#/components/parameters/RRSetSortOrder"
          },
          {
            "$ref": "#/components/parameters/RRSetGlobalSearch"
          },
          {
            "$ref": "#/components/parameters/XRequestId"
          }
        ],
        "responses": {
          "200": {
            "description": "Record sets matching the request.",
            "headers": {
              "X-Request-Id": {
                "$ref": "#/components/headers/XRequestId"
              },
              "X-RateLimit-Limit": {
                "$ref": "#/components/headers/XRateLimitLimit"
              },
              "X-RateLimit-Remaining": {
                "$ref": "#/components/headers/XRateLimitRemaining"
              },
              "X-RateLimit-Reset": {
                "$ref": "#/components/headers/XRateLimitReset"
              }
            },
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/RRSetList"
                },
                "examples": {
                  "multipleRecords": {
                    "summary": "Multiple A record sets in the zone",
                    "value": {
                      "data": [
                        {
                          "zoneName": "example.com.",
                          "name": "www.example.com.",
                          "rrtype": "A",
                          "ttl": 300,
                          "routing": {
                            "policy": "NONE",
                            "content": [
                              "192.0.2.1",
                              "192.0.2.2"
                            ]
                          },
                          "createdAt": "2026-07-30T10:00:00Z",
                          "updatedAt": "2026-07-30T10:00:00Z"
                        },
                        {
                          "zoneName": "example.com.",
                          "name": "api.example.com.",
                          "rrtype": "A",
                          "ttl": 300,
                          "routing": {
                            "policy": "NONE",
                            "content": [
                              "192.0.2.10"
                            ]
                          },
                          "createdAt": "2026-07-30T10:00:00Z",
                          "updatedAt": "2026-07-30T10:00:00Z"
                        }
                      ],
                      "pagination": {
                        "hasMore": false,
                        "nextPageToken": null,
                        "prevPageToken": null,
                        "firstPageToken": null,
                        "lastPageToken": null
                      },
                      "totalCount": 2
                    }
                  },
                  "nameFilter": {
                    "summary": "Record sets filtered by owner name with name=www",
                    "value": {
                      "data": [
                        {
                          "zoneName": "example.com.",
                          "name": "www.example.com.",
                          "rrtype": "A",
                          "ttl": 300,
                          "routing": {
                            "policy": "NONE",
                            "content": [
                              "192.0.2.1",
                              "192.0.2.2"
                            ]
                          },
                          "createdAt": "2026-07-30T10:00:00Z",
                          "updatedAt": "2026-07-30T10:00:00Z"
                        }
                      ],
                      "pagination": {
                        "hasMore": false,
                        "nextPageToken": null,
                        "prevPageToken": null,
                        "firstPageToken": null,
                        "lastPageToken": null
                      },
                      "totalCount": 1
                    }
                  },
                  "mixedRoutingPolicies": {
                    "summary": "Record sets with the NONE and SIMPLE_FAILOVER routing policies",
                    "description": "How each routing policy appears in a list. `NONE` record\nsets return `routing.content`. `SIMPLE_FAILOVER` record\nsets return `routing.monitor`, `routing.endpoints`, and\n`routing.failureSensitivity`.\n",
                    "value": {
                      "data": [
                        {
                          "zoneName": "example.com.",
                          "name": "www.example.com.",
                          "rrtype": "A",
                          "ttl": 300,
                          "routing": {
                            "policy": "NONE",
                            "content": [
                              "192.0.2.1",
                              "192.0.2.2"
                            ]
                          },
                          "createdAt": "2026-07-30T10:00:00Z",
                          "updatedAt": "2026-07-30T10:00:00Z"
                        },
                        {
                          "zoneName": "example.com.",
                          "name": "failover.example.com.",
                          "rrtype": "A",
                          "ttl": 300,
                          "routing": {
                            "policy": "SIMPLE_FAILOVER",
                            "status": "Healthy",
                            "failureSensitivity": "MEDIUM",
                            "monitor": {
                              "protocol": "HTTPS",
                              "host": "www.example.com",
                              "port": 443,
                              "path": "/health",
                              "searchString": "OK"
                            },
                            "endpoints": [
                              {
                                "target": "192.0.2.10",
                                "priority": 1,
                                "isEnabled": true,
                                "health": "Healthy",
                                "isServing": true
                              },
                              {
                                "target": "192.0.2.11",
                                "priority": 2,
                                "isEnabled": true,
                                "health": "Healthy",
                                "isServing": false
                              }
                            ],
                            "systemGenerated": [
                              "USER_DEFINED",
                              "USER_DEFINED"
                            ]
                          },
                          "createdAt": "2026-07-30T10:00:00Z",
                          "updatedAt": "2026-07-30T10:00:00Z"
                        }
                      ],
                      "pagination": {
                        "hasMore": false,
                        "nextPageToken": null,
                        "prevPageToken": null,
                        "firstPageToken": null,
                        "lastPageToken": null
                      },
                      "totalCount": 2
                    }
                  },
                  "mixedRecordTypes": {
                    "summary": "Record sets of several types, some with structured record data",
                    "description": "A list with record types that have structured record\ndata and types that don't. The `A` record set returns\nonly `routing.content`. The `TLSA` and `HTTPS` record\nsets also return `routing.rdata`, with one entry for\neach value in `content`, in the same order.\n\nEach `rdata` entry has a `type` field that names its\nrecord type, so you can read it without the `rrtype`\nfrom the path.\n",
                    "value": {
                      "data": [
                        {
                          "zoneName": "example.com.",
                          "name": "www.example.com.",
                          "rrtype": "A",
                          "ttl": 300,
                          "routing": {
                            "policy": "NONE",
                            "content": [
                              "192.0.2.1"
                            ]
                          },
                          "createdAt": "2026-08-18T10:00:00Z",
                          "updatedAt": "2026-08-18T10:00:00Z"
                        },
                        {
                          "zoneName": "example.com.",
                          "name": "_443._tcp.www.example.com.",
                          "rrtype": "TLSA",
                          "ttl": 3600,
                          "routing": {
                            "policy": "NONE",
                            "content": [
                              "3 1 1 d2abde240d7cd3ee6b4b28c54df034b97983a1d16e8a410e4561cb106618e971",
                              "2 0 1 92003ba34942dc74152e2f2c408d29eca5a520e7f2e06bb944f4dca346baf63c"
                            ],
                            "rdata": [
                              {
                                "type": "TLSA",
                                "certUsage": 3,
                                "selector": 1,
                                "matchingType": 1,
                                "certificateData": "d2abde240d7cd3ee6b4b28c54df034b97983a1d16e8a410e4561cb106618e971"
                              },
                              {
                                "type": "TLSA",
                                "certUsage": 2,
                                "selector": 0,
                                "matchingType": 1,
                                "certificateData": "92003ba34942dc74152e2f2c408d29eca5a520e7f2e06bb944f4dca346baf63c"
                              }
                            ]
                          },
                          "createdAt": "2026-08-18T10:00:00Z",
                          "updatedAt": "2026-08-18T10:00:00Z"
                        },
                        {
                          "zoneName": "example.com.",
                          "name": "example.com.",
                          "rrtype": "HTTPS",
                          "ttl": 300,
                          "routing": {
                            "policy": "NONE",
                            "content": [
                              "1 . alpn=h2,h3 ipv4hint=192.0.2.10"
                            ],
                            "rdata": [
                              {
                                "type": "HTTPS",
                                "priority": 1,
                                "targetName": ".",
                                "alpn": [
                                  "h2",
                                  "h3"
                                ],
                                "ipv4hint": [
                                  "192.0.2.10"
                                ]
                              }
                            ]
                          },
                          "createdAt": "2026-08-18T10:00:00Z",
                          "updatedAt": "2026-08-18T10:00:00Z"
                        }
                      ],
                      "pagination": {
                        "hasMore": false,
                        "nextPageToken": null,
                        "prevPageToken": null,
                        "firstPageToken": null,
                        "lastPageToken": null
                      },
                      "totalCount": 3
                    }
                  },
                  "systemGeneratedRecords": {
                    "summary": "Values marked by who created them, with systemGeneratedStatus=true",
                    "description": "The response to\n`GET /zones/example.com./records?systemGeneratedStatus=true`.\nEach value in `routing.systemGenerated` matches the value\nin the same position in `routing.content`. Here,\n`NSSET` shows that `ns10.digicertdns.com.` comes from a\nNameserver Set bound to the zone.\n",
                    "value": {
                      "data": [
                        {
                          "zoneName": "example.com.",
                          "name": "example.com.",
                          "rrtype": "NS",
                          "ttl": 3600,
                          "routing": {
                            "policy": "NONE",
                            "content": [
                              "ns1.example.com.",
                              "ns10.digicertdns.com."
                            ],
                            "systemGenerated": [
                              "USER_DEFINED",
                              "NSSET"
                            ]
                          },
                          "createdAt": "2026-07-30T10:00:00Z",
                          "updatedAt": "2026-07-30T10:00:00Z"
                        }
                      ],
                      "pagination": {
                        "hasMore": false,
                        "nextPageToken": null,
                        "prevPageToken": null,
                        "firstPageToken": null,
                        "lastPageToken": null
                      },
                      "totalCount": 1
                    }
                  },
                  "regionalViewGlobal": {
                    "summary": "GLOBAL record sets in a zone with regional views",
                    "description": "In a zone with regional views, every record set includes\na `region` field. Without `region`, the list returns only\nthe `GLOBAL` record sets.\n",
                    "value": {
                      "data": [
                        {
                          "zoneName": "example.com.",
                          "name": "www.example.com.",
                          "rrtype": "A",
                          "ttl": 300,
                          "routing": {
                            "policy": "SIMPLE_FAILOVER",
                            "status": "Healthy",
                            "failureSensitivity": "MEDIUM",
                            "monitor": {
                              "protocol": "HTTPS",
                              "host": "www.example.com",
                              "port": 443,
                              "path": "/health",
                              "searchString": "OK"
                            },
                            "endpoints": [
                              {
                                "target": "192.0.2.1",
                                "priority": 1,
                                "isEnabled": true,
                                "health": "Healthy",
                                "isServing": true
                              },
                              {
                                "target": "192.0.2.2",
                                "priority": 2,
                                "isEnabled": true,
                                "health": "Healthy",
                                "isServing": false
                              },
                              {
                                "target": "192.0.2.3",
                                "priority": 3,
                                "isEnabled": true,
                                "health": "Unhealthy",
                                "isServing": false
                              }
                            ],
                            "systemGenerated": [
                              "USER_DEFINED",
                              "USER_DEFINED",
                              "USER_DEFINED"
                            ]
                          },
                          "region": "GLOBAL",
                          "createdAt": "2026-07-30T10:00:00Z",
                          "updatedAt": "2026-07-30T10:00:00Z"
                        },
                        {
                          "zoneName": "example.com.",
                          "name": "api.example.com.",
                          "rrtype": "A",
                          "ttl": 300,
                          "routing": {
                            "policy": "NONE",
                            "content": [
                              "192.0.2.10"
                            ]
                          },
                          "region": "GLOBAL",
                          "createdAt": "2026-07-30T10:00:00Z",
                          "updatedAt": "2026-07-30T10:00:00Z"
                        }
                      ],
                      "pagination": {
                        "hasMore": false,
                        "nextPageToken": null,
                        "prevPageToken": null,
                        "firstPageToken": null,
                        "lastPageToken": null
                      },
                      "totalCount": 2
                    }
                  },
                  "regionalViewWithFallback": {
                    "summary": "A region's view, with GLOBAL fallback",
                    "description": "The response to\n`GET /zones/example.com./records?region=EUROPE`. The\n`EUROPE` regional record set replaces the matching\n`GLOBAL` record set. The record set without a regional\nrecord set comes from `GLOBAL`.\n",
                    "value": {
                      "data": [
                        {
                          "zoneName": "example.com.",
                          "name": "www.example.com.",
                          "rrtype": "A",
                          "ttl": 300,
                          "routing": {
                            "policy": "SIMPLE_FAILOVER",
                            "status": "Healthy",
                            "failureSensitivity": "MEDIUM",
                            "monitor": {
                              "protocol": "HTTPS",
                              "host": "www.example.com",
                              "port": 443,
                              "path": "/health",
                              "searchString": "OK"
                            },
                            "endpoints": [
                              {
                                "target": "192.0.2.20",
                                "priority": 1,
                                "isEnabled": true,
                                "health": "Healthy",
                                "isServing": true
                              }
                            ],
                            "systemGenerated": [
                              "USER_DEFINED"
                            ]
                          },
                          "region": "EUROPE",
                          "createdAt": "2026-07-30T10:00:00Z",
                          "updatedAt": "2026-07-30T10:00:00Z"
                        },
                        {
                          "zoneName": "example.com.",
                          "name": "api.example.com.",
                          "rrtype": "A",
                          "ttl": 300,
                          "routing": {
                            "policy": "NONE",
                            "content": [
                              "192.0.2.10"
                            ]
                          },
                          "region": "GLOBAL",
                          "createdAt": "2026-07-30T10:00:00Z",
                          "updatedAt": "2026-07-30T10:00:00Z"
                        }
                      ],
                      "pagination": {
                        "hasMore": false,
                        "nextPageToken": null,
                        "prevPageToken": null,
                        "firstPageToken": null,
                        "lastPageToken": null
                      },
                      "totalCount": 2
                    }
                  },
                  "regionalViewOverridesOnly": {
                    "summary": "Regional record sets only",
                    "description": "The response to\n`GET /zones/example.com./records?region=EUROPE&overrideRecordOnly=true`.\nIt includes only record sets with a `EUROPE` regional\nrecord set, and leaves out the `GLOBAL` record sets.\n",
                    "value": {
                      "data": [
                        {
                          "zoneName": "example.com.",
                          "name": "www.example.com.",
                          "rrtype": "A",
                          "ttl": 300,
                          "routing": {
                            "policy": "SIMPLE_FAILOVER",
                            "status": "Healthy",
                            "failureSensitivity": "MEDIUM",
                            "monitor": {
                              "protocol": "HTTPS",
                              "host": "www.example.com",
                              "port": 443,
                              "path": "/health",
                              "searchString": "OK"
                            },
                            "endpoints": [
                              {
                                "target": "192.0.2.20",
                                "priority": 1,
                                "isEnabled": true,
                                "health": "Healthy",
                                "isServing": true
                              }
                            ],
                            "systemGenerated": [
                              "USER_DEFINED"
                            ]
                          },
                          "region": "EUROPE",
                          "createdAt": "2026-07-30T10:00:00Z",
                          "updatedAt": "2026-07-30T10:00:00Z"
                        }
                      ],
                      "pagination": {
                        "hasMore": false,
                        "nextPageToken": null,
                        "prevPageToken": null,
                        "firstPageToken": null,
                        "lastPageToken": null
                      },
                      "totalCount": 1
                    }
                  },
                  "regionalViewExcluded": {
                    "summary": "A GLOBAL record set that the region excludes",
                    "description": "The response to\n`GET /zones/example.com./records?region=EUROPE` when\n`EUROPE` has an exclusion for the record set. The list\nstill includes the `GLOBAL` record set, with\n`isExcluded: true`. `EUROPE` serves no records for this\nowner name and record type, not even the `GLOBAL`\nones.\n",
                    "value": {
                      "data": [
                        {
                          "zoneName": "example.com.",
                          "name": "www.example.com.",
                          "rrtype": "A",
                          "ttl": 300,
                          "routing": {
                            "policy": "NONE",
                            "content": [
                              "192.0.2.1"
                            ]
                          },
                          "region": "GLOBAL",
                          "isExcluded": true,
                          "createdAt": "2026-07-30T10:00:00Z",
                          "updatedAt": "2026-07-30T10:00:00Z"
                        }
                      ],
                      "pagination": {
                        "hasMore": false,
                        "nextPageToken": null,
                        "prevPageToken": null,
                        "firstPageToken": null,
                        "lastPageToken": null
                      },
                      "totalCount": 1
                    }
                  },
                  "pagedResult": {
                    "summary": "First page of a larger result",
                    "description": "`totalCount` counts every record set that matches the\nrequest, not only the ones on this page. Here, 47 record\nsets match, and the page returns 2.\n",
                    "value": {
                      "data": [
                        {
                          "zoneName": "example.com.",
                          "name": "www.example.com.",
                          "rrtype": "A",
                          "ttl": 300,
                          "routing": {
                            "policy": "NONE",
                            "content": [
                              "192.0.2.1"
                            ]
                          },
                          "createdAt": "2026-07-30T10:00:00Z",
                          "updatedAt": "2026-07-30T10:00:00Z"
                        },
                        {
                          "zoneName": "example.com.",
                          "name": "api.example.com.",
                          "rrtype": "A",
                          "ttl": 300,
                          "routing": {
                            "policy": "NONE",
                            "content": [
                              "192.0.2.10"
                            ]
                          },
                          "createdAt": "2026-07-30T10:00:00Z",
                          "updatedAt": "2026-07-30T10:00:00Z"
                        }
                      ],
                      "pagination": {
                        "hasMore": true,
                        "nextPageToken": "eyJvZmZzZXQiOjJ9",
                        "prevPageToken": null,
                        "firstPageToken": null,
                        "lastPageToken": "eyJvZmZzZXQiOjQ1fQ"
                      },
                      "totalCount": 47
                    }
                  },
                  "totalCountUnknown": {
                    "summary": "Total count not available",
                    "description": "`totalCount` is `null` when the API doesn't count the\nexact total for a query, for example because the result\nis large. The record sets and page tokens aren't\naffected.\n",
                    "value": {
                      "data": [
                        {
                          "zoneName": "example.com.",
                          "name": "www.example.com.",
                          "rrtype": "A",
                          "ttl": 300,
                          "routing": {
                            "policy": "NONE",
                            "content": [
                              "192.0.2.1"
                            ]
                          },
                          "createdAt": "2026-07-30T10:00:00Z",
                          "updatedAt": "2026-07-30T10:00:00Z"
                        }
                      ],
                      "pagination": {
                        "hasMore": false,
                        "nextPageToken": null,
                        "prevPageToken": null,
                        "firstPageToken": null,
                        "lastPageToken": null
                      },
                      "totalCount": null
                    }
                  },
                  "globalSearchResults": {
                    "summary": "Wildcard search with globalSearch=www*",
                    "description": "The response to\n`GET /zones/example.com./records?globalSearch=www*`. A\nrecord set matches when its owner name, record type,\nTTL, or record data matches the pattern. Search works\nthe same way for `PRIMARY` and `SECONDARY` zones.\n",
                    "value": {
                      "data": [
                        {
                          "zoneName": "example.com.",
                          "name": "www.example.com.",
                          "rrtype": "A",
                          "ttl": 300,
                          "routing": {
                            "policy": "NONE",
                            "content": [
                              "192.0.2.1"
                            ]
                          },
                          "createdAt": "2026-07-30T10:00:00Z",
                          "updatedAt": "2026-07-30T10:00:00Z"
                        },
                        {
                          "zoneName": "example.com.",
                          "name": "www2.example.com.",
                          "rrtype": "AAAA",
                          "ttl": 300,
                          "routing": {
                            "policy": "NONE",
                            "content": [
                              "2001:db8::1"
                            ]
                          },
                          "createdAt": "2026-07-30T10:00:00Z",
                          "updatedAt": "2026-07-30T10:00:00Z"
                        }
                      ],
                      "pagination": {
                        "hasMore": false,
                        "nextPageToken": null,
                        "prevPageToken": null,
                        "firstPageToken": null,
                        "lastPageToken": null
                      },
                      "totalCount": 2
                    }
                  },
                  "emptyResult": {
                    "summary": "No record sets in the zone",
                    "value": {
                      "data": [],
                      "pagination": {
                        "hasMore": false,
                        "nextPageToken": null,
                        "prevPageToken": null,
                        "firstPageToken": null,
                        "lastPageToken": null
                      },
                      "totalCount": 0
                    }
                  }
                }
              }
            }
          },
          "400": {
            "$ref": "#/components/responses/BadRequestRRSet"
          },
          "401": {
            "$ref": "#/components/responses/Unauthorized"
          },
          "403": {
            "$ref": "#/components/responses/Forbidden"
          },
          "404": {
            "$ref": "#/components/responses/NotFound"
          },
          "429": {
            "$ref": "#/components/responses/TooManyRequests"
          },
          "500": {
            "$ref": "#/components/responses/InternalServerError"
          },
          "502": {
            "$ref": "#/components/responses/BadGateway"
          },
          "503": {
            "$ref": "#/components/responses/ServiceUnavailable"
          },
          "504": {
            "$ref": "#/components/responses/GatewayTimeout"
          }
        }
      },
      "patch": {
        "operationId": "importZoneRecords",
        "x-required-permission": "account.zones.records:update",
        "summary": "Import records from a zone file",
        "description": "Imports records into a zone from a zone file in BIND format\n(RFC 1035). The import can add new records and replace existing ones.\n\nThe import runs asynchronously. The response is `202 Accepted`,\nwith a `Location` header that points to an `AsyncTask`. Poll the\ntask for progress and the result.\n\nSend the zone file in one of two ways:\n\n- As `multipart/form-data`, with the file in a binary `file` part.\n  The file can be up to 12 MB.\n- As `application/json`, with the file base64-encoded in `file`.\n  The whole request body can be up to 256 KB, so the decoded file\n  can be up to about 190 KB. For a larger file, use\n  `multipart/form-data`. If the body is larger than 256 KB, the API\n  returns `413`.\n",
        "tags": [
          "RRSets"
        ],
        "parameters": [
          {
            "$ref": "#/components/parameters/IdempotencyKey"
          },
          {
            "$ref": "#/components/parameters/XRequestId"
          }
        ],
        "requestBody": {
          "required": true,
          "content": {
            "application/json": {
              "schema": {
                "type": "object",
                "required": [
                  "file"
                ],
                "properties": {
                  "file": {
                    "type": "string",
                    "format": "byte",
                    "description": "The zone file in BIND format (RFC 1035), base64-encoded.\nThe whole request body can be up to 256 KB, so the\ndecoded file can be up to about 190 KB.\n"
                  }
                }
              },
              "examples": {
                "base64Payload": {
                  "summary": "JSON upload with a base64-encoded zone file",
                  "value": {
                    "file": "JE9SSUdJTiBleGFtcGxlLmNvbS4KQCAzNjAwIElOIFNPQSBuczEuZXhhbXBsZS5jb20uIGhvc3RtYXN0ZXIuZXhhbXBsZS5jb20uICgxIDIgMyA0IDUp"
                  }
                }
              }
            },
            "multipart/form-data": {
              "schema": {
                "type": "object",
                "required": [
                  "file"
                ],
                "properties": {
                  "file": {
                    "type": "string",
                    "format": "binary",
                    "description": "The zone file in BIND format (RFC 1035). It can be up to 12 MB."
                  }
                }
              },
              "encoding": {
                "file": {
                  "contentType": "text/plain"
                }
              },
              "examples": {
                "multipartUpload": {
                  "summary": "Multipart upload with a zone file part",
                  "value": {
                    "file": "(binary)"
                  }
                }
              }
            }
          }
        },
        "responses": {
          "202": {
            "description": "The API accepted the import. Poll the task in the `Location`\nheader for progress and the result.\n",
            "headers": {
              "Location": {
                "$ref": "#/components/headers/Location"
              },
              "X-Request-Id": {
                "$ref": "#/components/headers/XRequestId"
              },
              "X-Idempotent-Replayed": {
                "$ref": "#/components/headers/XIdempotentReplayed"
              },
              "X-RateLimit-Limit": {
                "$ref": "#/components/headers/XRateLimitLimit"
              },
              "X-RateLimit-Remaining": {
                "$ref": "#/components/headers/XRateLimitRemaining"
              },
              "X-RateLimit-Reset": {
                "$ref": "#/components/headers/XRateLimitReset"
              }
            },
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/AsyncTask"
                },
                "examples": {
                  "accepted": {
                    "summary": "The import task",
                    "value": {
                      "id": "8c1e9a4b-2d6f-4711-b3a8-1e2c7f9d8a4b",
                      "status": "PENDING",
                      "type": "zone.records.import",
                      "submittedAt": "2026-06-05T14:00:00Z"
                    }
                  }
                }
              }
            }
          },
          "400": {
            "$ref": "#/components/responses/BadRequest"
          },
          "401": {
            "$ref": "#/components/responses/Unauthorized"
          },
          "403": {
            "$ref": "#/components/responses/Forbidden"
          },
          "404": {
            "$ref": "#/components/responses/NotFound"
          },
          "409": {
            "$ref": "#/components/responses/Conflict"
          },
          "413": {
            "$ref": "#/components/responses/PayloadTooLarge"
          },
          "415": {
            "$ref": "#/components/responses/UnsupportedMediaType"
          },
          "429": {
            "$ref": "#/components/responses/TooManyRequests"
          },
          "500": {
            "$ref": "#/components/responses/InternalServerError"
          },
          "502": {
            "$ref": "#/components/responses/BadGateway"
          },
          "503": {
            "$ref": "#/components/responses/ServiceUnavailable"
          },
          "504": {
            "$ref": "#/components/responses/GatewayTimeout"
          }
        }
      }
    },
    "/zones/{zoneName}/records/{rrtype}": {
      "parameters": [
        {
          "$ref": "#/components/parameters/ZoneName"
        },
        {
          "$ref": "#/components/parameters/RecordType"
        }
      ],
      "get": {
        "operationId": "listResourceRecordSetsByType",
        "x-required-permission": "account.zones.records:read",
        "summary": "List record sets by type",
        "description": "Returns the record sets of one record type in a zone. To list every\nrecord type, use `GET /zones/{zoneName}/records`.\n\n**Search**\n\n`globalSearch` matches text across the owner name, record type,\nTTL, and record data in one query. It searches only record sets of\nthe record type in the path.\n\n**Regional views**\n\nFor a zone with regional views, the list returns the `GLOBAL`\nrecord sets by default. To see the zone as a region resolves it,\nsend `region`. The region's regional record sets replace the\nmatching `GLOBAL` record sets, and the rest fall back to `GLOBAL`.\nTo get only the region's regional record sets, also send\n`overrideRecordOnly=true`. The API resolves the region's view\nbefore it applies `globalSearch`.\n\n**Who created each value**\n\nSend `systemGeneratedStatus=true` to add `routing.systemGenerated`\nto each `NONE` record set. It shows whether you or DigiCert DNS\ncreated each value in `routing.content`. `SIMPLE_FAILOVER` record\nsets always include `routing.systemGenerated`.\n",
        "tags": [
          "RRSets"
        ],
        "parameters": [
          {
            "$ref": "#/components/parameters/pageToken"
          },
          {
            "$ref": "#/components/parameters/pageSizeLarge"
          },
          {
            "$ref": "#/components/parameters/RegionQuery"
          },
          {
            "$ref": "#/components/parameters/OverrideRecordOnly"
          },
          {
            "$ref": "#/components/parameters/SystemGeneratedStatus"
          },
          {
            "$ref": "#/components/parameters/RRSetGlobalSearch"
          },
          {
            "$ref": "#/components/parameters/XRequestId"
          }
        ],
        "responses": {
          "200": {
            "description": "Record sets matching the request.",
            "headers": {
              "X-Request-Id": {
                "$ref": "#/components/headers/XRequestId"
              },
              "X-RateLimit-Limit": {
                "$ref": "#/components/headers/XRateLimitLimit"
              },
              "X-RateLimit-Remaining": {
                "$ref": "#/components/headers/XRateLimitRemaining"
              },
              "X-RateLimit-Reset": {
                "$ref": "#/components/headers/XRateLimitReset"
              }
            },
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/RRSetList"
                },
                "examples": {
                  "multipleRecords": {
                    "summary": "Multiple A record sets in the zone",
                    "value": {
                      "data": [
                        {
                          "zoneName": "example.com.",
                          "name": "www.example.com.",
                          "rrtype": "A",
                          "ttl": 300,
                          "routing": {
                            "policy": "NONE",
                            "content": [
                              "192.0.2.1",
                              "192.0.2.2"
                            ]
                          },
                          "createdAt": "2026-07-30T10:00:00Z",
                          "updatedAt": "2026-07-30T10:00:00Z"
                        },
                        {
                          "zoneName": "example.com.",
                          "name": "api.example.com.",
                          "rrtype": "A",
                          "ttl": 300,
                          "routing": {
                            "policy": "NONE",
                            "content": [
                              "192.0.2.10"
                            ]
                          },
                          "createdAt": "2026-07-30T10:00:00Z",
                          "updatedAt": "2026-07-30T10:00:00Z"
                        }
                      ],
                      "pagination": {
                        "hasMore": false,
                        "nextPageToken": null,
                        "prevPageToken": null,
                        "firstPageToken": null,
                        "lastPageToken": null
                      },
                      "totalCount": 2
                    }
                  },
                  "mixedRoutingPolicies": {
                    "summary": "A record sets with the NONE and SIMPLE_FAILOVER routing policies",
                    "description": "Every record set has the record type from the path, but\neach uses a different routing policy. `NONE` record sets\nreturn `routing.content`. `SIMPLE_FAILOVER` record sets\nreturn `routing.monitor` and `routing.endpoints`.\n",
                    "value": {
                      "data": [
                        {
                          "zoneName": "example.com.",
                          "name": "www.example.com.",
                          "rrtype": "A",
                          "ttl": 300,
                          "routing": {
                            "policy": "NONE",
                            "content": [
                              "192.0.2.1",
                              "192.0.2.2"
                            ]
                          },
                          "createdAt": "2026-07-30T10:00:00Z",
                          "updatedAt": "2026-07-30T10:00:00Z"
                        },
                        {
                          "zoneName": "example.com.",
                          "name": "failover.example.com.",
                          "rrtype": "A",
                          "ttl": 300,
                          "routing": {
                            "policy": "SIMPLE_FAILOVER",
                            "status": "Healthy",
                            "failureSensitivity": "MEDIUM",
                            "monitor": {
                              "protocol": "HTTPS",
                              "host": "www.example.com",
                              "port": 443,
                              "path": "/health",
                              "searchString": "OK"
                            },
                            "endpoints": [
                              {
                                "target": "192.0.2.10",
                                "priority": 1,
                                "isEnabled": true,
                                "health": "Healthy",
                                "isServing": true
                              },
                              {
                                "target": "192.0.2.11",
                                "priority": 2,
                                "isEnabled": true,
                                "health": "Healthy",
                                "isServing": false
                              }
                            ],
                            "systemGenerated": [
                              "USER_DEFINED",
                              "USER_DEFINED"
                            ]
                          },
                          "createdAt": "2026-07-30T10:00:00Z",
                          "updatedAt": "2026-07-30T10:00:00Z"
                        }
                      ],
                      "pagination": {
                        "hasMore": false,
                        "nextPageToken": null,
                        "prevPageToken": null,
                        "firstPageToken": null,
                        "lastPageToken": null
                      },
                      "totalCount": 2
                    }
                  },
                  "structuredType": {
                    "summary": "TLSA record sets with structured record data",
                    "description": "For a record type with structured record data, each\nrecord set returns `routing.rdata` as well as\n`routing.content`. Each `rdata` entry matches the\n`content` value in the same position.\n",
                    "value": {
                      "data": [
                        {
                          "zoneName": "example.com.",
                          "name": "_443._tcp.www.example.com.",
                          "rrtype": "TLSA",
                          "ttl": 3600,
                          "routing": {
                            "policy": "NONE",
                            "content": [
                              "3 1 1 d2abde240d7cd3ee6b4b28c54df034b97983a1d16e8a410e4561cb106618e971"
                            ],
                            "rdata": [
                              {
                                "type": "TLSA",
                                "certUsage": 3,
                                "selector": 1,
                                "matchingType": 1,
                                "certificateData": "d2abde240d7cd3ee6b4b28c54df034b97983a1d16e8a410e4561cb106618e971"
                              }
                            ]
                          },
                          "createdAt": "2026-08-18T10:00:00Z",
                          "updatedAt": "2026-08-18T10:00:00Z"
                        }
                      ],
                      "pagination": {
                        "hasMore": false,
                        "nextPageToken": null,
                        "prevPageToken": null,
                        "firstPageToken": null,
                        "lastPageToken": null
                      },
                      "totalCount": 1
                    }
                  },
                  "systemGeneratedRecords": {
                    "summary": "NS values marked by who created them, with systemGeneratedStatus=true",
                    "description": "The response to\n`GET /zones/example.com./records/NS?systemGeneratedStatus=true`.\nEach value in `routing.systemGenerated` matches the value\nin the same position in `routing.content`. Here,\n`NSSET` shows that `ns10.digicertdns.com.` comes from a\nNameserver Set bound to the zone.\n",
                    "value": {
                      "data": [
                        {
                          "zoneName": "example.com.",
                          "name": "example.com.",
                          "rrtype": "NS",
                          "ttl": 3600,
                          "routing": {
                            "policy": "NONE",
                            "content": [
                              "ns1.example.com.",
                              "ns10.digicertdns.com."
                            ],
                            "systemGenerated": [
                              "USER_DEFINED",
                              "NSSET"
                            ]
                          },
                          "createdAt": "2026-07-30T10:00:00Z",
                          "updatedAt": "2026-07-30T10:00:00Z"
                        }
                      ],
                      "pagination": {
                        "hasMore": false,
                        "nextPageToken": null,
                        "prevPageToken": null,
                        "firstPageToken": null,
                        "lastPageToken": null
                      },
                      "totalCount": 1
                    }
                  },
                  "regionalViewWithFallback": {
                    "summary": "A region's view, with GLOBAL fallback",
                    "description": "The response to\n`GET /zones/example.com./records/A?region=EUROPE`. The\n`EUROPE` regional record set replaces the matching\n`GLOBAL` record set. The record set without a regional\nrecord set comes from `GLOBAL`.\n",
                    "value": {
                      "data": [
                        {
                          "zoneName": "example.com.",
                          "name": "www.example.com.",
                          "rrtype": "A",
                          "ttl": 300,
                          "routing": {
                            "policy": "NONE",
                            "content": [
                              "192.0.2.20"
                            ]
                          },
                          "region": "EUROPE",
                          "createdAt": "2026-07-30T10:00:00Z",
                          "updatedAt": "2026-07-30T10:00:00Z"
                        },
                        {
                          "zoneName": "example.com.",
                          "name": "api.example.com.",
                          "rrtype": "A",
                          "ttl": 300,
                          "routing": {
                            "policy": "NONE",
                            "content": [
                              "192.0.2.10"
                            ]
                          },
                          "region": "GLOBAL",
                          "createdAt": "2026-07-30T10:00:00Z",
                          "updatedAt": "2026-07-30T10:00:00Z"
                        }
                      ],
                      "pagination": {
                        "hasMore": false,
                        "nextPageToken": null,
                        "prevPageToken": null,
                        "firstPageToken": null,
                        "lastPageToken": null
                      },
                      "totalCount": 2
                    }
                  },
                  "regionalViewOverridesOnly": {
                    "summary": "Regional record sets only",
                    "description": "The response to\n`GET /zones/example.com./records/A?region=EUROPE&overrideRecordOnly=true`.\nIt includes only record sets with a `EUROPE` regional\nrecord set, and leaves out the `GLOBAL` record sets.\n",
                    "value": {
                      "data": [
                        {
                          "zoneName": "example.com.",
                          "name": "www.example.com.",
                          "rrtype": "A",
                          "ttl": 300,
                          "routing": {
                            "policy": "NONE",
                            "content": [
                              "192.0.2.20"
                            ]
                          },
                          "region": "EUROPE",
                          "createdAt": "2026-07-30T10:00:00Z",
                          "updatedAt": "2026-07-30T10:00:00Z"
                        }
                      ],
                      "pagination": {
                        "hasMore": false,
                        "nextPageToken": null,
                        "prevPageToken": null,
                        "firstPageToken": null,
                        "lastPageToken": null
                      },
                      "totalCount": 1
                    }
                  },
                  "pagedResult": {
                    "summary": "First page of a larger result",
                    "description": "`totalCount` counts every record set of this type that\nmatches the request, not only the ones on this page.\nHere, 47 record sets match, and the page returns 2.\n",
                    "value": {
                      "data": [
                        {
                          "zoneName": "example.com.",
                          "name": "www.example.com.",
                          "rrtype": "A",
                          "ttl": 300,
                          "routing": {
                            "policy": "NONE",
                            "content": [
                              "192.0.2.1"
                            ]
                          },
                          "createdAt": "2026-07-30T10:00:00Z",
                          "updatedAt": "2026-07-30T10:00:00Z"
                        },
                        {
                          "zoneName": "example.com.",
                          "name": "api.example.com.",
                          "rrtype": "A",
                          "ttl": 300,
                          "routing": {
                            "policy": "NONE",
                            "content": [
                              "192.0.2.10"
                            ]
                          },
                          "createdAt": "2026-07-30T10:00:00Z",
                          "updatedAt": "2026-07-30T10:00:00Z"
                        }
                      ],
                      "pagination": {
                        "hasMore": true,
                        "nextPageToken": "eyJvZmZzZXQiOjJ9",
                        "prevPageToken": null,
                        "firstPageToken": null,
                        "lastPageToken": "eyJvZmZzZXQiOjQ1fQ"
                      },
                      "totalCount": 47
                    }
                  },
                  "totalCountUnknown": {
                    "summary": "Total count not available",
                    "description": "`totalCount` is `null` when the API doesn't count the\nexact total for a query, for example because the result\nis large. The record sets and page tokens aren't\naffected.\n",
                    "value": {
                      "data": [
                        {
                          "zoneName": "example.com.",
                          "name": "www.example.com.",
                          "rrtype": "A",
                          "ttl": 300,
                          "routing": {
                            "policy": "NONE",
                            "content": [
                              "192.0.2.1"
                            ]
                          },
                          "createdAt": "2026-07-30T10:00:00Z",
                          "updatedAt": "2026-07-30T10:00:00Z"
                        }
                      ],
                      "pagination": {
                        "hasMore": false,
                        "nextPageToken": null,
                        "prevPageToken": null,
                        "firstPageToken": null,
                        "lastPageToken": null
                      },
                      "totalCount": null
                    }
                  },
                  "globalSearchResults": {
                    "summary": "Wildcard search with globalSearch=*192.0.2.*",
                    "description": "The response to\n`GET /zones/example.com./records/A?globalSearch=*192.0.2.*`.\nThe search covers only record sets of the record type in\nthe path. A record set matches when its owner name,\nrecord type, TTL, or record data matches the pattern.\nSearch works the same way for `PRIMARY` and `SECONDARY`\nzones.\n",
                    "value": {
                      "data": [
                        {
                          "zoneName": "example.com.",
                          "name": "www.example.com.",
                          "rrtype": "A",
                          "ttl": 300,
                          "routing": {
                            "policy": "NONE",
                            "content": [
                              "192.0.2.1"
                            ]
                          },
                          "createdAt": "2026-07-30T10:00:00Z",
                          "updatedAt": "2026-07-30T10:00:00Z"
                        }
                      ],
                      "pagination": {
                        "hasMore": false,
                        "nextPageToken": null,
                        "prevPageToken": null,
                        "firstPageToken": null,
                        "lastPageToken": null
                      },
                      "totalCount": 1
                    }
                  },
                  "emptyResult": {
                    "summary": "No record sets of this type in the zone",
                    "value": {
                      "data": [],
                      "pagination": {
                        "hasMore": false,
                        "nextPageToken": null,
                        "prevPageToken": null,
                        "firstPageToken": null,
                        "lastPageToken": null
                      },
                      "totalCount": 0
                    }
                  }
                }
              }
            }
          },
          "400": {
            "$ref": "#/components/responses/BadRequestRRSet"
          },
          "401": {
            "$ref": "#/components/responses/Unauthorized"
          },
          "403": {
            "$ref": "#/components/responses/Forbidden"
          },
          "404": {
            "$ref": "#/components/responses/NotFound"
          },
          "429": {
            "$ref": "#/components/responses/TooManyRequests"
          },
          "500": {
            "$ref": "#/components/responses/InternalServerError"
          },
          "502": {
            "$ref": "#/components/responses/BadGateway"
          },
          "503": {
            "$ref": "#/components/responses/ServiceUnavailable"
          },
          "504": {
            "$ref": "#/components/responses/GatewayTimeout"
          }
        }
      }
    },
    "/zones/{zoneName}/records/{rrtype}/{name}": {
      "parameters": [
        {
          "$ref": "#/components/parameters/ZoneName"
        },
        {
          "$ref": "#/components/parameters/RecordType"
        },
        {
          "$ref": "#/components/parameters/Name"
        }
      ],
      "get": {
        "operationId": "getResourceRecordSet",
        "x-required-permission": "account.zones.records:read",
        "summary": "Get a record set",
        "description": "Returns one record set, by record type and owner name. You can give\nthe owner name relative to the zone, such as `www`, or fully\nqualified, such as `www.example.com.`. Use `@` for the zone apex.\n\nSend `systemGeneratedStatus=true` to add `routing.systemGenerated`\nto a `NONE` record set. It shows whether you or DigiCert DNS created\neach value in `routing.content`. `SIMPLE_FAILOVER` record sets\nalways include `routing.systemGenerated`.\n",
        "tags": [
          "RRSets"
        ],
        "parameters": [
          {
            "$ref": "#/components/parameters/SystemGeneratedStatus"
          },
          {
            "$ref": "#/components/parameters/XRequestId"
          }
        ],
        "responses": {
          "200": {
            "description": "The matching record set.",
            "headers": {
              "X-Request-Id": {
                "$ref": "#/components/headers/XRequestId"
              },
              "X-RateLimit-Limit": {
                "$ref": "#/components/headers/XRateLimitLimit"
              },
              "X-RateLimit-Remaining": {
                "$ref": "#/components/headers/XRateLimitRemaining"
              },
              "X-RateLimit-Reset": {
                "$ref": "#/components/headers/XRateLimitReset"
              }
            },
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/RRSet"
                },
                "examples": {
                  "fullResponse": {
                    "summary": "A record set with all fields",
                    "value": {
                      "zoneName": "example.com.",
                      "name": "www.example.com.",
                      "rrtype": "A",
                      "ttl": 300,
                      "routing": {
                        "policy": "NONE",
                        "content": [
                          "192.0.2.1",
                          "192.0.2.2"
                        ]
                      },
                      "createdAt": "2026-07-30T10:00:00Z",
                      "updatedAt": "2026-07-30T10:00:00Z"
                    }
                  },
                  "standardA": {
                    "summary": "A record set",
                    "value": {
                      "zoneName": "example.com.",
                      "name": "a.example.com.",
                      "rrtype": "A",
                      "ttl": 300,
                      "routing": {
                        "policy": "NONE",
                        "content": [
                          "192.0.2.1"
                        ]
                      }
                    }
                  },
                  "standardAlias": {
                    "summary": "ALIAS record set",
                    "description": "An `ALIAS` record set resolves like a `CNAME`, but you\ncan use it at the zone apex, where a `CNAME` isn't\nallowed.\n",
                    "value": {
                      "zoneName": "example.com.",
                      "name": "example.com.",
                      "rrtype": "ALIAS",
                      "ttl": 300,
                      "routing": {
                        "policy": "NONE",
                        "content": [
                          "target.example.net."
                        ]
                      },
                      "createdAt": "2026-07-30T10:00:00Z",
                      "updatedAt": "2026-07-30T10:00:00Z"
                    }
                  },
                  "standardHttps": {
                    "summary": "HTTPS record set with structured record data",
                    "description": "The API returns `routing.rdata` with `routing.content`,\nwhichever format you used to write the record set.\n",
                    "value": {
                      "zoneName": "example.com.",
                      "name": "example.com.",
                      "rrtype": "HTTPS",
                      "ttl": 300,
                      "routing": {
                        "policy": "NONE",
                        "content": [
                          "1 . alpn=h2,h3 ipv4hint=192.0.2.10"
                        ],
                        "rdata": [
                          {
                            "type": "HTTPS",
                            "priority": 1,
                            "targetName": ".",
                            "alpn": [
                              "h2",
                              "h3"
                            ],
                            "ipv4hint": [
                              "192.0.2.10"
                            ]
                          }
                        ]
                      },
                      "createdAt": "2026-08-11T10:00:00Z",
                      "updatedAt": "2026-08-11T10:00:00Z"
                    }
                  },
                  "standardSvcb": {
                    "summary": "SVCB record set with structured record data",
                    "value": {
                      "zoneName": "example.com.",
                      "name": "_443._tcp.example.com.",
                      "rrtype": "SVCB",
                      "ttl": 300,
                      "routing": {
                        "policy": "NONE",
                        "content": [
                          "1 svc.example.net. alpn=h2 ipv4hint=192.0.2.10"
                        ],
                        "rdata": [
                          {
                            "type": "SVCB",
                            "priority": 1,
                            "targetName": "svc.example.net.",
                            "alpn": [
                              "h2"
                            ],
                            "ipv4hint": [
                              "192.0.2.10"
                            ]
                          }
                        ]
                      },
                      "createdAt": "2026-08-11T10:00:00Z",
                      "updatedAt": "2026-08-11T10:00:00Z"
                    }
                  },
                  "standardTlsa": {
                    "summary": "TLSA record set with structured record data",
                    "value": {
                      "zoneName": "example.com.",
                      "name": "_443._tcp.www.example.com.",
                      "rrtype": "TLSA",
                      "ttl": 300,
                      "routing": {
                        "policy": "NONE",
                        "content": [
                          "3 1 1 d2abde240d7cd3ee6b4b28c54df034b97983a1d16e8a410e4561cb106618e971"
                        ],
                        "rdata": [
                          {
                            "type": "TLSA",
                            "certUsage": 3,
                            "selector": 1,
                            "matchingType": 1,
                            "certificateData": "d2abde240d7cd3ee6b4b28c54df034b97983a1d16e8a410e4561cb106618e971"
                          }
                        ]
                      },
                      "createdAt": "2026-08-11T10:00:00Z",
                      "updatedAt": "2026-08-11T10:00:00Z"
                    }
                  },
                  "systemGeneratedRecord": {
                    "summary": "NS values marked by who created them, with systemGeneratedStatus=true",
                    "description": "The response to\n`GET /zones/example.com./records/NS/example.com.?systemGeneratedStatus=true`.\nEach value in `routing.systemGenerated` matches the value\nin the same position in `routing.content`. Here,\n`NSSET` shows that `ns10.digicertdns.com.` comes from a\nNameserver Set bound to the zone.\n",
                    "value": {
                      "zoneName": "example.com.",
                      "name": "example.com.",
                      "rrtype": "NS",
                      "ttl": 3600,
                      "routing": {
                        "policy": "NONE",
                        "content": [
                          "ns1.example.com.",
                          "ns10.digicertdns.com."
                        ],
                        "systemGenerated": [
                          "USER_DEFINED",
                          "NSSET"
                        ]
                      },
                      "createdAt": "2026-07-30T10:00:00Z",
                      "updatedAt": "2026-07-30T10:00:00Z"
                    }
                  },
                  "simpleFailover": {
                    "summary": "SIMPLE_FAILOVER record set",
                    "description": "The record set has `routing.monitor` and\n`routing.endpoints`, and no `routing.content`. Its\nanswers depend on the health of the endpoints, not on a\nfixed list of values.\n",
                    "value": {
                      "zoneName": "example.com.",
                      "name": "failover.example.com.",
                      "rrtype": "A",
                      "ttl": 300,
                      "routing": {
                        "policy": "SIMPLE_FAILOVER",
                        "status": "Healthy",
                        "failureSensitivity": "MEDIUM",
                        "monitor": {
                          "protocol": "HTTPS",
                          "host": "www.example.com",
                          "port": 443,
                          "path": "/health",
                          "searchString": "OK"
                        },
                        "endpoints": [
                          {
                            "target": "192.0.2.1",
                            "priority": 1,
                            "isEnabled": true,
                            "health": "Healthy",
                            "isServing": true
                          },
                          {
                            "target": "192.0.2.2",
                            "priority": 2,
                            "isEnabled": true,
                            "health": "Healthy",
                            "isServing": false
                          },
                          {
                            "target": "192.0.2.3",
                            "priority": 3,
                            "isEnabled": true,
                            "health": "Healthy",
                            "isServing": false
                          }
                        ],
                        "systemGenerated": [
                          "USER_DEFINED",
                          "USER_DEFINED",
                          "USER_DEFINED"
                        ]
                      },
                      "createdAt": "2026-07-30T10:00:00Z",
                      "updatedAt": "2026-07-30T10:00:00Z"
                    }
                  },
                  "regionalViewGlobal": {
                    "summary": "GLOBAL record set in a zone with regional views",
                    "description": "In a zone with regional views, `region` shows that this\nis the `GLOBAL` record set.\n",
                    "value": {
                      "zoneName": "example.com.",
                      "name": "www.example.com.",
                      "rrtype": "A",
                      "ttl": 300,
                      "routing": {
                        "policy": "NONE",
                        "content": [
                          "192.0.2.1"
                        ]
                      },
                      "region": "GLOBAL",
                      "createdAt": "2026-07-30T10:00:00Z",
                      "updatedAt": "2026-07-30T10:00:00Z"
                    }
                  },
                  "regionalViewOverride": {
                    "summary": "EUROPE regional record set",
                    "description": "A regional record set, with its own TTL and routing.\n",
                    "value": {
                      "zoneName": "example.com.",
                      "name": "www.example.com.",
                      "rrtype": "A",
                      "ttl": 120,
                      "routing": {
                        "policy": "SIMPLE_FAILOVER",
                        "status": "Healthy",
                        "failureSensitivity": "HIGH",
                        "monitor": {
                          "protocol": "HTTPS",
                          "host": "www.example.com",
                          "port": 443,
                          "path": "/health",
                          "searchString": "OK"
                        },
                        "endpoints": [
                          {
                            "target": "192.0.2.50",
                            "priority": 1,
                            "isEnabled": true,
                            "health": "Healthy",
                            "isServing": true
                          },
                          {
                            "target": "192.0.2.51",
                            "priority": 2,
                            "isEnabled": true,
                            "health": "Healthy",
                            "isServing": false
                          }
                        ],
                        "systemGenerated": [
                          "USER_DEFINED",
                          "USER_DEFINED"
                        ]
                      },
                      "region": "EUROPE",
                      "createdAt": "2026-07-30T10:00:00Z",
                      "updatedAt": "2026-07-30T10:00:00Z"
                    }
                  }
                }
              }
            }
          },
          "400": {
            "$ref": "#/components/responses/BadRequest"
          },
          "401": {
            "$ref": "#/components/responses/Unauthorized"
          },
          "403": {
            "$ref": "#/components/responses/Forbidden"
          },
          "404": {
            "$ref": "#/components/responses/NotFound"
          },
          "429": {
            "$ref": "#/components/responses/TooManyRequests"
          },
          "500": {
            "$ref": "#/components/responses/InternalServerError"
          },
          "502": {
            "$ref": "#/components/responses/BadGateway"
          },
          "503": {
            "$ref": "#/components/responses/ServiceUnavailable"
          },
          "504": {
            "$ref": "#/components/responses/GatewayTimeout"
          }
        }
      },
      "post": {
        "operationId": "createResourceRecordSet",
        "x-required-permission": "account.zones.records:create",
        "summary": "Create a record set",
        "description": "Creates a record set with the record type and owner name in the\npath. The body mustn't repeat the owner name or record type.\n\nIf the record set already exists, the API returns `409 Conflict`,\nso a retried create can't make a duplicate. The response is\n`201 Created`, with the new record set in the body and a\n`Location` header that points to it.\n",
        "tags": [
          "RRSets"
        ],
        "parameters": [
          {
            "$ref": "#/components/parameters/IdempotencyKey"
          },
          {
            "$ref": "#/components/parameters/XRequestId"
          }
        ],
        "requestBody": {
          "required": true,
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/RRSetCreateRequest"
              },
              "examples": {
                "standardA": {
                  "summary": "Standard A record set",
                  "value": {
                    "ttl": 300,
                    "routing": {
                      "policy": "NONE",
                      "content": [
                        "192.0.2.1"
                      ]
                    }
                  }
                },
                "nullMx": {
                  "summary": "Null MX record set for a domain with no mail service",
                  "description": "A null MX record set has the single value `0 .`. It says\nthat the domain doesn't accept email. An owner name can\nhave only one null MX record, and can't have a null MX\nrecord and other MX records together.\n",
                  "value": {
                    "ttl": 300,
                    "routing": {
                      "policy": "NONE",
                      "content": [
                        "0 ."
                      ]
                    }
                  }
                },
                "standardAaaa": {
                  "summary": "Standard AAAA record set",
                  "value": {
                    "ttl": 300,
                    "routing": {
                      "policy": "NONE",
                      "content": [
                        "2001:db8::10"
                      ]
                    }
                  }
                },
                "standardAlias": {
                  "summary": "Standard ALIAS record set",
                  "description": "An `ALIAS` record set points the zone apex to another\nhostname. Its value is one target hostname, like a\n`CNAME`.\n",
                  "value": {
                    "ttl": 300,
                    "routing": {
                      "policy": "NONE",
                      "content": [
                        "target.example.net."
                      ]
                    }
                  }
                },
                "standardCaa": {
                  "summary": "Standard CAA record set",
                  "value": {
                    "ttl": 300,
                    "routing": {
                      "policy": "NONE",
                      "content": [
                        "0 issue \"digicert.com\""
                      ]
                    }
                  }
                },
                "standardCert": {
                  "summary": "Standard CERT record set",
                  "value": {
                    "ttl": 300,
                    "routing": {
                      "policy": "NONE",
                      "content": [
                        "1 0 0 AQPSKmynfzW4kyBv015MUG2DeIQ3Cbl+"
                      ]
                    }
                  }
                },
                "standardCname": {
                  "summary": "Standard CNAME record set",
                  "value": {
                    "ttl": 300,
                    "routing": {
                      "policy": "NONE",
                      "content": [
                        "target.example.com."
                      ]
                    }
                  }
                },
                "standardDname": {
                  "summary": "Standard DNAME record set",
                  "value": {
                    "ttl": 300,
                    "routing": {
                      "policy": "NONE",
                      "content": [
                        "target-tree.example.net."
                      ]
                    }
                  }
                },
                "standardDs": {
                  "summary": "Standard DS record set",
                  "value": {
                    "ttl": 300,
                    "routing": {
                      "policy": "NONE",
                      "content": [
                        "2371 13 2 9A5EAFD4A7E6B1CD4E3F8A1B2C3D4E5F67890123456789ABCDEF0123456789AB"
                      ]
                    }
                  }
                },
                "standardHinfo": {
                  "summary": "Standard HINFO record set",
                  "value": {
                    "ttl": 300,
                    "routing": {
                      "policy": "NONE",
                      "content": [
                        "\"INTEL\" \"LINUX\""
                      ]
                    }
                  }
                },
                "standardHttps": {
                  "summary": "Standard HTTPS record set",
                  "value": {
                    "ttl": 300,
                    "routing": {
                      "policy": "NONE",
                      "content": [
                        "1 . alpn=\"h2,h3\" ipv4hint=192.0.2.10"
                      ]
                    }
                  }
                },
                "standardLoc": {
                  "summary": "Standard LOC record set",
                  "value": {
                    "ttl": 300,
                    "routing": {
                      "policy": "NONE",
                      "content": [
                        "37 47 0.0 N 122 24 0.0 W 10m 1m 100m 10m"
                      ]
                    }
                  }
                },
                "standardMx": {
                  "summary": "Standard MX record set",
                  "value": {
                    "ttl": 300,
                    "routing": {
                      "policy": "NONE",
                      "content": [
                        "10 mail.example.com."
                      ]
                    }
                  }
                },
                "standardNaptr": {
                  "summary": "Standard NAPTR record set",
                  "value": {
                    "ttl": 300,
                    "routing": {
                      "policy": "NONE",
                      "content": [
                        "100 10 \"U\" \"E2U+sip\" \"!^.*$!sip:info@example.com!\" ."
                      ]
                    }
                  }
                },
                "standardNs": {
                  "summary": "Standard NS record set",
                  "value": {
                    "ttl": 300,
                    "routing": {
                      "policy": "NONE",
                      "content": [
                        "ns1.example.net."
                      ]
                    }
                  }
                },
                "standardPtr": {
                  "summary": "Standard PTR record set",
                  "value": {
                    "ttl": 300,
                    "routing": {
                      "policy": "NONE",
                      "content": [
                        "host.example.com."
                      ]
                    }
                  }
                },
                "standardRp": {
                  "summary": "Standard RP record set",
                  "value": {
                    "ttl": 300,
                    "routing": {
                      "policy": "NONE",
                      "content": [
                        "hostmaster.example.com. info.example.com."
                      ]
                    }
                  }
                },
                "standardSoa": {
                  "summary": "Standard SOA record set",
                  "value": {
                    "ttl": 300,
                    "routing": {
                      "policy": "NONE",
                      "content": [
                        "ns1.example.com. hostmaster.example.com. 2026061801 3600 600 1209600 300"
                      ]
                    }
                  }
                },
                "standardSrv": {
                  "summary": "Standard SRV record set",
                  "value": {
                    "ttl": 300,
                    "routing": {
                      "policy": "NONE",
                      "content": [
                        "10 5 443 service.example.com."
                      ]
                    }
                  }
                },
                "standardSshfp": {
                  "summary": "Standard SSHFP record set",
                  "value": {
                    "ttl": 300,
                    "routing": {
                      "policy": "NONE",
                      "content": [
                        "1 1 123456789abcdef67890123456789abcdef67890"
                      ]
                    }
                  }
                },
                "standardSvcb": {
                  "summary": "Standard SVCB record set",
                  "value": {
                    "ttl": 300,
                    "routing": {
                      "policy": "NONE",
                      "content": [
                        "1 svc.example.net. alpn=\"h2\" ipv4hint=192.0.2.10"
                      ]
                    }
                  }
                },
                "standardTlsa": {
                  "summary": "Standard TLSA record set",
                  "value": {
                    "ttl": 300,
                    "routing": {
                      "policy": "NONE",
                      "content": [
                        "3 1 1 d2abde240d7cd3ee6b4b28c54df034b97983a1d16e8a410e4561cb106618e971"
                      ]
                    }
                  }
                },
                "standardTlsaRdata": {
                  "summary": "Standard TLSA record set with structured record data",
                  "description": "The same record set as `standardTlsa`, sent as structured\n`routing.rdata` instead of a `routing.content` string in\nBIND format. Send either `content` or `rdata`, not both.\n",
                  "value": {
                    "ttl": 3600,
                    "routing": {
                      "policy": "NONE",
                      "rdata": [
                        {
                          "type": "TLSA",
                          "certUsage": 3,
                          "selector": 1,
                          "matchingType": 1,
                          "certificateData": "d2abde240d7cd3ee6b4b28c54df034b97983a1d16e8a410e4561cb106618e971"
                        }
                      ]
                    }
                  }
                },
                "standardHttpsRdata": {
                  "summary": "Standard HTTPS record set with structured record data",
                  "description": "The same record set as `standardHttps`, sent as structured\n`routing.rdata` instead of a `routing.content` string in\nBIND format. Use `additionalSvcParams` for SvcParams that\ndon't have their own field, such as `dohpath`.\n",
                  "value": {
                    "ttl": 300,
                    "routing": {
                      "policy": "NONE",
                      "rdata": [
                        {
                          "type": "HTTPS",
                          "priority": 1,
                          "targetName": ".",
                          "alpn": [
                            "h2",
                            "h3"
                          ],
                          "ipv4hint": [
                            "192.0.2.10"
                          ],
                          "additionalSvcParams": {
                            "dohpath": "/dns-query{?dns}"
                          }
                        }
                      ]
                    }
                  }
                },
                "standardSvcbRdata": {
                  "summary": "Standard SVCB record set with structured record data",
                  "description": "`HTTPS` and `SVCB` record sets use the same body, because\nRFC 9460 gives them the same wire format. Only the `type`\nfield tells them apart.\n",
                  "value": {
                    "ttl": 300,
                    "routing": {
                      "policy": "NONE",
                      "rdata": [
                        {
                          "type": "SVCB",
                          "priority": 1,
                          "targetName": "svc.example.net.",
                          "alpn": [
                            "h2"
                          ],
                          "ipv4hint": [
                            "192.0.2.10"
                          ]
                        }
                      ]
                    }
                  }
                },
                "aliasModeHttpsRdata": {
                  "summary": "HTTPS record set in AliasMode (priority 0)",
                  "description": "`priority: 0` selects AliasMode, which doesn't allow\nservice parameters. If you send `alpn`, `port`,\n`ipv4hint`, `ipv6hint`, or `additionalSvcParams` with\n`priority: 0`, the API returns `400 Bad Request`.\n\nIn AliasMode, a `targetName` of `.` means that the service\ndoesn't exist, so this example uses a real target.\n",
                  "value": {
                    "ttl": 300,
                    "routing": {
                      "policy": "NONE",
                      "rdata": [
                        {
                          "type": "HTTPS",
                          "priority": 0,
                          "targetName": "svc.example.net."
                        }
                      ]
                    }
                  }
                },
                "standardTxt": {
                  "summary": "Standard TXT record set",
                  "value": {
                    "ttl": 300,
                    "routing": {
                      "policy": "NONE",
                      "content": [
                        "\"v=spf1 include:_spf.example.com ~all\""
                      ]
                    }
                  }
                },
                "simpleFailover": {
                  "summary": "SIMPLE_FAILOVER record set (HTTPS monitor)",
                  "description": "Failover by priority, driven by a `monitor` health check\nthat uses `HTTP`, `HTTPS`, `TCP`, `UDP`, or `ICMP`. Don't\nsend `content`. DigiCert DNS answers with endpoints from\n`endpoints`, based on what the monitor finds.\n",
                  "value": {
                    "ttl": 300,
                    "routing": {
                      "policy": "SIMPLE_FAILOVER",
                      "failureSensitivity": "MEDIUM",
                      "monitor": {
                        "protocol": "HTTPS",
                        "host": "www.example.com",
                        "port": 443,
                        "path": "/health",
                        "searchString": "OK"
                      },
                      "endpoints": [
                        {
                          "target": "192.0.2.1",
                          "priority": 1,
                          "isEnabled": true
                        },
                        {
                          "target": "192.0.2.2",
                          "priority": 2,
                          "isEnabled": true
                        },
                        {
                          "target": "192.0.2.3",
                          "priority": 3,
                          "isEnabled": true
                        }
                      ]
                    }
                  }
                },
                "simpleFailoverHttp": {
                  "summary": "SIMPLE_FAILOVER record set (HTTP monitor)",
                  "description": "`HTTP` monitors need `host`, `port`, and `path`, like\n`HTTPS` monitors. `searchString` is optional.\n",
                  "value": {
                    "ttl": 300,
                    "routing": {
                      "policy": "SIMPLE_FAILOVER",
                      "failureSensitivity": "MEDIUM",
                      "monitor": {
                        "protocol": "HTTP",
                        "host": "www.example.com",
                        "port": 80,
                        "path": "/health",
                        "searchString": "OK"
                      },
                      "endpoints": [
                        {
                          "target": "192.0.2.1",
                          "priority": 1,
                          "isEnabled": true
                        },
                        {
                          "target": "192.0.2.2",
                          "priority": 2,
                          "isEnabled": true
                        }
                      ]
                    }
                  }
                },
                "simpleFailoverTcp": {
                  "summary": "SIMPLE_FAILOVER record set (TCP monitor)",
                  "description": "`TCP` monitors need only `port`. The check opens a TCP\nconnection to the endpoint's `target`, so there's no\n`host`, `path`, or `searchString`. `timeout` is optional.\n",
                  "value": {
                    "ttl": 300,
                    "routing": {
                      "policy": "SIMPLE_FAILOVER",
                      "failureSensitivity": "MEDIUM",
                      "monitor": {
                        "protocol": "TCP",
                        "port": 53,
                        "timeout": 10
                      },
                      "endpoints": [
                        {
                          "target": "192.0.2.1",
                          "priority": 1,
                          "isEnabled": true
                        },
                        {
                          "target": "192.0.2.2",
                          "priority": 2,
                          "isEnabled": true
                        }
                      ]
                    }
                  }
                },
                "simpleFailoverUdp": {
                  "summary": "SIMPLE_FAILOVER record set (UDP monitor)",
                  "description": "`UDP` monitors need `port`. `sendString`, the data the\ncheck sends, and `timeout` are optional. There's no\n`host`, `path`, or `searchString`.\n",
                  "value": {
                    "ttl": 300,
                    "routing": {
                      "policy": "SIMPLE_FAILOVER",
                      "failureSensitivity": "MEDIUM",
                      "monitor": {
                        "protocol": "UDP",
                        "port": 53,
                        "sendString": "PING",
                        "timeout": 10
                      },
                      "endpoints": [
                        {
                          "target": "192.0.2.1",
                          "priority": 1,
                          "isEnabled": true
                        },
                        {
                          "target": "192.0.2.2",
                          "priority": 2,
                          "isEnabled": true
                        }
                      ]
                    }
                  }
                },
                "simpleFailoverIcmp": {
                  "summary": "SIMPLE_FAILOVER record set (ICMP monitor)",
                  "description": "`ICMP` monitors ping the endpoint's `target` directly.\nICMP doesn't use ports, so there's no `port`, `host`,\n`path`, or `searchString`.\n",
                  "value": {
                    "ttl": 300,
                    "routing": {
                      "policy": "SIMPLE_FAILOVER",
                      "failureSensitivity": "MEDIUM",
                      "monitor": {
                        "protocol": "ICMP"
                      },
                      "endpoints": [
                        {
                          "target": "192.0.2.1",
                          "priority": 1,
                          "isEnabled": true
                        },
                        {
                          "target": "192.0.2.2",
                          "priority": 2,
                          "isEnabled": true
                        }
                      ]
                    }
                  }
                }
              }
            }
          }
        },
        "responses": {
          "201": {
            "description": "The record set was created.",
            "headers": {
              "Location": {
                "$ref": "#/components/headers/Location"
              },
              "X-Request-Id": {
                "$ref": "#/components/headers/XRequestId"
              },
              "X-Idempotent-Replayed": {
                "$ref": "#/components/headers/XIdempotentReplayed"
              },
              "X-RateLimit-Limit": {
                "$ref": "#/components/headers/XRateLimitLimit"
              },
              "X-RateLimit-Remaining": {
                "$ref": "#/components/headers/XRateLimitRemaining"
              },
              "X-RateLimit-Reset": {
                "$ref": "#/components/headers/XRateLimitReset"
              }
            },
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/RRSet"
                },
                "examples": {
                  "standardA": {
                    "summary": "Standard A record set created",
                    "value": {
                      "zoneName": "example.com.",
                      "name": "www.example.com.",
                      "rrtype": "A",
                      "ttl": 300,
                      "routing": {
                        "policy": "NONE",
                        "content": [
                          "192.0.2.1"
                        ]
                      },
                      "createdAt": "2026-07-30T10:00:00Z",
                      "updatedAt": "2026-07-30T10:00:00Z"
                    }
                  },
                  "nullMx": {
                    "summary": "Null MX record set created",
                    "value": {
                      "zoneName": "example.com.",
                      "name": "example.com.",
                      "rrtype": "MX",
                      "ttl": 300,
                      "routing": {
                        "policy": "NONE",
                        "content": [
                          "0 ."
                        ]
                      },
                      "createdAt": "2026-07-30T10:00:00Z",
                      "updatedAt": "2026-07-30T10:00:00Z"
                    }
                  },
                  "standardAlias": {
                    "summary": "ALIAS record set created",
                    "description": "The response to the `standardAlias` request example.\n",
                    "value": {
                      "zoneName": "example.com.",
                      "name": "example.com.",
                      "rrtype": "ALIAS",
                      "ttl": 300,
                      "routing": {
                        "policy": "NONE",
                        "content": [
                          "target.example.net."
                        ]
                      },
                      "createdAt": "2026-08-18T10:00:00Z",
                      "updatedAt": "2026-08-18T10:00:00Z"
                    }
                  },
                  "standardTlsaRdata": {
                    "summary": "TLSA record set created with structured record data",
                    "description": "The response to the `standardTlsaRdata` request example.\nThe response always includes `routing.content` in BIND\nformat and the structured `routing.rdata`, whichever\nformat you sent.\n",
                    "value": {
                      "zoneName": "example.com.",
                      "name": "_443._tcp.www.example.com.",
                      "rrtype": "TLSA",
                      "ttl": 3600,
                      "routing": {
                        "policy": "NONE",
                        "content": [
                          "3 1 1 d2abde240d7cd3ee6b4b28c54df034b97983a1d16e8a410e4561cb106618e971"
                        ],
                        "rdata": [
                          {
                            "type": "TLSA",
                            "certUsage": 3,
                            "selector": 1,
                            "matchingType": 1,
                            "certificateData": "d2abde240d7cd3ee6b4b28c54df034b97983a1d16e8a410e4561cb106618e971"
                          }
                        ]
                      },
                      "createdAt": "2026-08-18T10:00:00Z",
                      "updatedAt": "2026-08-18T10:00:00Z"
                    }
                  },
                  "standardHttpsRdata": {
                    "summary": "HTTPS record set created with structured record data",
                    "description": "The response to the `standardHttpsRdata` request example.\n`additionalSvcParams` comes back as you sent it, and its\nSvcParams also appear in `routing.content`.\n",
                    "value": {
                      "zoneName": "example.com.",
                      "name": "example.com.",
                      "rrtype": "HTTPS",
                      "ttl": 300,
                      "routing": {
                        "policy": "NONE",
                        "content": [
                          "1 . alpn=h2,h3 ipv4hint=192.0.2.10 dohpath=/dns-query{?dns}"
                        ],
                        "rdata": [
                          {
                            "type": "HTTPS",
                            "priority": 1,
                            "targetName": ".",
                            "alpn": [
                              "h2",
                              "h3"
                            ],
                            "ipv4hint": [
                              "192.0.2.10"
                            ],
                            "additionalSvcParams": {
                              "dohpath": "/dns-query{?dns}"
                            }
                          }
                        ]
                      },
                      "createdAt": "2026-08-18T10:00:00Z",
                      "updatedAt": "2026-08-18T10:00:00Z"
                    }
                  },
                  "standardSvcbRdata": {
                    "summary": "SVCB record set created with structured record data",
                    "description": "The response to the `standardSvcbRdata` request example.\n`HTTPS` and `SVCB` record sets use the same body, so the\nresponse differs only in `rrtype` and the `type` field.\n",
                    "value": {
                      "zoneName": "example.com.",
                      "name": "_443._tcp.example.com.",
                      "rrtype": "SVCB",
                      "ttl": 300,
                      "routing": {
                        "policy": "NONE",
                        "content": [
                          "1 svc.example.net. alpn=h2 ipv4hint=192.0.2.10"
                        ],
                        "rdata": [
                          {
                            "type": "SVCB",
                            "priority": 1,
                            "targetName": "svc.example.net.",
                            "alpn": [
                              "h2"
                            ],
                            "ipv4hint": [
                              "192.0.2.10"
                            ]
                          }
                        ]
                      },
                      "createdAt": "2026-08-18T10:00:00Z",
                      "updatedAt": "2026-08-18T10:00:00Z"
                    }
                  },
                  "aliasModeHttpsRdata": {
                    "summary": "HTTPS record set created in AliasMode (priority 0)",
                    "description": "The response to the `aliasModeHttpsRdata` request\nexample. AliasMode has no service parameters, so\n`routing.content` has only the priority and target\nname.\n",
                    "value": {
                      "zoneName": "example.com.",
                      "name": "example.com.",
                      "rrtype": "HTTPS",
                      "ttl": 300,
                      "routing": {
                        "policy": "NONE",
                        "content": [
                          "0 svc.example.net."
                        ],
                        "rdata": [
                          {
                            "type": "HTTPS",
                            "priority": 0,
                            "targetName": "svc.example.net."
                          }
                        ]
                      },
                      "createdAt": "2026-08-18T10:00:00Z",
                      "updatedAt": "2026-08-18T10:00:00Z"
                    }
                  }
                }
              }
            }
          },
          "400": {
            "$ref": "#/components/responses/BadRequestRRSet"
          },
          "401": {
            "$ref": "#/components/responses/Unauthorized"
          },
          "403": {
            "$ref": "#/components/responses/Forbidden"
          },
          "404": {
            "$ref": "#/components/responses/NotFound"
          },
          "409": {
            "$ref": "#/components/responses/Conflict"
          },
          "415": {
            "$ref": "#/components/responses/UnsupportedMediaType"
          },
          "422": {
            "$ref": "#/components/responses/UnprocessableEntity"
          },
          "429": {
            "$ref": "#/components/responses/TooManyRequests"
          },
          "500": {
            "$ref": "#/components/responses/InternalServerError"
          },
          "502": {
            "$ref": "#/components/responses/BadGateway"
          },
          "503": {
            "$ref": "#/components/responses/ServiceUnavailable"
          },
          "504": {
            "$ref": "#/components/responses/GatewayTimeout"
          }
        }
      },
      "put": {
        "operationId": "updateResourceRecordSet",
        "x-required-permission": "account.zones.records:update",
        "summary": "Replace a record set",
        "description": "Replaces a record set. The values in the body replace all of the\nrecord set's current values. To change only some fields, use\n`PATCH /zones/{zoneName}/records/{rrtype}/{name}`.\n",
        "tags": [
          "RRSets"
        ],
        "parameters": [
          {
            "$ref": "#/components/parameters/IdempotencyKeyOptional"
          },
          {
            "$ref": "#/components/parameters/XRequestId"
          }
        ],
        "requestBody": {
          "required": true,
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/RRSetUpdateRequest"
              },
              "examples": {
                "standardA": {
                  "summary": "Update an A record set",
                  "value": {
                    "ttl": 300,
                    "routing": {
                      "policy": "NONE",
                      "content": [
                        "192.0.2.10"
                      ]
                    }
                  }
                },
                "standardAaaa": {
                  "summary": "Update an AAAA record set",
                  "value": {
                    "ttl": 300,
                    "routing": {
                      "policy": "NONE",
                      "content": [
                        "2001:db8::20"
                      ]
                    }
                  }
                },
                "switchToSimpleFailover": {
                  "summary": "Switch a record set to SIMPLE_FAILOVER",
                  "description": "To change `routing.policy`, send the full `routing`\nobject. The API removes the record set's earlier\n`routing.content` values.\n",
                  "value": {
                    "ttl": 300,
                    "routing": {
                      "policy": "SIMPLE_FAILOVER",
                      "failureSensitivity": "MEDIUM",
                      "monitor": {
                        "protocol": "HTTPS",
                        "host": "www.example.com",
                        "port": 443,
                        "path": "/health"
                      },
                      "endpoints": [
                        {
                          "target": "192.0.2.10",
                          "priority": 1,
                          "isEnabled": true
                        },
                        {
                          "target": "192.0.2.11",
                          "priority": 2,
                          "isEnabled": true
                        }
                      ]
                    }
                  }
                },
                "standardCaa": {
                  "summary": "Update a CAA record set",
                  "value": {
                    "ttl": 300,
                    "routing": {
                      "policy": "NONE",
                      "content": [
                        "0 issue \"digicert.com\""
                      ]
                    }
                  }
                },
                "standardCert": {
                  "summary": "Update a CERT record set",
                  "value": {
                    "ttl": 300,
                    "routing": {
                      "policy": "NONE",
                      "content": [
                        "1 0 0 AQPSKmynfzW4kyBv015MUG2DeIQ3Cbl+"
                      ]
                    }
                  }
                },
                "standardCname": {
                  "summary": "Update a CNAME record set",
                  "value": {
                    "ttl": 300,
                    "routing": {
                      "policy": "NONE",
                      "content": [
                        "alias.example.com."
                      ]
                    }
                  }
                },
                "standardDname": {
                  "summary": "Update a DNAME record set",
                  "value": {
                    "ttl": 300,
                    "routing": {
                      "policy": "NONE",
                      "content": [
                        "new-tree.example.net."
                      ]
                    }
                  }
                },
                "standardDs": {
                  "summary": "Update a DS record set",
                  "value": {
                    "ttl": 300,
                    "routing": {
                      "policy": "NONE",
                      "content": [
                        "2371 13 2 0123456789ABCDEF0123456789ABCDEF0123456789ABCDEF0123456789ABCD"
                      ]
                    }
                  }
                },
                "standardHinfo": {
                  "summary": "Update an HINFO record set",
                  "value": {
                    "ttl": 300,
                    "routing": {
                      "policy": "NONE",
                      "content": [
                        "\"AMD64\" \"FREEBSD\""
                      ]
                    }
                  }
                },
                "standardHttps": {
                  "summary": "Update an HTTPS record set",
                  "value": {
                    "ttl": 300,
                    "routing": {
                      "policy": "NONE",
                      "content": [
                        "1 . alpn=\"h3\" ipv4hint=192.0.2.11"
                      ]
                    }
                  }
                },
                "standardLoc": {
                  "summary": "Update a LOC record set",
                  "value": {
                    "ttl": 300,
                    "routing": {
                      "policy": "NONE",
                      "content": [
                        "37 47 1.0 N 122 24 1.0 W 15m 1m 100m 10m"
                      ]
                    }
                  }
                },
                "standardMx": {
                  "summary": "Update an MX record set",
                  "value": {
                    "ttl": 300,
                    "routing": {
                      "policy": "NONE",
                      "content": [
                        "20 mail2.example.com."
                      ]
                    }
                  }
                },
                "standardNaptr": {
                  "summary": "Update a NAPTR record set",
                  "value": {
                    "ttl": 300,
                    "routing": {
                      "policy": "NONE",
                      "content": [
                        "100 10 \"U\" \"E2U+email\" \"!^.*$!mailto:hostmaster@example.com!\" ."
                      ]
                    }
                  }
                },
                "standardNs": {
                  "summary": "Update an NS record set",
                  "value": {
                    "ttl": 300,
                    "routing": {
                      "policy": "NONE",
                      "content": [
                        "ns2.example.net."
                      ]
                    }
                  }
                },
                "standardPtr": {
                  "summary": "Update a PTR record set",
                  "value": {
                    "ttl": 300,
                    "routing": {
                      "policy": "NONE",
                      "content": [
                        "updated-host.example.com."
                      ]
                    }
                  }
                },
                "standardRp": {
                  "summary": "Update an RP record set",
                  "value": {
                    "ttl": 300,
                    "routing": {
                      "policy": "NONE",
                      "content": [
                        "dnsadmin.example.com. txt.example.com."
                      ]
                    }
                  }
                },
                "standardSoa": {
                  "summary": "Update an SOA record set",
                  "value": {
                    "ttl": 300,
                    "routing": {
                      "policy": "NONE",
                      "content": [
                        "ns1.example.com. hostmaster.example.com. 2026061802 3600 600 1209600 300"
                      ]
                    }
                  }
                },
                "standardSrv": {
                  "summary": "Update an SRV record set",
                  "value": {
                    "ttl": 300,
                    "routing": {
                      "policy": "NONE",
                      "content": [
                        "10 20 8443 service2.example.com."
                      ]
                    }
                  }
                },
                "standardSshfp": {
                  "summary": "Update an SSHFP record set",
                  "value": {
                    "ttl": 300,
                    "routing": {
                      "policy": "NONE",
                      "content": [
                        "1 2 123456789abcdef67890123456789abcdef67890123456789abcdef67890"
                      ]
                    }
                  }
                },
                "standardSvcb": {
                  "summary": "Update an SVCB record set",
                  "value": {
                    "ttl": 300,
                    "routing": {
                      "policy": "NONE",
                      "content": [
                        "1 svc2.example.net. alpn=\"h2,h3\" ipv4hint=192.0.2.12"
                      ]
                    }
                  }
                },
                "standardTlsa": {
                  "summary": "Update a TLSA record set",
                  "value": {
                    "ttl": 300,
                    "routing": {
                      "policy": "NONE",
                      "content": [
                        "3 1 1 aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa"
                      ]
                    }
                  }
                },
                "standardTlsaRdata": {
                  "summary": "Update a TLSA record set with structured record data",
                  "description": "A `PUT` replaces the whole record set. Send either\n`routing.content` or `routing.rdata`, not both.\n",
                  "value": {
                    "ttl": 3600,
                    "routing": {
                      "policy": "NONE",
                      "rdata": [
                        {
                          "type": "TLSA",
                          "certUsage": 3,
                          "selector": 1,
                          "matchingType": 1,
                          "certificateData": "d2abde240d7cd3ee6b4b28c54df034b97983a1d16e8a410e4561cb106618e971"
                        }
                      ]
                    }
                  }
                },
                "standardHttpsRdata": {
                  "summary": "Update an HTTPS record set with structured record data",
                  "value": {
                    "ttl": 300,
                    "routing": {
                      "policy": "NONE",
                      "rdata": [
                        {
                          "type": "HTTPS",
                          "priority": 1,
                          "targetName": ".",
                          "alpn": [
                            "h2",
                            "h3"
                          ],
                          "ipv4hint": [
                            "192.0.2.10"
                          ]
                        }
                      ]
                    }
                  }
                },
                "standardSvcbRdata": {
                  "summary": "Update an SVCB record set with structured record data",
                  "value": {
                    "ttl": 300,
                    "routing": {
                      "policy": "NONE",
                      "rdata": [
                        {
                          "type": "SVCB",
                          "priority": 1,
                          "targetName": "svc.example.net.",
                          "alpn": [
                            "h2"
                          ]
                        }
                      ]
                    }
                  }
                },
                "standardTxt": {
                  "summary": "Update a TXT record set",
                  "value": {
                    "ttl": 300,
                    "routing": {
                      "policy": "NONE",
                      "content": [
                        "\"example-site-verification=abc123xyz\""
                      ]
                    }
                  }
                }
              }
            }
          }
        },
        "responses": {
          "200": {
            "description": "The record set was replaced.",
            "headers": {
              "X-Request-Id": {
                "$ref": "#/components/headers/XRequestId"
              },
              "X-Idempotent-Replayed": {
                "$ref": "#/components/headers/XIdempotentReplayed"
              },
              "X-RateLimit-Limit": {
                "$ref": "#/components/headers/XRateLimitLimit"
              },
              "X-RateLimit-Remaining": {
                "$ref": "#/components/headers/XRateLimitRemaining"
              },
              "X-RateLimit-Reset": {
                "$ref": "#/components/headers/XRateLimitReset"
              }
            },
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/RRSet"
                },
                "example": {
                  "zoneName": "example.com.",
                  "name": "www.example.com.",
                  "rrtype": "A",
                  "ttl": 300,
                  "routing": {
                    "policy": "NONE",
                    "content": [
                      "192.0.2.10"
                    ]
                  },
                  "createdAt": "2026-07-30T10:00:00Z",
                  "updatedAt": "2026-07-30T10:00:00Z"
                }
              }
            }
          },
          "400": {
            "$ref": "#/components/responses/BadRequestRRSet"
          },
          "401": {
            "$ref": "#/components/responses/Unauthorized"
          },
          "403": {
            "$ref": "#/components/responses/Forbidden"
          },
          "404": {
            "$ref": "#/components/responses/NotFound"
          },
          "409": {
            "$ref": "#/components/responses/Conflict"
          },
          "415": {
            "$ref": "#/components/responses/UnsupportedMediaType"
          },
          "422": {
            "$ref": "#/components/responses/UnprocessableEntity"
          },
          "429": {
            "$ref": "#/components/responses/TooManyRequests"
          },
          "500": {
            "$ref": "#/components/responses/InternalServerError"
          },
          "502": {
            "$ref": "#/components/responses/BadGateway"
          },
          "503": {
            "$ref": "#/components/responses/ServiceUnavailable"
          },
          "504": {
            "$ref": "#/components/responses/GatewayTimeout"
          }
        }
      },
      "patch": {
        "operationId": "patchResourceRecordSet",
        "x-required-permission": "account.zones.records:update",
        "summary": "Update part of a record set",
        "description": "Updates part of a record set. Send only the fields to change. The\nAPI keeps the fields you leave out. The API replaces `routing` as a\nwhole, so to change any routing field, send the full `routing`\nobject.\n\nSend a JSON object as `application/json`. The API doesn't support\nJSON Patch (`application/json-patch+json`).\n",
        "tags": [
          "RRSets"
        ],
        "parameters": [
          {
            "$ref": "#/components/parameters/IdempotencyKey"
          },
          {
            "$ref": "#/components/parameters/XRequestId"
          }
        ],
        "requestBody": {
          "required": true,
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/RRSetPatchRequest"
              },
              "examples": {
                "ttlOnly": {
                  "summary": "Change only the TTL",
                  "value": {
                    "ttl": 600
                  }
                },
                "contentOnly": {
                  "summary": "Replace the values and keep the TTL",
                  "value": {
                    "routing": {
                      "policy": "NONE",
                      "content": [
                        "192.0.2.1",
                        "192.0.2.2"
                      ]
                    }
                  }
                },
                "ttlAndRdata": {
                  "summary": "Change the TTL and the values",
                  "value": {
                    "ttl": 600,
                    "routing": {
                      "policy": "NONE",
                      "content": [
                        "192.0.2.1",
                        "192.0.2.2"
                      ]
                    }
                  }
                },
                "updateA": {
                  "summary": "Update A record content",
                  "value": {
                    "routing": {
                      "policy": "NONE",
                      "content": [
                        "192.0.2.30"
                      ]
                    }
                  }
                },
                "updateAaaa": {
                  "summary": "Update AAAA record content",
                  "value": {
                    "routing": {
                      "policy": "NONE",
                      "content": [
                        "2001:db8::30"
                      ]
                    }
                  }
                },
                "updateCaa": {
                  "summary": "Update CAA record content",
                  "value": {
                    "routing": {
                      "policy": "NONE",
                      "content": [
                        "0 issue \"digicert.com\""
                      ]
                    }
                  }
                },
                "updateCert": {
                  "summary": "Update CERT record content",
                  "value": {
                    "routing": {
                      "policy": "NONE",
                      "content": [
                        "1 0 0 AQPSKmynfzW4kyBv015MUG2DeIQ3Cbl+"
                      ]
                    }
                  }
                },
                "updateCname": {
                  "summary": "Update CNAME record content",
                  "value": {
                    "routing": {
                      "policy": "NONE",
                      "content": [
                        "new-target.example.com."
                      ]
                    }
                  }
                },
                "updateDname": {
                  "summary": "Update DNAME record content",
                  "value": {
                    "routing": {
                      "policy": "NONE",
                      "content": [
                        "new-tree.example.org."
                      ]
                    }
                  }
                },
                "updateDs": {
                  "summary": "Update DS record content",
                  "value": {
                    "routing": {
                      "policy": "NONE",
                      "content": [
                        "2371 13 2 FEDCBA9876543210FEDCBA9876543210FEDCBA9876543210FEDCBA9876543210"
                      ]
                    }
                  }
                },
                "updateHinfo": {
                  "summary": "Update HINFO record content",
                  "value": {
                    "routing": {
                      "policy": "NONE",
                      "content": [
                        "\"ARM64\" \"LINUX\""
                      ]
                    }
                  }
                },
                "updateHttps": {
                  "summary": "Update HTTPS record content",
                  "value": {
                    "routing": {
                      "policy": "NONE",
                      "content": [
                        "1 . alpn=\"h2\" ipv4hint=192.0.2.13"
                      ]
                    }
                  }
                },
                "updateLoc": {
                  "summary": "Update LOC record content",
                  "value": {
                    "routing": {
                      "policy": "NONE",
                      "content": [
                        "37 47 2.0 N 122 24 2.0 W 20m 1m 100m 10m"
                      ]
                    }
                  }
                },
                "updateMx": {
                  "summary": "Update MX record content",
                  "value": {
                    "routing": {
                      "policy": "NONE",
                      "content": [
                        "30 mail3.example.com."
                      ]
                    }
                  }
                },
                "updateNaptr": {
                  "summary": "Update NAPTR record content",
                  "value": {
                    "routing": {
                      "policy": "NONE",
                      "content": [
                        "100 10 \"S\" \"SIP+D2U\" \"\" _sip._udp.example.com."
                      ]
                    }
                  }
                },
                "updateNs": {
                  "summary": "Update NS record content",
                  "value": {
                    "routing": {
                      "policy": "NONE",
                      "content": [
                        "ns3.example.net."
                      ]
                    }
                  }
                },
                "updatePtr": {
                  "summary": "Update PTR record content",
                  "value": {
                    "routing": {
                      "policy": "NONE",
                      "content": [
                        "ptr-host.example.com."
                      ]
                    }
                  }
                },
                "updateRp": {
                  "summary": "Update RP record content",
                  "value": {
                    "routing": {
                      "policy": "NONE",
                      "content": [
                        "rp.example.com. contact.example.com."
                      ]
                    }
                  }
                },
                "updateSoa": {
                  "summary": "Update SOA record content",
                  "value": {
                    "routing": {
                      "policy": "NONE",
                      "content": [
                        "ns1.example.com. hostmaster.example.com. 2026061803 3600 600 1209600 300"
                      ]
                    }
                  }
                },
                "updateSrv": {
                  "summary": "Update SRV record content",
                  "value": {
                    "routing": {
                      "policy": "NONE",
                      "content": [
                        "10 10 9443 service3.example.com."
                      ]
                    }
                  }
                },
                "updateSshfp": {
                  "summary": "Update SSHFP record content",
                  "value": {
                    "routing": {
                      "policy": "NONE",
                      "content": [
                        "2 1 abcdef0123456789abcdef0123456789abcdef01"
                      ]
                    }
                  }
                },
                "updateSvcb": {
                  "summary": "Update SVCB record content",
                  "value": {
                    "routing": {
                      "policy": "NONE",
                      "content": [
                        "2 svc3.example.net. alpn=\"h2\" ipv4hint=192.0.2.14"
                      ]
                    }
                  }
                },
                "updateTlsa": {
                  "summary": "Update TLSA record content",
                  "value": {
                    "routing": {
                      "policy": "NONE",
                      "content": [
                        "3 1 1 bbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbb"
                      ]
                    }
                  }
                },
                "updateTlsaRdata": {
                  "summary": "Update TLSA record content with structured record data",
                  "description": "The API replaces `routing` as a whole, so send either\n`content` or `rdata`, not both. Create and replace follow\nthe same rule.\n",
                  "value": {
                    "routing": {
                      "policy": "NONE",
                      "rdata": [
                        {
                          "type": "TLSA",
                          "certUsage": 3,
                          "selector": 1,
                          "matchingType": 1,
                          "certificateData": "d2abde240d7cd3ee6b4b28c54df034b97983a1d16e8a410e4561cb106618e971"
                        }
                      ]
                    }
                  }
                },
                "updateHttpsRdata": {
                  "summary": "Update HTTPS record content with structured record data",
                  "value": {
                    "routing": {
                      "policy": "NONE",
                      "rdata": [
                        {
                          "type": "HTTPS",
                          "priority": 1,
                          "targetName": ".",
                          "alpn": [
                            "h2",
                            "h3"
                          ],
                          "ipv4hint": [
                            "192.0.2.10"
                          ]
                        }
                      ]
                    }
                  }
                },
                "updateSvcbRdata": {
                  "summary": "Update SVCB record content with structured record data",
                  "value": {
                    "routing": {
                      "policy": "NONE",
                      "rdata": [
                        {
                          "type": "SVCB",
                          "priority": 1,
                          "targetName": "svc.example.net.",
                          "alpn": [
                            "h2"
                          ]
                        }
                      ]
                    }
                  }
                },
                "updateTxt": {
                  "summary": "Update TXT record content",
                  "value": {
                    "routing": {
                      "policy": "NONE",
                      "content": [
                        "\"v=spf1 ip4:192.0.2.0/24 -all\""
                      ]
                    }
                  }
                },
                "switchToSimpleFailover": {
                  "summary": "Switch a record set to SIMPLE_FAILOVER",
                  "description": "To change `routing.policy`, send the full `routing`\nobject. The API removes the record set's earlier\n`routing.content` values.\n",
                  "value": {
                    "routing": {
                      "policy": "SIMPLE_FAILOVER",
                      "failureSensitivity": "MEDIUM",
                      "monitor": {
                        "protocol": "HTTPS",
                        "host": "www.example.com",
                        "port": 443,
                        "path": "/health"
                      },
                      "endpoints": [
                        {
                          "target": "192.0.2.10",
                          "priority": 1,
                          "isEnabled": true
                        },
                        {
                          "target": "192.0.2.11",
                          "priority": 2,
                          "isEnabled": true
                        }
                      ]
                    }
                  }
                },
                "updateMonitor": {
                  "summary": "Update the monitor on a SIMPLE_FAILOVER record set",
                  "description": "Send the full `routing` object to change any routing\nfield. The API replaces `routing` as a whole.\n",
                  "value": {
                    "routing": {
                      "policy": "SIMPLE_FAILOVER",
                      "failureSensitivity": "LOW",
                      "monitor": {
                        "protocol": "HTTPS",
                        "host": "www.example.com",
                        "port": 443,
                        "path": "/healthz",
                        "searchString": "HEALTHY"
                      },
                      "endpoints": [
                        {
                          "target": "192.0.2.1",
                          "priority": 1,
                          "isEnabled": true
                        },
                        {
                          "target": "192.0.2.2",
                          "priority": 2,
                          "isEnabled": true
                        }
                      ]
                    }
                  }
                }
              }
            }
          }
        },
        "responses": {
          "200": {
            "description": "The record set was updated.",
            "headers": {
              "X-Request-Id": {
                "$ref": "#/components/headers/XRequestId"
              },
              "X-Idempotent-Replayed": {
                "$ref": "#/components/headers/XIdempotentReplayed"
              },
              "X-RateLimit-Limit": {
                "$ref": "#/components/headers/XRateLimitLimit"
              },
              "X-RateLimit-Remaining": {
                "$ref": "#/components/headers/XRateLimitRemaining"
              },
              "X-RateLimit-Reset": {
                "$ref": "#/components/headers/XRateLimitReset"
              }
            },
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/RRSet"
                },
                "example": {
                  "zoneName": "example.com.",
                  "name": "www.example.com.",
                  "rrtype": "A",
                  "ttl": 300,
                  "routing": {
                    "policy": "NONE",
                    "content": [
                      "192.0.2.1",
                      "192.0.2.2"
                    ]
                  },
                  "createdAt": "2026-07-30T10:00:00Z",
                  "updatedAt": "2026-07-30T10:00:00Z"
                }
              }
            }
          },
          "400": {
            "$ref": "#/components/responses/BadRequestRRSet"
          },
          "401": {
            "$ref": "#/components/responses/Unauthorized"
          },
          "403": {
            "$ref": "#/components/responses/Forbidden"
          },
          "404": {
            "$ref": "#/components/responses/NotFound"
          },
          "409": {
            "$ref": "#/components/responses/Conflict"
          },
          "415": {
            "$ref": "#/components/responses/UnsupportedMediaType"
          },
          "422": {
            "$ref": "#/components/responses/UnprocessableEntity"
          },
          "429": {
            "$ref": "#/components/responses/TooManyRequests"
          },
          "500": {
            "$ref": "#/components/responses/InternalServerError"
          },
          "502": {
            "$ref": "#/components/responses/BadGateway"
          },
          "503": {
            "$ref": "#/components/responses/ServiceUnavailable"
          },
          "504": {
            "$ref": "#/components/responses/GatewayTimeout"
          }
        }
      },
      "delete": {
        "operationId": "deleteResourceRecordSet",
        "x-required-permission": "account.zones.records:delete",
        "summary": "Delete a record set",
        "description": "Deletes a record set and all its values.\n\nIn a zone with regional views, deleting the `GLOBAL` record set\ndoesn't delete its regional record sets. A regional record set\ncontinues to serve unless an exclusion disables it. An exclusion\nfor a region that has its own regional record set remains in place\nand continues to disable that record set.\n\nDeleting the `GLOBAL` record set also removes exclusions in\nregions that have no regional record set of their own. Those\nexclusions only suppressed the deleted `GLOBAL` record set, so\nthey don't apply to a `GLOBAL` record set that you create again\nlater. Exclusions in regions with their own regional record set\nremain until you remove them. To remove an exclusion yourself, use\n`DELETE /zones/{zoneName}/records/{rrtype}/{name}/exclusions/{region}`.\n",
        "tags": [
          "RRSets"
        ],
        "parameters": [
          {
            "$ref": "#/components/parameters/IdempotencyKeyOptional"
          },
          {
            "$ref": "#/components/parameters/XRequestId"
          }
        ],
        "responses": {
          "204": {
            "description": "The record set was deleted. The response has no body.\n",
            "headers": {
              "X-Request-Id": {
                "$ref": "#/components/headers/XRequestId"
              },
              "X-Idempotent-Replayed": {
                "$ref": "#/components/headers/XIdempotentReplayed"
              },
              "X-RateLimit-Limit": {
                "$ref": "#/components/headers/XRateLimitLimit"
              },
              "X-RateLimit-Remaining": {
                "$ref": "#/components/headers/XRateLimitRemaining"
              },
              "X-RateLimit-Reset": {
                "$ref": "#/components/headers/XRateLimitReset"
              }
            }
          },
          "400": {
            "$ref": "#/components/responses/BadRequest"
          },
          "401": {
            "$ref": "#/components/responses/Unauthorized"
          },
          "403": {
            "$ref": "#/components/responses/Forbidden"
          },
          "404": {
            "$ref": "#/components/responses/NotFound"
          },
          "409": {
            "$ref": "#/components/responses/Conflict"
          },
          "429": {
            "$ref": "#/components/responses/TooManyRequests"
          },
          "500": {
            "$ref": "#/components/responses/InternalServerError"
          },
          "502": {
            "$ref": "#/components/responses/BadGateway"
          },
          "503": {
            "$ref": "#/components/responses/ServiceUnavailable"
          },
          "504": {
            "$ref": "#/components/responses/GatewayTimeout"
          }
        }
      }
    },
    "/zones/{zoneName}/records/regions": {
      "parameters": [
        {
          "$ref": "#/components/parameters/ZoneName"
        }
      ],
      "get": {
        "operationId": "listZoneRegions",
        "x-required-permission": "account.zones.records:read",
        "summary": "List regions with regional record sets",
        "description": "Returns the regions that have at least one regional record set in\nthe zone. The list includes `GLOBAL` when the zone has any `GLOBAL`\nrecord sets. Use it for a zone with regional views, where\n`advancedConfig.isRegionalViewEnabled` is `true`.\n",
        "tags": [
          "RRSets"
        ],
        "parameters": [
          {
            "$ref": "#/components/parameters/XRequestId"
          }
        ],
        "responses": {
          "200": {
            "description": "The regions that have at least one regional record set in the zone.",
            "headers": {
              "X-Request-Id": {
                "$ref": "#/components/headers/XRequestId"
              },
              "X-RateLimit-Limit": {
                "$ref": "#/components/headers/XRateLimitLimit"
              },
              "X-RateLimit-Remaining": {
                "$ref": "#/components/headers/XRateLimitRemaining"
              },
              "X-RateLimit-Reset": {
                "$ref": "#/components/headers/XRateLimitReset"
              }
            },
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ZoneRegionList"
                },
                "examples": {
                  "threeRegions": {
                    "summary": "GLOBAL and two regions with regional record sets",
                    "value": {
                      "regions": [
                        "GLOBAL",
                        "EUROPE",
                        "ASIA_PAC"
                      ]
                    }
                  }
                }
              }
            }
          },
          "401": {
            "$ref": "#/components/responses/Unauthorized"
          },
          "403": {
            "$ref": "#/components/responses/Forbidden"
          },
          "404": {
            "$ref": "#/components/responses/NotFound"
          },
          "429": {
            "$ref": "#/components/responses/TooManyRequests"
          },
          "500": {
            "$ref": "#/components/responses/InternalServerError"
          },
          "502": {
            "$ref": "#/components/responses/BadGateway"
          },
          "503": {
            "$ref": "#/components/responses/ServiceUnavailable"
          },
          "504": {
            "$ref": "#/components/responses/GatewayTimeout"
          }
        }
      }
    },
    "/zones/{zoneName}/records/{rrtype}/{name}/regions": {
      "parameters": [
        {
          "$ref": "#/components/parameters/ZoneName"
        },
        {
          "$ref": "#/components/parameters/RecordType"
        },
        {
          "$ref": "#/components/parameters/Name"
        }
      ],
      "get": {
        "operationId": "listResourceRecordSetRegions",
        "x-required-permission": "account.zones.records:read",
        "summary": "List regions for a record set",
        "description": "Returns the regions that have a regional record set for a record\nset, in `regions`, and the regions that have an exclusion for it,\nin `excludedRegions`. `regions` includes `GLOBAL` when the `GLOBAL`\nrecord set exists. A region can be in both lists: it has a\nregional record set, and an exclusion that disables it. Use it\nfor a zone with regional views, where\n`advancedConfig.isRegionalViewEnabled` is `true`.\n",
        "tags": [
          "RRSets"
        ],
        "parameters": [
          {
            "$ref": "#/components/parameters/XRequestId"
          }
        ],
        "responses": {
          "200": {
            "description": "The regions with a regional record set, and the regions with an exclusion.",
            "headers": {
              "X-Request-Id": {
                "$ref": "#/components/headers/XRequestId"
              },
              "X-RateLimit-Limit": {
                "$ref": "#/components/headers/XRateLimitLimit"
              },
              "X-RateLimit-Remaining": {
                "$ref": "#/components/headers/XRateLimitRemaining"
              },
              "X-RateLimit-Reset": {
                "$ref": "#/components/headers/XRateLimitReset"
              }
            },
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/RRSetRegionList"
                },
                "examples": {
                  "twoRegions": {
                    "summary": "GLOBAL and one regional record set",
                    "value": {
                      "regions": [
                        "GLOBAL",
                        "EUROPE"
                      ],
                      "excludedRegions": []
                    }
                  },
                  "withExclusion": {
                    "summary": "GLOBAL, one regional record set, and one excluded region",
                    "value": {
                      "regions": [
                        "GLOBAL",
                        "EUROPE"
                      ],
                      "excludedRegions": [
                        "ASIA_PAC"
                      ]
                    }
                  }
                }
              }
            }
          },
          "401": {
            "$ref": "#/components/responses/Unauthorized"
          },
          "403": {
            "$ref": "#/components/responses/Forbidden"
          },
          "404": {
            "$ref": "#/components/responses/NotFound"
          },
          "429": {
            "$ref": "#/components/responses/TooManyRequests"
          },
          "500": {
            "$ref": "#/components/responses/InternalServerError"
          },
          "502": {
            "$ref": "#/components/responses/BadGateway"
          },
          "503": {
            "$ref": "#/components/responses/ServiceUnavailable"
          },
          "504": {
            "$ref": "#/components/responses/GatewayTimeout"
          }
        }
      }
    },
    "/zones/{zoneName}/records/{rrtype}/{name}/regions/{region}": {
      "parameters": [
        {
          "$ref": "#/components/parameters/ZoneName"
        },
        {
          "$ref": "#/components/parameters/RecordType"
        },
        {
          "$ref": "#/components/parameters/Name"
        },
        {
          "$ref": "#/components/parameters/Region"
        }
      ],
      "get": {
        "operationId": "getRegionalResourceRecordSet",
        "x-required-permission": "account.zones.records:read",
        "summary": "Get a regional record set",
        "description": "Returns a record set as a region resolves it. Use it for a zone\nwith regional views, where `advancedConfig.isRegionalViewEnabled`\nis `true`.\n\n- If the region has a regional record set, the API returns it, with\n  `region` set to the region.\n- If the region has no regional record set, the API returns the\n  `GLOBAL` record set, with `region: GLOBAL`. This includes right\n  after you delete the regional record set.\n- If the region has an exclusion for the record set, the API\n  still returns the record set, with `isExcluded: true`. The\n  region serves no records for the owner name and record type. The\n  list operations show exclusions the same way.\n\nThe exclusion can disable either record set:\n\n- If the region has a regional record set, the exclusion disables\n  it. The API returns the regional record set, with `region` set to\n  the region and `isExcluded: true`.\n- If the region has no regional record set, the exclusion\n  suppresses the `GLOBAL` record set. The API returns the `GLOBAL`\n  record set, with `region: GLOBAL` and `isExcluded: true`.\n\nIf there's neither a regional record set nor a `GLOBAL` record set\nto return, the API returns `404 Not Found`. This includes a region\nwith an exclusion when neither record set exists.\n",
        "tags": [
          "RRSets"
        ],
        "parameters": [
          {
            "$ref": "#/components/parameters/XRequestId"
          }
        ],
        "responses": {
          "200": {
            "description": "The regional record set, or the `GLOBAL` record set if the\nregion has none. The record set has `isExcluded: true` if the\nregion has an exclusion.\n",
            "headers": {
              "X-Request-Id": {
                "$ref": "#/components/headers/XRequestId"
              },
              "X-RateLimit-Limit": {
                "$ref": "#/components/headers/XRateLimitLimit"
              },
              "X-RateLimit-Remaining": {
                "$ref": "#/components/headers/XRateLimitRemaining"
              },
              "X-RateLimit-Reset": {
                "$ref": "#/components/headers/XRateLimitReset"
              }
            },
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/RRSet"
                },
                "examples": {
                  "standardOverride": {
                    "summary": "Regional record set with the NONE routing policy",
                    "value": {
                      "zoneName": "example.com.",
                      "name": "www.example.com.",
                      "rrtype": "A",
                      "ttl": 120,
                      "routing": {
                        "policy": "NONE",
                        "content": [
                          "192.0.2.23"
                        ]
                      },
                      "region": "EUROPE",
                      "createdAt": "2026-07-30T10:00:00Z",
                      "updatedAt": "2026-07-30T10:00:00Z"
                    }
                  },
                  "failoverOverride": {
                    "summary": "Regional record set with the SIMPLE_FAILOVER routing policy",
                    "value": {
                      "zoneName": "example.com.",
                      "name": "www.example.com.",
                      "rrtype": "A",
                      "ttl": 120,
                      "routing": {
                        "policy": "SIMPLE_FAILOVER",
                        "status": "Healthy",
                        "failureSensitivity": "HIGH",
                        "monitor": {
                          "protocol": "HTTPS",
                          "host": "www.example.com",
                          "port": 443,
                          "path": "/health",
                          "searchString": "OK"
                        },
                        "endpoints": [
                          {
                            "target": "192.0.2.50",
                            "priority": 1,
                            "isEnabled": true,
                            "health": "Healthy",
                            "isServing": true
                          },
                          {
                            "target": "192.0.2.51",
                            "priority": 2,
                            "isEnabled": true,
                            "health": "Healthy",
                            "isServing": false
                          }
                        ],
                        "systemGenerated": [
                          "USER_DEFINED",
                          "USER_DEFINED"
                        ]
                      },
                      "region": "EUROPE",
                      "createdAt": "2026-07-30T10:00:00Z",
                      "updatedAt": "2026-07-30T10:00:00Z"
                    }
                  },
                  "globalFallback": {
                    "summary": "No regional record set, so the API returns the GLOBAL record set",
                    "value": {
                      "zoneName": "example.com.",
                      "name": "www.example.com.",
                      "rrtype": "A",
                      "ttl": 300,
                      "routing": {
                        "policy": "NONE",
                        "content": [
                          "192.0.2.1"
                        ]
                      },
                      "region": "GLOBAL",
                      "createdAt": "2026-07-30T10:00:00Z",
                      "updatedAt": "2026-07-30T10:00:00Z"
                    }
                  },
                  "excludedRegion": {
                    "summary": "Region with an exclusion and no regional record set, so the GLOBAL record set has isExcluded",
                    "value": {
                      "zoneName": "example.com.",
                      "name": "www.example.com.",
                      "rrtype": "A",
                      "ttl": 300,
                      "routing": {
                        "policy": "NONE",
                        "content": [
                          "192.0.2.1"
                        ]
                      },
                      "region": "GLOBAL",
                      "isExcluded": true,
                      "createdAt": "2026-07-30T10:00:00Z",
                      "updatedAt": "2026-07-30T10:00:00Z"
                    }
                  },
                  "disabledRegionalRecordSet": {
                    "summary": "Region with an exclusion and a regional record set, so the regional record set has isExcluded",
                    "value": {
                      "zoneName": "example.com.",
                      "name": "www.example.com.",
                      "rrtype": "A",
                      "ttl": 300,
                      "routing": {
                        "policy": "NONE",
                        "content": [
                          "192.0.2.2"
                        ]
                      },
                      "region": "EUROPE",
                      "isExcluded": true,
                      "createdAt": "2026-07-30T10:00:00Z",
                      "updatedAt": "2026-07-30T10:00:00Z"
                    }
                  }
                }
              }
            }
          },
          "401": {
            "$ref": "#/components/responses/Unauthorized"
          },
          "403": {
            "$ref": "#/components/responses/Forbidden"
          },
          "404": {
            "$ref": "#/components/responses/NotFound"
          },
          "429": {
            "$ref": "#/components/responses/TooManyRequests"
          },
          "500": {
            "$ref": "#/components/responses/InternalServerError"
          },
          "502": {
            "$ref": "#/components/responses/BadGateway"
          },
          "503": {
            "$ref": "#/components/responses/ServiceUnavailable"
          },
          "504": {
            "$ref": "#/components/responses/GatewayTimeout"
          }
        }
      },
      "post": {
        "operationId": "createRegionalResourceRecordSet",
        "x-required-permission": "account.zones.records:create",
        "summary": "Create a regional record set",
        "description": "Creates a regional record set, which replaces a record set in one\nregion. Use it for a zone with regional views, where\n`advancedConfig.isRegionalViewEnabled` is `true`. The body takes\nthe same `NONE` and `SIMPLE_FAILOVER` routing policies as a\n`GLOBAL` record set.\n\n**Creating a regional record set that already exists**\n\nIf the region already has a regional record set for the record\nset, the API doesn't return `409 Conflict`. It adds the values in\n`routing.content` to the existing values, and returns\n`201 Created` with the full record set. This differs from\n`POST /zones/{zoneName}/records/{rrtype}/{name}`, which returns\n`409 Conflict`.\n\nSo a retried create can add the values twice. To retry safely, use\n`PUT` or `PATCH` on the regional record set instead.\n\nAn `Idempotency-Key` helps only after the first request finishes.\nA retry with the same key then returns the original `201` response\nwith `X-Idempotent-Replayed: true`, and doesn't add the values\nagain. The API doesn't store `429` or `5xx` responses, so after one\nof those, a retry with the same key runs again and can add the\nvalues twice. A request with a new key or no key always adds the\nvalues.\n\nIf the region has an exclusion for the record set, the API returns\n`409 Conflict`. Delete the exclusion first.\n",
        "tags": [
          "RRSets"
        ],
        "parameters": [
          {
            "$ref": "#/components/parameters/IdempotencyKey"
          },
          {
            "$ref": "#/components/parameters/XRequestId"
          }
        ],
        "requestBody": {
          "required": true,
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/RegionalRRSetCreateRequest"
              },
              "examples": {
                "standardOverride": {
                  "summary": "Regional record set with the NONE routing policy",
                  "value": {
                    "ttl": 120,
                    "routing": {
                      "policy": "NONE",
                      "content": [
                        "192.0.2.23"
                      ]
                    }
                  }
                },
                "regionalRdata": {
                  "summary": "Regional HTTPS record set with structured record data",
                  "value": {
                    "ttl": 300,
                    "routing": {
                      "policy": "NONE",
                      "rdata": [
                        {
                          "type": "HTTPS",
                          "priority": 1,
                          "targetName": ".",
                          "alpn": [
                            "h2"
                          ],
                          "ipv4hint": [
                            "192.0.2.10"
                          ]
                        }
                      ]
                    }
                  }
                },
                "failoverOverride": {
                  "summary": "Regional record set with the SIMPLE_FAILOVER routing policy",
                  "value": {
                    "ttl": 120,
                    "routing": {
                      "policy": "SIMPLE_FAILOVER",
                      "failureSensitivity": "HIGH",
                      "monitor": {
                        "protocol": "HTTPS",
                        "host": "www.example.com",
                        "port": 443,
                        "path": "/health",
                        "searchString": "OK"
                      },
                      "endpoints": [
                        {
                          "target": "192.0.2.50",
                          "priority": 1,
                          "isEnabled": true
                        },
                        {
                          "target": "192.0.2.51",
                          "priority": 2,
                          "isEnabled": true
                        }
                      ]
                    }
                  }
                }
              }
            }
          }
        },
        "responses": {
          "201": {
            "description": "The regional record set was created, or the values were added to an existing one.",
            "headers": {
              "Location": {
                "$ref": "#/components/headers/Location"
              },
              "X-Request-Id": {
                "$ref": "#/components/headers/XRequestId"
              },
              "X-Idempotent-Replayed": {
                "$ref": "#/components/headers/XIdempotentReplayed"
              },
              "X-RateLimit-Limit": {
                "$ref": "#/components/headers/XRateLimitLimit"
              },
              "X-RateLimit-Remaining": {
                "$ref": "#/components/headers/XRateLimitRemaining"
              },
              "X-RateLimit-Reset": {
                "$ref": "#/components/headers/XRateLimitReset"
              }
            },
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/RegionalRRSet"
                },
                "examples": {
                  "created": {
                    "summary": "Regional record set created",
                    "value": {
                      "zoneName": "example.com.",
                      "name": "www.example.com.",
                      "rrtype": "A",
                      "ttl": 120,
                      "routing": {
                        "policy": "NONE",
                        "content": [
                          "192.0.2.23"
                        ]
                      },
                      "region": "EUROPE",
                      "createdAt": "2026-07-30T10:00:00Z",
                      "updatedAt": "2026-07-30T10:00:00Z"
                    }
                  },
                  "appendedOverride": {
                    "summary": "Second create for an existing regional record set adds the values",
                    "value": {
                      "zoneName": "example.com.",
                      "name": "www.example.com.",
                      "rrtype": "A",
                      "ttl": 120,
                      "routing": {
                        "policy": "NONE",
                        "content": [
                          "192.0.2.23",
                          "192.0.2.24"
                        ]
                      },
                      "region": "EUROPE",
                      "createdAt": "2026-07-30T10:00:00Z",
                      "updatedAt": "2026-07-30T11:00:00Z"
                    }
                  },
                  "failoverOverride": {
                    "summary": "SIMPLE_FAILOVER regional record set created",
                    "value": {
                      "zoneName": "example.com.",
                      "name": "www.example.com.",
                      "rrtype": "A",
                      "ttl": 120,
                      "routing": {
                        "policy": "SIMPLE_FAILOVER",
                        "status": "Healthy",
                        "failureSensitivity": "HIGH",
                        "monitor": {
                          "protocol": "HTTPS",
                          "host": "www.example.com",
                          "port": 443,
                          "path": "/health",
                          "searchString": "OK"
                        },
                        "endpoints": [
                          {
                            "target": "192.0.2.50",
                            "priority": 1,
                            "isEnabled": true,
                            "health": "Healthy",
                            "isServing": true
                          },
                          {
                            "target": "192.0.2.51",
                            "priority": 2,
                            "isEnabled": true,
                            "health": "Healthy",
                            "isServing": false
                          }
                        ],
                        "systemGenerated": [
                          "USER_DEFINED",
                          "USER_DEFINED"
                        ]
                      },
                      "region": "EUROPE",
                      "createdAt": "2026-07-30T10:00:00Z",
                      "updatedAt": "2026-07-30T10:00:00Z"
                    }
                  }
                }
              }
            }
          },
          "400": {
            "$ref": "#/components/responses/BadRequestRRSet"
          },
          "401": {
            "$ref": "#/components/responses/Unauthorized"
          },
          "403": {
            "$ref": "#/components/responses/Forbidden"
          },
          "404": {
            "$ref": "#/components/responses/NotFound"
          },
          "409": {
            "$ref": "#/components/responses/Conflict"
          },
          "415": {
            "$ref": "#/components/responses/UnsupportedMediaType"
          },
          "422": {
            "$ref": "#/components/responses/UnprocessableEntity"
          },
          "429": {
            "$ref": "#/components/responses/TooManyRequests"
          },
          "500": {
            "$ref": "#/components/responses/InternalServerError"
          },
          "502": {
            "$ref": "#/components/responses/BadGateway"
          },
          "503": {
            "$ref": "#/components/responses/ServiceUnavailable"
          },
          "504": {
            "$ref": "#/components/responses/GatewayTimeout"
          }
        }
      },
      "put": {
        "operationId": "updateRegionalResourceRecordSet",
        "x-required-permission": "account.zones.records:update",
        "summary": "Replace a regional record set",
        "description": "Replaces a regional record set. Use it for a zone with regional\nviews, where `advancedConfig.isRegionalViewEnabled` is `true`.\n\nIf the region has an exclusion for the record set, the API returns\n`409 Conflict`. Delete the exclusion first.\n",
        "tags": [
          "RRSets"
        ],
        "parameters": [
          {
            "$ref": "#/components/parameters/IdempotencyKeyOptional"
          },
          {
            "$ref": "#/components/parameters/XRequestId"
          }
        ],
        "requestBody": {
          "required": true,
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/RegionalRRSetUpdateRequest"
              },
              "examples": {
                "standardOverride": {
                  "summary": "Replace a regional record set with the NONE routing policy",
                  "value": {
                    "ttl": 120,
                    "routing": {
                      "policy": "NONE",
                      "content": [
                        "192.0.2.24"
                      ]
                    }
                  }
                },
                "regionalRdata": {
                  "summary": "Replace a regional HTTPS record set with structured record data",
                  "value": {
                    "ttl": 300,
                    "routing": {
                      "policy": "NONE",
                      "rdata": [
                        {
                          "type": "HTTPS",
                          "priority": 1,
                          "targetName": ".",
                          "alpn": [
                            "h2"
                          ],
                          "ipv4hint": [
                            "192.0.2.10"
                          ]
                        }
                      ]
                    }
                  }
                },
                "failoverOverride": {
                  "summary": "Replace a regional record set with a SIMPLE_FAILOVER one",
                  "value": {
                    "ttl": 120,
                    "routing": {
                      "policy": "SIMPLE_FAILOVER",
                      "failureSensitivity": "HIGH",
                      "monitor": {
                        "protocol": "HTTPS",
                        "host": "www.example.com",
                        "port": 443,
                        "path": "/health",
                        "searchString": "OK"
                      },
                      "endpoints": [
                        {
                          "target": "192.0.2.50",
                          "priority": 1,
                          "isEnabled": true
                        },
                        {
                          "target": "192.0.2.51",
                          "priority": 2,
                          "isEnabled": true
                        }
                      ]
                    }
                  }
                }
              }
            }
          }
        },
        "responses": {
          "200": {
            "description": "The regional record set was replaced.",
            "headers": {
              "X-Request-Id": {
                "$ref": "#/components/headers/XRequestId"
              },
              "X-Idempotent-Replayed": {
                "$ref": "#/components/headers/XIdempotentReplayed"
              },
              "X-RateLimit-Limit": {
                "$ref": "#/components/headers/XRateLimitLimit"
              },
              "X-RateLimit-Remaining": {
                "$ref": "#/components/headers/XRateLimitRemaining"
              },
              "X-RateLimit-Reset": {
                "$ref": "#/components/headers/XRateLimitReset"
              }
            },
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/RegionalRRSet"
                },
                "examples": {
                  "standardOverride": {
                    "summary": "NONE regional record set replaced",
                    "value": {
                      "zoneName": "example.com.",
                      "name": "www.example.com.",
                      "rrtype": "A",
                      "ttl": 120,
                      "routing": {
                        "policy": "NONE",
                        "content": [
                          "192.0.2.24"
                        ]
                      },
                      "region": "EUROPE",
                      "createdAt": "2026-07-30T10:00:00Z",
                      "updatedAt": "2026-07-30T10:00:00Z"
                    }
                  },
                  "failoverOverride": {
                    "summary": "SIMPLE_FAILOVER regional record set replaced",
                    "value": {
                      "zoneName": "example.com.",
                      "name": "www.example.com.",
                      "rrtype": "A",
                      "ttl": 120,
                      "routing": {
                        "policy": "SIMPLE_FAILOVER",
                        "status": "Healthy",
                        "failureSensitivity": "HIGH",
                        "monitor": {
                          "protocol": "HTTPS",
                          "host": "www.example.com",
                          "port": 443,
                          "path": "/health",
                          "searchString": "OK"
                        },
                        "endpoints": [
                          {
                            "target": "192.0.2.50",
                            "priority": 1,
                            "isEnabled": true,
                            "health": "Healthy",
                            "isServing": true
                          },
                          {
                            "target": "192.0.2.51",
                            "priority": 2,
                            "isEnabled": true,
                            "health": "Healthy",
                            "isServing": false
                          }
                        ],
                        "systemGenerated": [
                          "USER_DEFINED",
                          "USER_DEFINED"
                        ]
                      },
                      "region": "EUROPE",
                      "createdAt": "2026-07-30T10:00:00Z",
                      "updatedAt": "2026-07-30T10:00:00Z"
                    }
                  }
                }
              }
            }
          },
          "400": {
            "$ref": "#/components/responses/BadRequestRRSet"
          },
          "401": {
            "$ref": "#/components/responses/Unauthorized"
          },
          "403": {
            "$ref": "#/components/responses/Forbidden"
          },
          "404": {
            "$ref": "#/components/responses/NotFound"
          },
          "409": {
            "$ref": "#/components/responses/Conflict"
          },
          "415": {
            "$ref": "#/components/responses/UnsupportedMediaType"
          },
          "422": {
            "$ref": "#/components/responses/UnprocessableEntity"
          },
          "429": {
            "$ref": "#/components/responses/TooManyRequests"
          },
          "500": {
            "$ref": "#/components/responses/InternalServerError"
          },
          "502": {
            "$ref": "#/components/responses/BadGateway"
          },
          "503": {
            "$ref": "#/components/responses/ServiceUnavailable"
          },
          "504": {
            "$ref": "#/components/responses/GatewayTimeout"
          }
        }
      },
      "patch": {
        "operationId": "patchRegionalResourceRecordSet",
        "x-required-permission": "account.zones.records:update",
        "summary": "Update part of a regional record set",
        "description": "Updates part of a regional record set. Send only the fields to\nchange. The API keeps the fields you leave out, and replaces\n`routing` as a whole. Use it for a zone with regional views, where\n`advancedConfig.isRegionalViewEnabled` is `true`.\n\nIf the region has an exclusion for the record set, the API returns\n`409 Conflict`. Delete the exclusion first.\n",
        "tags": [
          "RRSets"
        ],
        "parameters": [
          {
            "$ref": "#/components/parameters/IdempotencyKey"
          },
          {
            "$ref": "#/components/parameters/XRequestId"
          }
        ],
        "requestBody": {
          "required": true,
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/RegionalRRSetPatchRequest"
              },
              "examples": {
                "ttlOnly": {
                  "summary": "Change only the TTL",
                  "value": {
                    "ttl": 60
                  }
                },
                "updateRoutingFailover": {
                  "summary": "Replace the routing with SIMPLE_FAILOVER routing",
                  "value": {
                    "routing": {
                      "policy": "SIMPLE_FAILOVER",
                      "failureSensitivity": "HIGH",
                      "monitor": {
                        "protocol": "HTTPS",
                        "host": "www.example.com",
                        "port": 443,
                        "path": "/health",
                        "searchString": "OK"
                      },
                      "endpoints": [
                        {
                          "target": "192.0.2.50",
                          "priority": 1,
                          "isEnabled": true
                        },
                        {
                          "target": "192.0.2.51",
                          "priority": 2,
                          "isEnabled": true
                        }
                      ]
                    }
                  }
                },
                "updateRoutingNoneRdata": {
                  "summary": "Replace the routing with structured record data",
                  "description": "The API replaces `routing` as a whole, so send either\n`content` or `rdata`, not both. Create and replace follow\nthe same rule.\n",
                  "value": {
                    "routing": {
                      "policy": "NONE",
                      "rdata": [
                        {
                          "type": "SVCB",
                          "priority": 1,
                          "targetName": "svc.example.net.",
                          "alpn": [
                            "h2"
                          ],
                          "port": 443
                        }
                      ]
                    }
                  }
                }
              }
            }
          }
        },
        "responses": {
          "200": {
            "description": "The regional record set was updated.",
            "headers": {
              "X-Request-Id": {
                "$ref": "#/components/headers/XRequestId"
              },
              "X-Idempotent-Replayed": {
                "$ref": "#/components/headers/XIdempotentReplayed"
              },
              "X-RateLimit-Limit": {
                "$ref": "#/components/headers/XRateLimitLimit"
              },
              "X-RateLimit-Remaining": {
                "$ref": "#/components/headers/XRateLimitRemaining"
              },
              "X-RateLimit-Reset": {
                "$ref": "#/components/headers/XRateLimitReset"
              }
            },
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/RegionalRRSet"
                },
                "examples": {
                  "ttlOnly": {
                    "summary": "NONE regional record set with a new TTL",
                    "value": {
                      "zoneName": "example.com.",
                      "name": "www.example.com.",
                      "rrtype": "A",
                      "ttl": 60,
                      "routing": {
                        "policy": "NONE",
                        "content": [
                          "192.0.2.23"
                        ]
                      },
                      "region": "EUROPE",
                      "createdAt": "2026-07-30T10:00:00Z",
                      "updatedAt": "2026-07-30T10:00:00Z"
                    }
                  },
                  "updateRoutingFailover": {
                    "summary": "SIMPLE_FAILOVER regional record set after a routing update",
                    "value": {
                      "zoneName": "example.com.",
                      "name": "www.example.com.",
                      "rrtype": "A",
                      "ttl": 120,
                      "routing": {
                        "policy": "SIMPLE_FAILOVER",
                        "status": "Healthy",
                        "failureSensitivity": "HIGH",
                        "monitor": {
                          "protocol": "HTTPS",
                          "host": "www.example.com",
                          "port": 443,
                          "path": "/health",
                          "searchString": "OK"
                        },
                        "endpoints": [
                          {
                            "target": "192.0.2.50",
                            "priority": 1,
                            "isEnabled": true,
                            "health": "Healthy",
                            "isServing": true
                          },
                          {
                            "target": "192.0.2.51",
                            "priority": 2,
                            "isEnabled": true,
                            "health": "Healthy",
                            "isServing": false
                          }
                        ],
                        "systemGenerated": [
                          "USER_DEFINED",
                          "USER_DEFINED"
                        ]
                      },
                      "region": "EUROPE",
                      "createdAt": "2026-07-30T10:00:00Z",
                      "updatedAt": "2026-07-30T10:00:00Z"
                    }
                  }
                }
              }
            }
          },
          "400": {
            "$ref": "#/components/responses/BadRequestRRSet"
          },
          "401": {
            "$ref": "#/components/responses/Unauthorized"
          },
          "403": {
            "$ref": "#/components/responses/Forbidden"
          },
          "404": {
            "$ref": "#/components/responses/NotFound"
          },
          "409": {
            "$ref": "#/components/responses/Conflict"
          },
          "415": {
            "$ref": "#/components/responses/UnsupportedMediaType"
          },
          "422": {
            "$ref": "#/components/responses/UnprocessableEntity"
          },
          "429": {
            "$ref": "#/components/responses/TooManyRequests"
          },
          "500": {
            "$ref": "#/components/responses/InternalServerError"
          },
          "502": {
            "$ref": "#/components/responses/BadGateway"
          },
          "503": {
            "$ref": "#/components/responses/ServiceUnavailable"
          },
          "504": {
            "$ref": "#/components/responses/GatewayTimeout"
          }
        }
      },
      "delete": {
        "operationId": "deleteRegionalResourceRecordSet",
        "x-required-permission": "account.zones.records:delete",
        "summary": "Delete a regional record set",
        "description": "Deletes a regional record set. The `GLOBAL` record set doesn't\nchange, and the region falls back to it. Use it for a zone with\nregional views, where `advancedConfig.isRegionalViewEnabled` is\n`true`.\n",
        "tags": [
          "RRSets"
        ],
        "parameters": [
          {
            "$ref": "#/components/parameters/IdempotencyKeyOptional"
          },
          {
            "$ref": "#/components/parameters/XRequestId"
          }
        ],
        "responses": {
          "204": {
            "description": "The regional record set was deleted. The response has no body.",
            "headers": {
              "X-Request-Id": {
                "$ref": "#/components/headers/XRequestId"
              },
              "X-Idempotent-Replayed": {
                "$ref": "#/components/headers/XIdempotentReplayed"
              },
              "X-RateLimit-Limit": {
                "$ref": "#/components/headers/XRateLimitLimit"
              },
              "X-RateLimit-Remaining": {
                "$ref": "#/components/headers/XRateLimitRemaining"
              },
              "X-RateLimit-Reset": {
                "$ref": "#/components/headers/XRateLimitReset"
              }
            }
          },
          "400": {
            "$ref": "#/components/responses/BadRequest"
          },
          "401": {
            "$ref": "#/components/responses/Unauthorized"
          },
          "403": {
            "$ref": "#/components/responses/Forbidden"
          },
          "404": {
            "$ref": "#/components/responses/NotFound"
          },
          "409": {
            "$ref": "#/components/responses/Conflict"
          },
          "429": {
            "$ref": "#/components/responses/TooManyRequests"
          },
          "500": {
            "$ref": "#/components/responses/InternalServerError"
          },
          "502": {
            "$ref": "#/components/responses/BadGateway"
          },
          "503": {
            "$ref": "#/components/responses/ServiceUnavailable"
          },
          "504": {
            "$ref": "#/components/responses/GatewayTimeout"
          }
        }
      }
    },
    "/zones/{zoneName}/records/{rrtype}/{name}/exclusions/{region}": {
      "parameters": [
        {
          "$ref": "#/components/parameters/ZoneName"
        },
        {
          "$ref": "#/components/parameters/RecordType"
        },
        {
          "$ref": "#/components/parameters/Name"
        },
        {
          "$ref": "#/components/parameters/Region"
        }
      ],
      "patch": {
        "operationId": "createResourceRecordSetExclusion",
        "x-required-permission": "account.zones.records:update",
        "summary": "Exclude a region from a record set",
        "description": "Excludes a region from a record set. The region then serves no\nrecords for the owner name and record type. If the region has a\nregional record set, the exclusion disables it. Otherwise it\nsuppresses the `GLOBAL` record set, which the region would fall\nback to. Use it for a zone with regional views, where\n`advancedConfig.isRegionalViewEnabled` is `true`. Send no body or\nan empty object `{}`.\n\n**Errors**\n\n- If the region already has an exclusion for the record set, the\n  API returns `409 Conflict`. To apply it again, remove the\n  exclusion first. A retry with the same `Idempotency-Key` returns\n  the original `204` response with `X-Idempotent-Replayed: true`\n  instead.\n- If the region has no regional record set and the `GLOBAL` record\n  set doesn't exist, there's nothing to exclude, and the API\n  returns `400 Bad Request`.\n- You can't exclude a region from the `NS`, `SOA`, or `DS` record\n  set at the zone apex. If you try, the API rejects the request.\n- `GLOBAL` isn't a valid region, because it's what every region\n  falls back to. If you send it, the API returns `400 Bad Request`.\n\nWhile the exclusion exists, you can't create or change a record set\nfor the same owner name and record type in that region, and the API\nreturns `409 Conflict`. Remove the exclusion first. If you remove\nan exclusion that would leave two conflicting records in the region\n(for example a `CNAME` next to other records, or a `DMARC` `NS` or\n`CNAME` next to a `TXT`), the API returns `409 Conflict`.\n\nAn exclusion can exist when the `GLOBAL` record set doesn't, as long\nas the region has a regional record set. Deleting the `GLOBAL`\nrecord set removes the exclusions of regions that have no regional\nrecord set. Deleting a regional record set removes that region's\nexclusion. To remove an exclusion yourself, use\n`DELETE /zones/{zoneName}/records/{rrtype}/{name}/exclusions/{region}`.\nTurning regional views off for the zone removes all exclusions.\n",
        "tags": [
          "RRSets"
        ],
        "parameters": [
          {
            "$ref": "#/components/parameters/IdempotencyKey"
          },
          {
            "$ref": "#/components/parameters/XRequestId"
          }
        ],
        "requestBody": {
          "required": false,
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/RRSetRegionExclusionRequest"
              },
              "examples": {
                "empty": {
                  "summary": "Empty body",
                  "value": {}
                }
              }
            }
          }
        },
        "responses": {
          "204": {
            "description": "The region was excluded. The response has no body.",
            "headers": {
              "X-Request-Id": {
                "$ref": "#/components/headers/XRequestId"
              },
              "X-Idempotent-Replayed": {
                "$ref": "#/components/headers/XIdempotentReplayed"
              },
              "X-RateLimit-Limit": {
                "$ref": "#/components/headers/XRateLimitLimit"
              },
              "X-RateLimit-Remaining": {
                "$ref": "#/components/headers/XRateLimitRemaining"
              },
              "X-RateLimit-Reset": {
                "$ref": "#/components/headers/XRateLimitReset"
              }
            }
          },
          "400": {
            "$ref": "#/components/responses/BadRequestRRSet"
          },
          "401": {
            "$ref": "#/components/responses/Unauthorized"
          },
          "403": {
            "$ref": "#/components/responses/Forbidden"
          },
          "404": {
            "$ref": "#/components/responses/NotFound"
          },
          "409": {
            "$ref": "#/components/responses/Conflict"
          },
          "415": {
            "$ref": "#/components/responses/UnsupportedMediaType"
          },
          "422": {
            "$ref": "#/components/responses/UnprocessableEntity"
          },
          "429": {
            "$ref": "#/components/responses/TooManyRequests"
          },
          "500": {
            "$ref": "#/components/responses/InternalServerError"
          },
          "502": {
            "$ref": "#/components/responses/BadGateway"
          },
          "503": {
            "$ref": "#/components/responses/ServiceUnavailable"
          },
          "504": {
            "$ref": "#/components/responses/GatewayTimeout"
          }
        }
      },
      "delete": {
        "operationId": "deleteResourceRecordSetExclusion",
        "x-required-permission": "account.zones.records:update",
        "summary": "Remove a region exclusion from a record set",
        "description": "Removes a region's exclusion from a record set. The region then\nresolves the record set as usual again. If the region has a\nregional record set, the exclusion no longer disables it. Otherwise\nthe region serves the `GLOBAL` record set, or a regional record set\nif you create one. Use it for a zone with regional views, where\n`advancedConfig.isRegionalViewEnabled` is `true`.\n\nIf removing the exclusion would leave two conflicting records in\nthe region, the API returns `409 Conflict`. For example, the region\nhas a disabled `TXT` record set at `_dmarc` and a `CNAME` or `NS`\nrecord set that you created there later. Delete one of the two\nfirst.\n",
        "tags": [
          "RRSets"
        ],
        "parameters": [
          {
            "$ref": "#/components/parameters/IdempotencyKeyOptional"
          },
          {
            "$ref": "#/components/parameters/XRequestId"
          }
        ],
        "responses": {
          "204": {
            "description": "The exclusion was removed. The response has no body.",
            "headers": {
              "X-Request-Id": {
                "$ref": "#/components/headers/XRequestId"
              },
              "X-Idempotent-Replayed": {
                "$ref": "#/components/headers/XIdempotentReplayed"
              },
              "X-RateLimit-Limit": {
                "$ref": "#/components/headers/XRateLimitLimit"
              },
              "X-RateLimit-Remaining": {
                "$ref": "#/components/headers/XRateLimitRemaining"
              },
              "X-RateLimit-Reset": {
                "$ref": "#/components/headers/XRateLimitReset"
              }
            }
          },
          "401": {
            "$ref": "#/components/responses/Unauthorized"
          },
          "403": {
            "$ref": "#/components/responses/Forbidden"
          },
          "404": {
            "$ref": "#/components/responses/NotFound"
          },
          "409": {
            "$ref": "#/components/responses/Conflict"
          },
          "429": {
            "$ref": "#/components/responses/TooManyRequests"
          },
          "500": {
            "$ref": "#/components/responses/InternalServerError"
          },
          "502": {
            "$ref": "#/components/responses/BadGateway"
          },
          "503": {
            "$ref": "#/components/responses/ServiceUnavailable"
          },
          "504": {
            "$ref": "#/components/responses/GatewayTimeout"
          }
        }
      }
    },
    "/tasks/async/{taskId}": {
      "parameters": [
        {
          "$ref": "#/components/parameters/TaskId"
        }
      ],
      "get": {
        "operationId": "getTask",
        "x-required-permission": "account.tasks.async:read",
        "summary": "Get a task",
        "description": "Gets the current state of a task. Operations that take too long to\nfinish within one request, such as importing records from a zone\nfile, exporting zones, and refreshing a secondary zone, return\n`202 Accepted` and a `Location` header\nthat points here.\n\n**Polling a task**\n\n- Getting a task doesn't change it, so you can poll as often as your\n  rate limit allows.\n- The task's `status` is `PENDING`, `RUNNING`, `SUCCEEDED`, or\n  `FAILED`. `CANCELLED` isn't currently returned.\n- A batch task is `FAILED` if any of its sub-requests failed. None of\n  the batch's changes are kept, and `result` describes the first\n  error.\n- The `result` field describes the outcome: what the task did if it\n  succeeded, why it failed, or its progress while it's running.\n- When the task has a resource to retrieve, such as an exported zone\n  file, `resourceUrl` points to it.\n\nAfter a task finishes, the API keeps it for a limited time. After\nthat, the API returns `404 Not Found`.\n",
        "tags": [
          "Async Tasks"
        ],
        "parameters": [
          {
            "$ref": "#/components/parameters/XRequestId"
          }
        ],
        "responses": {
          "200": {
            "description": "The task's current state.",
            "headers": {
              "X-Request-Id": {
                "$ref": "#/components/headers/XRequestId"
              },
              "X-RateLimit-Limit": {
                "$ref": "#/components/headers/XRateLimitLimit"
              },
              "X-RateLimit-Remaining": {
                "$ref": "#/components/headers/XRateLimitRemaining"
              },
              "X-RateLimit-Reset": {
                "$ref": "#/components/headers/XRateLimitReset"
              }
            },
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/AsyncTaskWithResource"
                },
                "examples": {
                  "exportZoneSucceeded": {
                    "summary": "Finished export with a download URL",
                    "description": "A finished zone export. The `resourceUrl` field is the\nURL to download the exported file from.\n",
                    "value": {
                      "id": "550e8400-e29b-41d4-a716-446655440000",
                      "status": "SUCCEEDED",
                      "type": "zone.export",
                      "submittedAt": "2026-07-06T10:00:00Z",
                      "startedAt": "2026-07-06T10:00:01Z",
                      "completedAt": "2026-07-06T10:00:15Z",
                      "resourceUrl": "https://storage.dns.digicert.com/exports/550e8400-e29b-41d4-a716-446655440000/zone-export.txt",
                      "result": "Zone example.com exported (125 records)"
                    }
                  },
                  "taskRunning": {
                    "summary": "Task in progress",
                    "value": {
                      "id": "770a0622-a40d-43f6-c938-668877662222",
                      "status": "RUNNING",
                      "type": "zone.sign",
                      "submittedAt": "2026-07-06T12:00:00Z",
                      "startedAt": "2026-07-06T12:00:03Z",
                      "result": "Signing zone example.com with DNSSEC"
                    }
                  }
                }
              }
            }
          },
          "401": {
            "$ref": "#/components/responses/Unauthorized"
          },
          "403": {
            "$ref": "#/components/responses/Forbidden"
          },
          "404": {
            "$ref": "#/components/responses/NotFound"
          },
          "429": {
            "$ref": "#/components/responses/TooManyRequests"
          },
          "500": {
            "$ref": "#/components/responses/InternalServerError"
          },
          "502": {
            "$ref": "#/components/responses/BadGateway"
          },
          "503": {
            "$ref": "#/components/responses/ServiceUnavailable"
          },
          "504": {
            "$ref": "#/components/responses/GatewayTimeout"
          }
        }
      },
      "delete": {
        "operationId": "cancelTask",
        "x-required-permission": "account.tasks.async:update",
        "summary": "Delete a finished task",
        "description": "Deletes a task that has finished, `SUCCEEDED` or `FAILED`, from your\ntask history. After that, `GET /tasks/async/{taskId}` returns `404`.\n\nYou can't cancel a task that's still `PENDING` or `RUNNING`. The API\nreturns `400 Bad Request` and the task keeps running.\n\nOnly a user with the `account-admin` role can delete a task. Anyone\nelse gets `403 Forbidden`.\n",
        "tags": [
          "Async Tasks"
        ],
        "parameters": [
          {
            "$ref": "#/components/parameters/IdempotencyKeyOptional"
          },
          {
            "$ref": "#/components/parameters/XRequestId"
          }
        ],
        "responses": {
          "204": {
            "description": "The task was deleted.",
            "headers": {
              "X-Request-Id": {
                "$ref": "#/components/headers/XRequestId"
              },
              "X-Idempotent-Replayed": {
                "$ref": "#/components/headers/XIdempotentReplayed"
              },
              "X-RateLimit-Limit": {
                "$ref": "#/components/headers/XRateLimitLimit"
              },
              "X-RateLimit-Remaining": {
                "$ref": "#/components/headers/XRateLimitRemaining"
              },
              "X-RateLimit-Reset": {
                "$ref": "#/components/headers/XRateLimitReset"
              }
            }
          },
          "401": {
            "$ref": "#/components/responses/Unauthorized"
          },
          "403": {
            "$ref": "#/components/responses/Forbidden"
          },
          "404": {
            "$ref": "#/components/responses/NotFound"
          },
          "409": {
            "$ref": "#/components/responses/Conflict"
          },
          "429": {
            "$ref": "#/components/responses/TooManyRequests"
          },
          "500": {
            "$ref": "#/components/responses/InternalServerError"
          },
          "502": {
            "$ref": "#/components/responses/BadGateway"
          },
          "503": {
            "$ref": "#/components/responses/ServiceUnavailable"
          },
          "504": {
            "$ref": "#/components/responses/GatewayTimeout"
          }
        }
      }
    },
    "/reports/usage": {
      "get": {
        "operationId": "listUsageSummaries",
        "x-required-permission": "account.reporting.reports:read",
        "summary": "List monthly usage summaries",
        "description": "Returns your account's usage for the current month and up to 12\nmonths before it, most recent month first. New accounts get fewer\nmonths.\n\nEach month shows counts of zones, records, users, failover records,\nand regional view records, plus the number of DNS query responses\nsplit between primary and secondary zones.\n",
        "tags": [
          "Reports"
        ],
        "parameters": [
          {
            "$ref": "#/components/parameters/XRequestId"
          }
        ],
        "responses": {
          "200": {
            "description": "Your account's usage for each month.",
            "headers": {
              "X-Request-Id": {
                "$ref": "#/components/headers/XRequestId"
              },
              "X-RateLimit-Limit": {
                "$ref": "#/components/headers/XRateLimitLimit"
              },
              "X-RateLimit-Remaining": {
                "$ref": "#/components/headers/XRateLimitRemaining"
              },
              "X-RateLimit-Reset": {
                "$ref": "#/components/headers/XRateLimitReset"
              }
            },
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/UsageMonthlySummaryResponse"
                }
              }
            }
          },
          "401": {
            "$ref": "#/components/responses/Unauthorized"
          },
          "403": {
            "$ref": "#/components/responses/Forbidden"
          },
          "429": {
            "$ref": "#/components/responses/TooManyRequests"
          },
          "500": {
            "$ref": "#/components/responses/InternalServerError"
          },
          "502": {
            "$ref": "#/components/responses/BadGateway"
          },
          "503": {
            "$ref": "#/components/responses/ServiceUnavailable"
          },
          "504": {
            "$ref": "#/components/responses/GatewayTimeout"
          }
        }
      }
    },
    "/reports/usage/{month}": {
      "parameters": [
        {
          "$ref": "#/components/parameters/ReportMonth"
        }
      ],
      "get": {
        "operationId": "getUsageByMonth",
        "x-required-permission": "account.reporting.reports:read",
        "summary": "Get daily usage for a month",
        "description": "Returns your account's usage for each day of a calendar month. Days\nwith no usage data show zeros.\n\nEach day shows counts of zones, records, users, failover records,\nand regional view records, plus the number of DNS query responses\nsplit between primary and secondary zones.\n",
        "tags": [
          "Reports"
        ],
        "parameters": [
          {
            "$ref": "#/components/parameters/XRequestId"
          }
        ],
        "responses": {
          "200": {
            "description": "Your account's usage for each day of the month.",
            "headers": {
              "X-Request-Id": {
                "$ref": "#/components/headers/XRequestId"
              },
              "X-RateLimit-Limit": {
                "$ref": "#/components/headers/XRateLimitLimit"
              },
              "X-RateLimit-Remaining": {
                "$ref": "#/components/headers/XRateLimitRemaining"
              },
              "X-RateLimit-Reset": {
                "$ref": "#/components/headers/XRateLimitReset"
              }
            },
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/UsageDailyByMonthResponse"
                }
              }
            }
          },
          "400": {
            "$ref": "#/components/responses/BadRequest"
          },
          "401": {
            "$ref": "#/components/responses/Unauthorized"
          },
          "403": {
            "$ref": "#/components/responses/Forbidden"
          },
          "404": {
            "$ref": "#/components/responses/NotFound"
          },
          "429": {
            "$ref": "#/components/responses/TooManyRequests"
          },
          "500": {
            "$ref": "#/components/responses/InternalServerError"
          },
          "502": {
            "$ref": "#/components/responses/BadGateway"
          },
          "503": {
            "$ref": "#/components/responses/ServiceUnavailable"
          },
          "504": {
            "$ref": "#/components/responses/GatewayTimeout"
          }
        }
      }
    },
    "/reports/query-volume/zones/monthly": {
      "post": {
        "operationId": "requestZoneMonthlyQueryVolume",
        "x-required-permission": "account.reporting.reports:read",
        "summary": "Request a monthly query volume report for zones",
        "description": "Requests a report of the DNS queries each of your zones answered\nper month, for the current month and up to 12 months before it. The\nreport takes time to build, so the API returns `202 Accepted` and a\n`Location` header that points to a task. When the task's status is\n`SUCCEEDED`, its `resourceUrl` points to the results. Get them from\nthat URL.\n\nEach zone in the report shows its type and its query count for each\nmonth, most recent month first. Filter by zone name, zone type, or\nquery count, and sort by any of them.\n\n**Month**\n\nTo filter by `queryCount` or sort by `queryCount`, set `month` to the\nmonth to compare. Without it, the API returns `400 Bad Request`.\n`month` only affects filtering and sorting. Each zone still shows all\nits months.\n\n**Fetching another page**\n\nYou can't get another page of results directly. Instead, send this\nrequest again with `pageToken` set to the `pagination.nextPageToken`\nfrom the results, and leave every other field the same. Each page\nstarts a new task.\n\nUse a new `Idempotency-Key` for each page. The API matches the key\nwithout checking the request body, so if you reuse a key, you get the\nfirst page's response again instead of a new task.\n\n**One report at a time**\n\nYour account can have only one of these reports in progress. If you\nrequest another while one is `PENDING` or `RUNNING`, the API returns\n`409 Conflict`.\n",
        "tags": [
          "Reports"
        ],
        "parameters": [
          {
            "$ref": "#/components/parameters/IdempotencyKey"
          },
          {
            "$ref": "#/components/parameters/XRequestId"
          }
        ],
        "requestBody": {
          "required": false,
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/ZoneMonthlyQueryVolumeRequest"
              },
              "examples": {
                "firstPage": {
                  "summary": "First page of primary zones, sorted by query count",
                  "value": {
                    "zoneType": "PRIMARY",
                    "month": "2026-09",
                    "sortBy": "queryCount",
                    "sortOrder": "desc",
                    "pageSize": 25
                  }
                },
                "nextPage": {
                  "summary": "Next page, using the token from the previous results",
                  "value": {
                    "zoneType": "PRIMARY",
                    "month": "2026-09",
                    "sortBy": "queryCount",
                    "sortOrder": "desc",
                    "pageSize": 25,
                    "pageToken": "eyJvIjoyNX0"
                  }
                }
              }
            }
          }
        },
        "responses": {
          "202": {
            "description": "The API accepted the report request. Poll the task in the\n`Location` header. When it succeeds, its `resourceUrl` points to\nthe results.\n",
            "headers": {
              "Location": {
                "$ref": "#/components/headers/Location"
              },
              "X-Request-Id": {
                "$ref": "#/components/headers/XRequestId"
              },
              "X-Idempotent-Replayed": {
                "$ref": "#/components/headers/XIdempotentReplayed"
              },
              "X-RateLimit-Limit": {
                "$ref": "#/components/headers/XRateLimitLimit"
              },
              "X-RateLimit-Remaining": {
                "$ref": "#/components/headers/XRateLimitRemaining"
              },
              "X-RateLimit-Reset": {
                "$ref": "#/components/headers/XRateLimitReset"
              }
            },
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/AsyncTask"
                },
                "examples": {
                  "accepted": {
                    "summary": "The report task, waiting to start",
                    "value": {
                      "id": "550e8400-e29b-41d4-a716-446655440000",
                      "status": "PENDING",
                      "type": "report.zone-monthly-query-volume",
                      "submittedAt": "2026-09-25T10:00:00Z"
                    }
                  }
                }
              }
            }
          },
          "400": {
            "$ref": "#/components/responses/BadRequest"
          },
          "401": {
            "$ref": "#/components/responses/Unauthorized"
          },
          "403": {
            "$ref": "#/components/responses/Forbidden"
          },
          "409": {
            "$ref": "#/components/responses/Conflict"
          },
          "429": {
            "$ref": "#/components/responses/TooManyRequests"
          },
          "500": {
            "$ref": "#/components/responses/InternalServerError"
          },
          "502": {
            "$ref": "#/components/responses/BadGateway"
          },
          "503": {
            "$ref": "#/components/responses/ServiceUnavailable"
          },
          "504": {
            "$ref": "#/components/responses/GatewayTimeout"
          }
        }
      }
    },
    "/reports/results/{taskId}": {
      "parameters": [
        {
          "$ref": "#/components/parameters/TaskId"
        }
      ],
      "get": {
        "operationId": "getReportResult",
        "x-required-permission": "account.reporting.reports:read",
        "summary": "Get the results of a report",
        "description": "Returns the results of a report task that has `SUCCEEDED`, such as a\nmonthly query volume report. The task's `resourceUrl`\npoints here. The shape of the results depends on the kind of report\nyou requested.\n\nIf the task doesn't exist, isn't a report task, hasn't `SUCCEEDED`\nyet, or its results are too old to keep, the API returns\n`404 Not Found`.\n\nIf the results include `pagination.nextPageToken`, there are more\npages. To get the next one, request the report again with `pageToken`\nset to that value. You can't pass a page token here.\n",
        "tags": [
          "Reports"
        ],
        "parameters": [
          {
            "$ref": "#/components/parameters/XRequestId"
          }
        ],
        "responses": {
          "200": {
            "description": "The report's results.",
            "headers": {
              "X-Request-Id": {
                "$ref": "#/components/headers/XRequestId"
              },
              "X-RateLimit-Limit": {
                "$ref": "#/components/headers/XRateLimitLimit"
              },
              "X-RateLimit-Remaining": {
                "$ref": "#/components/headers/XRateLimitRemaining"
              },
              "X-RateLimit-Reset": {
                "$ref": "#/components/headers/XRateLimitReset"
              }
            },
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ReportZoneMonthlyQueryVolumeResult"
                }
              }
            }
          },
          "401": {
            "$ref": "#/components/responses/Unauthorized"
          },
          "403": {
            "$ref": "#/components/responses/Forbidden"
          },
          "404": {
            "$ref": "#/components/responses/NotFound"
          },
          "429": {
            "$ref": "#/components/responses/TooManyRequests"
          },
          "500": {
            "$ref": "#/components/responses/InternalServerError"
          },
          "502": {
            "$ref": "#/components/responses/BadGateway"
          },
          "503": {
            "$ref": "#/components/responses/ServiceUnavailable"
          },
          "504": {
            "$ref": "#/components/responses/GatewayTimeout"
          }
        }
      }
    },
    "/reports/entitlements": {
      "get": {
        "operationId": "getEntitlements",
        "x-required-permission": "account.self:read",
        "summary": "Get entitlements",
        "description": "Returns what your account is entitled to use, such as how many\nzones, records, and users it can have and how many queries per\nminute (QPM) it can answer. Each entitlement shows its type,\nquantity, product, subscription, and when it starts and ends.\n\nEntitlement types are `QPM`, `ZONES`, `RECORDS`, `USERS`,\n`FAILOVER_RECORDS` (records with simple failover), and\n`REGIONAL_VIEW_RECORDS` (records with a regional view).\n",
        "tags": [
          "Reports"
        ],
        "parameters": [
          {
            "$ref": "#/components/parameters/XRequestId"
          }
        ],
        "responses": {
          "200": {
            "description": "Your account's entitlements.",
            "headers": {
              "X-Request-Id": {
                "$ref": "#/components/headers/XRequestId"
              },
              "X-RateLimit-Limit": {
                "$ref": "#/components/headers/XRateLimitLimit"
              },
              "X-RateLimit-Remaining": {
                "$ref": "#/components/headers/XRateLimitRemaining"
              },
              "X-RateLimit-Reset": {
                "$ref": "#/components/headers/XRateLimitReset"
              }
            },
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/EntitlementListResponse"
                }
              }
            }
          },
          "401": {
            "$ref": "#/components/responses/Unauthorized"
          },
          "403": {
            "$ref": "#/components/responses/Forbidden"
          },
          "429": {
            "$ref": "#/components/responses/TooManyRequests"
          },
          "500": {
            "$ref": "#/components/responses/InternalServerError"
          },
          "502": {
            "$ref": "#/components/responses/BadGateway"
          },
          "503": {
            "$ref": "#/components/responses/ServiceUnavailable"
          },
          "504": {
            "$ref": "#/components/responses/GatewayTimeout"
          }
        }
      }
    },
    "/reports/usage/summary": {
      "get": {
        "operationId": "getUsageSummary",
        "x-required-permission": "account.self:read",
        "summary": "Get usage summary",
        "description": "Returns a summary of your account's usage for the current month so\nfar.\n\n**Account counts**\n\nThe counts of zones, records, users, failover records, and regional\nview records are as of the most recent day in `data`, not live\nvalues. They don't include changes made since then.\n\n**Query responses**\n\n- `totalResponseCount` is the number of DNS query responses so far\n  this month. `primaryZoneQueryResponses` and\n  `secondaryZoneQueryResponses` are for the most recent day in\n  `data`, and they're `0` when usage data has no breakdown by zone\n  type.\n- `data` has one entry for each day from the first of the month to\n  the most recent day with usage data. Days with no data show zeros.\n",
        "tags": [
          "Reports"
        ],
        "parameters": [
          {
            "$ref": "#/components/parameters/XRequestId"
          }
        ],
        "responses": {
          "200": {
            "description": "Your account's usage for the current month so far.",
            "headers": {
              "X-Request-Id": {
                "$ref": "#/components/headers/XRequestId"
              },
              "X-RateLimit-Limit": {
                "$ref": "#/components/headers/XRateLimitLimit"
              },
              "X-RateLimit-Remaining": {
                "$ref": "#/components/headers/XRateLimitRemaining"
              },
              "X-RateLimit-Reset": {
                "$ref": "#/components/headers/XRateLimitReset"
              }
            },
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/UsageSummaryResponse"
                }
              }
            }
          },
          "401": {
            "$ref": "#/components/responses/Unauthorized"
          },
          "403": {
            "$ref": "#/components/responses/Forbidden"
          },
          "404": {
            "$ref": "#/components/responses/NotFound"
          },
          "429": {
            "$ref": "#/components/responses/TooManyRequests"
          },
          "500": {
            "$ref": "#/components/responses/InternalServerError"
          },
          "502": {
            "$ref": "#/components/responses/BadGateway"
          },
          "503": {
            "$ref": "#/components/responses/ServiceUnavailable"
          },
          "504": {
            "$ref": "#/components/responses/GatewayTimeout"
          }
        }
      }
    },
    "/tasks/async": {
      "get": {
        "operationId": "listTasks",
        "x-required-permission": "account.tasks.async:read",
        "summary": "List tasks",
        "description": "Returns your account's tasks, one page at a time. By default, the\nmost recently submitted tasks come first. Use `sortBy` and `sortOrder`\nto change the order. Filtering by `status` isn't supported yet.\n",
        "tags": [
          "Async Tasks"
        ],
        "parameters": [
          {
            "$ref": "#/components/parameters/pageToken"
          },
          {
            "$ref": "#/components/parameters/pageSize"
          },
          {
            "$ref": "#/components/parameters/TaskStatus"
          },
          {
            "$ref": "#/components/parameters/TaskSortBy"
          },
          {
            "$ref": "#/components/parameters/TaskSortOrder"
          },
          {
            "$ref": "#/components/parameters/XRequestId"
          }
        ],
        "responses": {
          "200": {
            "description": "A page of your tasks.",
            "headers": {
              "X-Request-Id": {
                "$ref": "#/components/headers/XRequestId"
              },
              "X-RateLimit-Limit": {
                "$ref": "#/components/headers/XRateLimitLimit"
              },
              "X-RateLimit-Remaining": {
                "$ref": "#/components/headers/XRateLimitRemaining"
              },
              "X-RateLimit-Reset": {
                "$ref": "#/components/headers/XRateLimitReset"
              }
            },
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/TaskList"
                },
                "examples": {
                  "tasks": {
                    "summary": "A page of tasks",
                    "value": {
                      "data": [
                        {
                          "id": "0d8c8a3c-9c2b-4f2b-bf2a-3a3a8a9c0a11",
                          "status": "SUCCEEDED",
                          "type": "zone.records.import",
                          "resourceUrl": "https://api.dns.digicert.com/v1/zones/example.com.",
                          "submittedAt": "2026-06-16T10:30:00Z",
                          "completedAt": "2026-06-16T10:31:10Z"
                        }
                      ],
                      "pagination": {
                        "hasMore": false,
                        "nextPageToken": null,
                        "prevPageToken": null,
                        "firstPageToken": null,
                        "lastPageToken": null
                      }
                    }
                  }
                }
              }
            }
          },
          "400": {
            "$ref": "#/components/responses/BadRequest"
          },
          "401": {
            "$ref": "#/components/responses/Unauthorized"
          },
          "403": {
            "$ref": "#/components/responses/Forbidden"
          },
          "429": {
            "$ref": "#/components/responses/TooManyRequests"
          },
          "500": {
            "$ref": "#/components/responses/InternalServerError"
          },
          "502": {
            "$ref": "#/components/responses/BadGateway"
          },
          "503": {
            "$ref": "#/components/responses/ServiceUnavailable"
          },
          "504": {
            "$ref": "#/components/responses/GatewayTimeout"
          }
        }
      }
    },
    "/dns-settings/record-defaults/soa": {
      "get": {
        "operationId": "getSoaDefaults",
        "x-required-permission": "account.dns_settings.record_defaults:read",
        "summary": "Get SOA defaults",
        "description": "Returns the default SOA record values for your account. Times are\nin seconds.\n",
        "tags": [
          "DNS Settings"
        ],
        "parameters": [
          {
            "$ref": "#/components/parameters/XRequestId"
          }
        ],
        "responses": {
          "200": {
            "description": "Your account's SOA defaults.",
            "headers": {
              "X-Request-Id": {
                "$ref": "#/components/headers/XRequestId"
              },
              "X-RateLimit-Limit": {
                "$ref": "#/components/headers/XRateLimitLimit"
              },
              "X-RateLimit-Remaining": {
                "$ref": "#/components/headers/XRateLimitRemaining"
              },
              "X-RateLimit-Reset": {
                "$ref": "#/components/headers/XRateLimitReset"
              }
            },
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/SoaTtl"
                }
              }
            }
          },
          "400": {
            "$ref": "#/components/responses/BadRequest"
          },
          "401": {
            "$ref": "#/components/responses/Unauthorized"
          },
          "403": {
            "$ref": "#/components/responses/Forbidden"
          },
          "404": {
            "$ref": "#/components/responses/NotFound"
          },
          "429": {
            "$ref": "#/components/responses/TooManyRequests"
          },
          "500": {
            "$ref": "#/components/responses/InternalServerError"
          },
          "502": {
            "$ref": "#/components/responses/BadGateway"
          },
          "503": {
            "$ref": "#/components/responses/ServiceUnavailable"
          },
          "504": {
            "$ref": "#/components/responses/GatewayTimeout"
          }
        }
      },
      "patch": {
        "operationId": "updateSoaDefaults",
        "x-required-permission": "account.dns_settings.record_defaults:update",
        "summary": "Update SOA defaults",
        "description": "Updates the default SOA record values for your account. Send only\nthe fields to change. The API keeps the fields you leave out.\n\nIf the body has no fields, the API returns `400 Bad Request`. You\ncan't clear `soaContactEmail` or `primaryNameServer`. If you send\neither one as `null` or an empty string, the API returns\n`400 Bad Request`.\n",
        "tags": [
          "DNS Settings"
        ],
        "parameters": [
          {
            "$ref": "#/components/parameters/IdempotencyKey"
          },
          {
            "$ref": "#/components/parameters/XRequestId"
          }
        ],
        "requestBody": {
          "required": true,
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/SoaTtlUpdate"
              },
              "examples": {
                "updateRefreshAndTtl": {
                  "summary": "Update the refresh interval and TTL",
                  "value": {
                    "refresh": 7200,
                    "ttl": 3600
                  }
                }
              }
            }
          }
        },
        "responses": {
          "200": {
            "description": "Your account's SOA defaults, after the update.",
            "headers": {
              "X-Request-Id": {
                "$ref": "#/components/headers/XRequestId"
              },
              "X-Idempotent-Replayed": {
                "$ref": "#/components/headers/XIdempotentReplayed"
              },
              "X-RateLimit-Limit": {
                "$ref": "#/components/headers/XRateLimitLimit"
              },
              "X-RateLimit-Remaining": {
                "$ref": "#/components/headers/XRateLimitRemaining"
              },
              "X-RateLimit-Reset": {
                "$ref": "#/components/headers/XRateLimitReset"
              }
            },
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/SoaTtl"
                }
              }
            }
          },
          "400": {
            "$ref": "#/components/responses/BadRequest"
          },
          "401": {
            "$ref": "#/components/responses/Unauthorized"
          },
          "403": {
            "$ref": "#/components/responses/Forbidden"
          },
          "404": {
            "$ref": "#/components/responses/NotFound"
          },
          "409": {
            "$ref": "#/components/responses/Conflict"
          },
          "415": {
            "$ref": "#/components/responses/UnsupportedMediaType"
          },
          "429": {
            "$ref": "#/components/responses/TooManyRequests"
          },
          "500": {
            "$ref": "#/components/responses/InternalServerError"
          },
          "502": {
            "$ref": "#/components/responses/BadGateway"
          },
          "503": {
            "$ref": "#/components/responses/ServiceUnavailable"
          },
          "504": {
            "$ref": "#/components/responses/GatewayTimeout"
          }
        }
      }
    },
    "/zones/{zoneName}:dnssec": {
      "parameters": [
        {
          "$ref": "#/components/parameters/ZoneName"
        }
      ],
      "post": {
        "operationId": "signZone",
        "x-required-permission": "account.zones:update",
        "summary": "Sign a zone with DNSSEC",
        "description": "Signs a zone with DNSSEC, using your account's default DNSSEC\npolicy. Signing finishes before the API responds. The response is\n`201 Created`, with the zone's DNSSEC status in the body and a\n`Location` header that points to it.\n\nThe body is optional. Use `reason` to note why you're making the\nchange.\n\nAfter you sign the zone, publish its DS records in the parent zone,\nusually through your registrar. To get the DS records, use\n`GET /zones/{zoneName}:dnssec`.\n",
        "tags": [
          "DNSSEC"
        ],
        "parameters": [
          {
            "$ref": "#/components/parameters/IdempotencyKey"
          },
          {
            "$ref": "#/components/parameters/XRequestId"
          }
        ],
        "requestBody": {
          "required": false,
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/DnsSecChangeRequest"
              },
              "examples": {
                "withComment": {
                  "summary": "Sign with a change reason",
                  "value": {
                    "reason": "Enabling DNSSEC for compliance"
                  }
                }
              }
            }
          }
        },
        "responses": {
          "201": {
            "description": "The zone was signed.",
            "headers": {
              "Location": {
                "$ref": "#/components/headers/Location"
              },
              "X-Request-Id": {
                "$ref": "#/components/headers/XRequestId"
              },
              "X-Idempotent-Replayed": {
                "$ref": "#/components/headers/XIdempotentReplayed"
              },
              "X-RateLimit-Limit": {
                "$ref": "#/components/headers/XRateLimitLimit"
              },
              "X-RateLimit-Remaining": {
                "$ref": "#/components/headers/XRateLimitRemaining"
              },
              "X-RateLimit-Reset": {
                "$ref": "#/components/headers/XRateLimitReset"
              }
            },
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/DnsSecStatus"
                }
              }
            }
          },
          "400": {
            "$ref": "#/components/responses/BadRequest"
          },
          "401": {
            "$ref": "#/components/responses/Unauthorized"
          },
          "403": {
            "$ref": "#/components/responses/Forbidden"
          },
          "404": {
            "$ref": "#/components/responses/NotFound"
          },
          "409": {
            "$ref": "#/components/responses/Conflict"
          },
          "415": {
            "$ref": "#/components/responses/UnsupportedMediaType"
          },
          "422": {
            "$ref": "#/components/responses/UnprocessableEntity"
          },
          "429": {
            "$ref": "#/components/responses/TooManyRequests"
          },
          "500": {
            "$ref": "#/components/responses/InternalServerError"
          },
          "502": {
            "$ref": "#/components/responses/BadGateway"
          },
          "503": {
            "$ref": "#/components/responses/ServiceUnavailable"
          },
          "504": {
            "$ref": "#/components/responses/GatewayTimeout"
          }
        }
      },
      "get": {
        "operationId": "getZoneDnssec",
        "x-required-permission": "account.zones:read",
        "summary": "Get DNSSEC status for a zone",
        "description": "Returns a zone's DNSSEC status and keys. `keys` lists the zone's\nactive zone signing keys (ZSKs) and key signing keys (KSKs). Each\nKSK includes the DS records to publish in the parent zone.\n",
        "tags": [
          "DNSSEC"
        ],
        "parameters": [
          {
            "$ref": "#/components/parameters/XRequestId"
          }
        ],
        "responses": {
          "200": {
            "description": "The zone's DNSSEC status and keys.",
            "headers": {
              "X-Request-Id": {
                "$ref": "#/components/headers/XRequestId"
              },
              "X-RateLimit-Limit": {
                "$ref": "#/components/headers/XRateLimitLimit"
              },
              "X-RateLimit-Remaining": {
                "$ref": "#/components/headers/XRateLimitRemaining"
              },
              "X-RateLimit-Reset": {
                "$ref": "#/components/headers/XRateLimitReset"
              }
            },
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/DnsSecStatus"
                }
              }
            }
          },
          "401": {
            "$ref": "#/components/responses/Unauthorized"
          },
          "403": {
            "$ref": "#/components/responses/Forbidden"
          },
          "404": {
            "$ref": "#/components/responses/NotFound"
          },
          "429": {
            "$ref": "#/components/responses/TooManyRequests"
          },
          "500": {
            "$ref": "#/components/responses/InternalServerError"
          },
          "502": {
            "$ref": "#/components/responses/BadGateway"
          },
          "503": {
            "$ref": "#/components/responses/ServiceUnavailable"
          },
          "504": {
            "$ref": "#/components/responses/GatewayTimeout"
          }
        }
      },
      "delete": {
        "operationId": "unsignZone",
        "x-required-permission": "account.zones:update",
        "summary": "Unsign a zone",
        "description": "Removes DNSSEC from a zone. Unsigning finishes before the API\nresponds. The response is `204 No Content`.\n\nThe body is optional. Use `reason` to note why you're making the\nchange.\n\nBefore you unsign the zone, remove its DS records from the parent\nzone. If resolvers still find DS records for an unsigned zone,\nDNSSEC validation fails for it.\n",
        "tags": [
          "DNSSEC"
        ],
        "parameters": [
          {
            "$ref": "#/components/parameters/IdempotencyKeyOptional"
          },
          {
            "$ref": "#/components/parameters/XRequestId"
          }
        ],
        "requestBody": {
          "required": false,
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/DnsSecChangeRequest"
              },
              "examples": {
                "withComment": {
                  "summary": "Unsign with a change reason",
                  "value": {
                    "reason": "Removing DNSSEC pending key ceremony"
                  }
                }
              }
            }
          }
        },
        "responses": {
          "204": {
            "description": "The zone was unsigned. The response has no body.",
            "headers": {
              "X-Request-Id": {
                "$ref": "#/components/headers/XRequestId"
              },
              "X-Idempotent-Replayed": {
                "$ref": "#/components/headers/XIdempotentReplayed"
              },
              "X-RateLimit-Limit": {
                "$ref": "#/components/headers/XRateLimitLimit"
              },
              "X-RateLimit-Remaining": {
                "$ref": "#/components/headers/XRateLimitRemaining"
              },
              "X-RateLimit-Reset": {
                "$ref": "#/components/headers/XRateLimitReset"
              }
            }
          },
          "401": {
            "$ref": "#/components/responses/Unauthorized"
          },
          "403": {
            "$ref": "#/components/responses/Forbidden"
          },
          "404": {
            "$ref": "#/components/responses/NotFound"
          },
          "409": {
            "$ref": "#/components/responses/Conflict"
          },
          "422": {
            "$ref": "#/components/responses/UnprocessableEntity"
          },
          "429": {
            "$ref": "#/components/responses/TooManyRequests"
          },
          "500": {
            "$ref": "#/components/responses/InternalServerError"
          },
          "502": {
            "$ref": "#/components/responses/BadGateway"
          },
          "503": {
            "$ref": "#/components/responses/ServiceUnavailable"
          },
          "504": {
            "$ref": "#/components/responses/GatewayTimeout"
          }
        }
      }
    },
    "/dns-settings/inbound/nameserver-sets": {
      "get": {
        "operationId": "listInboundNameserverSets",
        "summary": "List Inbound IP Sets",
        "description": "Returns your account's Inbound IP Sets, one page at a time. Filter\nby set name, primary nameserver address, NOTIFY address, or the\nnumber of zones that use the set. Sort by name or zone count.\n",
        "tags": [
          "Inbound IP Sets"
        ],
        "x-required-permission": "account.dns_settings.inbound:read",
        "parameters": [
          {
            "$ref": "#/components/parameters/pageToken"
          },
          {
            "$ref": "#/components/parameters/pageSize"
          },
          {
            "$ref": "#/components/parameters/InboundNsSetSortBy"
          },
          {
            "$ref": "#/components/parameters/InboundNsSetSortOrder"
          },
          {
            "name": "name",
            "in": "query",
            "required": false,
            "schema": {
              "type": "string",
              "minLength": 3
            },
            "description": "Returns sets whose name contains this text. Case doesn't matter.\nEnter at least 3 characters.\n",
            "example": "upstream-prod"
          },
          {
            "name": "primaryNameServer",
            "in": "query",
            "required": false,
            "schema": {
              "type": "string",
              "minLength": 3
            },
            "description": "Returns sets with a primary nameserver address that contains this\ntext. Enter at least 3 characters.\n",
            "example": "192.0.2.53"
          },
          {
            "name": "notifyIp",
            "in": "query",
            "required": false,
            "schema": {
              "type": "string",
              "minLength": 3
            },
            "description": "Returns sets with an address in `notifyAllowedIPs` that contains\nthis text. Enter at least 3 characters.\n",
            "example": "192.0.2"
          },
          {
            "$ref": "#/components/parameters/ZoneCount"
          },
          {
            "$ref": "#/components/parameters/XRequestId"
          }
        ],
        "responses": {
          "200": {
            "description": "A page of your Inbound IP Sets.",
            "headers": {
              "X-Request-Id": {
                "$ref": "#/components/headers/XRequestId"
              },
              "X-RateLimit-Limit": {
                "$ref": "#/components/headers/XRateLimitLimit"
              },
              "X-RateLimit-Remaining": {
                "$ref": "#/components/headers/XRateLimitRemaining"
              },
              "X-RateLimit-Reset": {
                "$ref": "#/components/headers/XRateLimitReset"
              }
            },
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/NameserverSetList"
                }
              }
            }
          },
          "400": {
            "description": "A query parameter isn't valid.",
            "content": {
              "application/problem+json": {
                "schema": {
                  "$ref": "#/components/schemas/ProblemDetail"
                },
                "examples": {
                  "badPageSize": {
                    "summary": "Page size out of range",
                    "value": {
                      "type": "https://errors.dns.digicert.com/bad-request",
                      "title": "Validation Error",
                      "status": 400,
                      "detail": "'pageSize' must be between 1 and 100."
                    }
                  }
                }
              }
            }
          },
          "401": {
            "$ref": "#/components/responses/Unauthorized"
          },
          "403": {
            "$ref": "#/components/responses/Forbidden"
          },
          "429": {
            "$ref": "#/components/responses/TooManyRequests"
          },
          "500": {
            "$ref": "#/components/responses/InternalServerError"
          },
          "502": {
            "$ref": "#/components/responses/BadGateway"
          },
          "503": {
            "$ref": "#/components/responses/ServiceUnavailable"
          },
          "504": {
            "$ref": "#/components/responses/GatewayTimeout"
          }
        }
      },
      "post": {
        "operationId": "createInboundNameserverSet",
        "summary": "Create an Inbound IP Set",
        "description": "Creates an Inbound IP Set in your account. To use it, set\n`secondary.inboundIpSetName` to its name when you create a secondary\nzone.\n\nSet names are unique in your account. If a set with the same name\nalready exists, the API returns `409 Conflict`.\n",
        "tags": [
          "Inbound IP Sets"
        ],
        "x-required-permission": "account.dns_settings.inbound:create",
        "parameters": [
          {
            "$ref": "#/components/parameters/IdempotencyKey"
          },
          {
            "$ref": "#/components/parameters/XRequestId"
          }
        ],
        "requestBody": {
          "required": true,
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/NameserverSetCreate"
              },
              "examples": {
                "upstreamWithBackups": {
                  "summary": "Several primary nameservers",
                  "value": {
                    "name": "upstream-prod-ns",
                    "description": "Production upstream nameservers (provider X)",
                    "notifyAllowedIPs": [
                      "192.0.2.53",
                      "2001:db8::53"
                    ],
                    "primaryNameservers": [
                      "192.0.2.53",
                      "192.0.2.54",
                      "2001:db8::14"
                    ]
                  }
                },
                "upstreamNoBackups": {
                  "summary": "One primary nameserver",
                  "value": {
                    "name": "internal-lab-ns",
                    "notifyAllowedIPs": [
                      "198.51.100.254"
                    ],
                    "primaryNameservers": [
                      "198.51.100.53"
                    ]
                  }
                }
              }
            }
          }
        },
        "responses": {
          "201": {
            "description": "The Inbound IP Set was created. The body includes its `id`. The\n`Location` header isn't currently returned.\n",
            "headers": {
              "Location": {
                "$ref": "#/components/headers/Location"
              },
              "X-Request-Id": {
                "$ref": "#/components/headers/XRequestId"
              },
              "X-Idempotent-Replayed": {
                "$ref": "#/components/headers/XIdempotentReplayed"
              },
              "X-RateLimit-Limit": {
                "$ref": "#/components/headers/XRateLimitLimit"
              },
              "X-RateLimit-Remaining": {
                "$ref": "#/components/headers/XRateLimitRemaining"
              },
              "X-RateLimit-Reset": {
                "$ref": "#/components/headers/XRateLimitReset"
              }
            },
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/NameserverSet"
                }
              }
            }
          },
          "400": {
            "description": "The request body isn't valid.",
            "content": {
              "application/problem+json": {
                "schema": {
                  "$ref": "#/components/schemas/ProblemDetail"
                },
                "examples": {
                  "missingName": {
                    "summary": "Required field missing",
                    "value": {
                      "type": "https://errors.dns.digicert.com/bad-request",
                      "title": "Validation Error",
                      "status": 400,
                      "detail": "The 'name' field mustn't be empty."
                    }
                  }
                }
              }
            }
          },
          "401": {
            "$ref": "#/components/responses/Unauthorized"
          },
          "403": {
            "$ref": "#/components/responses/Forbidden"
          },
          "409": {
            "description": "An Inbound IP Set with this name already exists.",
            "content": {
              "application/problem+json": {
                "schema": {
                  "$ref": "#/components/schemas/ProblemDetail"
                },
                "examples": {
                  "duplicateName": {
                    "summary": "A set with this name already exists",
                    "value": {
                      "type": "https://errors.dns.digicert.com/conflict",
                      "title": "Conflict",
                      "status": 409,
                      "detail": "A Nameserver Set named 'upstream-prod-ns' already exists in this account."
                    }
                  }
                }
              }
            }
          },
          "415": {
            "$ref": "#/components/responses/UnsupportedMediaType"
          },
          "429": {
            "$ref": "#/components/responses/TooManyRequests"
          },
          "500": {
            "$ref": "#/components/responses/InternalServerError"
          },
          "502": {
            "$ref": "#/components/responses/BadGateway"
          },
          "503": {
            "$ref": "#/components/responses/ServiceUnavailable"
          },
          "504": {
            "$ref": "#/components/responses/GatewayTimeout"
          }
        }
      }
    },
    "/dns-settings/inbound/nameserver-sets/{nameserverSetId}": {
      "parameters": [
        {
          "$ref": "#/components/parameters/NameserverSetId"
        }
      ],
      "get": {
        "operationId": "getInboundNameserverSet",
        "summary": "Get an Inbound IP Set",
        "description": "Returns an Inbound IP Set.\n",
        "tags": [
          "Inbound IP Sets"
        ],
        "x-required-permission": "account.dns_settings.inbound:read",
        "parameters": [
          {
            "$ref": "#/components/parameters/XRequestId"
          }
        ],
        "responses": {
          "200": {
            "description": "The Inbound IP Set.",
            "headers": {
              "X-Request-Id": {
                "$ref": "#/components/headers/XRequestId"
              },
              "X-RateLimit-Limit": {
                "$ref": "#/components/headers/XRateLimitLimit"
              },
              "X-RateLimit-Remaining": {
                "$ref": "#/components/headers/XRateLimitRemaining"
              },
              "X-RateLimit-Reset": {
                "$ref": "#/components/headers/XRateLimitReset"
              }
            },
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/NameserverSet"
                }
              }
            }
          },
          "401": {
            "$ref": "#/components/responses/Unauthorized"
          },
          "403": {
            "$ref": "#/components/responses/Forbidden"
          },
          "404": {
            "description": "The Inbound IP Set doesn't exist in your account.",
            "content": {
              "application/problem+json": {
                "schema": {
                  "$ref": "#/components/schemas/ProblemDetail"
                },
                "examples": {
                  "unknownId": {
                    "summary": "Unknown set ID",
                    "value": {
                      "type": "https://errors.dns.digicert.com/not-found",
                      "title": "Not Found",
                      "status": 404,
                      "detail": "No Nameserver Set with id '00000000-0000-0000-0000-000000000000' exists in this account."
                    }
                  }
                }
              }
            }
          },
          "429": {
            "$ref": "#/components/responses/TooManyRequests"
          },
          "500": {
            "$ref": "#/components/responses/InternalServerError"
          },
          "502": {
            "$ref": "#/components/responses/BadGateway"
          },
          "503": {
            "$ref": "#/components/responses/ServiceUnavailable"
          },
          "504": {
            "$ref": "#/components/responses/GatewayTimeout"
          }
        }
      },
      "patch": {
        "operationId": "updateInboundNameserverSet",
        "summary": "Update an Inbound IP Set",
        "description": "Updates an Inbound IP Set. Send only the fields to change. The API\nkeeps the fields you leave out. If you send `primaryNameservers`, the\nnew list replaces the old one.\n\nYou can rename the set, but the new name must be unique in your\naccount. Zones that use the set show the new name. You can't change\nthe set's ID.\n\n**Applying the change**\n\nThe API checks the request before it accepts it, so errors such as\n`409 Conflict` come back right away. The change is then applied to\nevery secondary zone that uses the set, so the API returns\n`202 Accepted` and a `Location` header that points to a task. The\nchange takes effect when the task's status is `SUCCEEDED`. You don't\nneed to update each zone.\n",
        "tags": [
          "Inbound IP Sets"
        ],
        "x-required-permission": "account.dns_settings.inbound:update",
        "parameters": [
          {
            "$ref": "#/components/parameters/IdempotencyKey"
          },
          {
            "$ref": "#/components/parameters/XRequestId"
          }
        ],
        "requestBody": {
          "required": true,
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/NameserverSetUpdate"
              },
              "examples": {
                "updateAll": {
                  "summary": "Update every field you can change",
                  "value": {
                    "name": "upstream-prod-ns-2",
                    "description": "Production upstream NS (post-provider migration)",
                    "primaryNameservers": [
                      "192.0.2.53",
                      "192.0.2.54",
                      "2001:db8::14"
                    ],
                    "notifyAllowedIPs": [
                      "192.0.2.53",
                      "2001:db8::53"
                    ]
                  }
                }
              }
            }
          }
        },
        "responses": {
          "202": {
            "description": "The API accepted the update. Poll the task in the `Location`\nheader. The change takes effect when the task's status is\n`SUCCEEDED`.\n",
            "headers": {
              "Location": {
                "$ref": "#/components/headers/Location"
              },
              "X-Request-Id": {
                "$ref": "#/components/headers/XRequestId"
              },
              "X-Idempotent-Replayed": {
                "$ref": "#/components/headers/XIdempotentReplayed"
              },
              "X-RateLimit-Limit": {
                "$ref": "#/components/headers/XRateLimitLimit"
              },
              "X-RateLimit-Remaining": {
                "$ref": "#/components/headers/XRateLimitRemaining"
              },
              "X-RateLimit-Reset": {
                "$ref": "#/components/headers/XRateLimitReset"
              }
            },
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/AsyncTask"
                },
                "examples": {
                  "accepted": {
                    "summary": "The update task, waiting to start",
                    "value": {
                      "id": "1f3d5b7a-9c2e-4d6f-8a1b-2c3d4e5f6a7b",
                      "status": "PENDING",
                      "type": "nameserver_set.update",
                      "submittedAt": "2026-06-09T12:00:00Z"
                    }
                  }
                }
              }
            }
          },
          "400": {
            "description": "The request body isn't valid.",
            "content": {
              "application/problem+json": {
                "schema": {
                  "$ref": "#/components/schemas/ProblemDetail"
                },
                "examples": {
                  "invalidType": {
                    "summary": "Field has the wrong type",
                    "value": {
                      "type": "https://errors.dns.digicert.com/bad-request",
                      "title": "Validation Error",
                      "status": 400,
                      "detail": "'primaryNameservers' must be an array."
                    }
                  }
                }
              }
            }
          },
          "401": {
            "$ref": "#/components/responses/Unauthorized"
          },
          "403": {
            "$ref": "#/components/responses/Forbidden"
          },
          "404": {
            "description": "The Inbound IP Set doesn't exist in your account.",
            "content": {
              "application/problem+json": {
                "schema": {
                  "$ref": "#/components/schemas/ProblemDetail"
                },
                "examples": {
                  "unknownId": {
                    "summary": "Unknown set ID",
                    "value": {
                      "type": "https://errors.dns.digicert.com/not-found",
                      "title": "Not Found",
                      "status": 404,
                      "detail": "No Nameserver Set with id '00000000-0000-0000-0000-000000000000' exists in this account."
                    }
                  }
                }
              }
            }
          },
          "409": {
            "description": "Another Inbound IP Set already has the new name.",
            "content": {
              "application/problem+json": {
                "schema": {
                  "$ref": "#/components/schemas/ProblemDetail"
                },
                "examples": {
                  "renameCollision": {
                    "summary": "New name already in use",
                    "value": {
                      "type": "https://errors.dns.digicert.com/conflict",
                      "title": "Conflict",
                      "status": 409,
                      "detail": "A Nameserver Set named 'upstream-prod-ns-2' already exists in this account."
                    }
                  }
                }
              }
            }
          },
          "415": {
            "$ref": "#/components/responses/UnsupportedMediaType"
          },
          "429": {
            "$ref": "#/components/responses/TooManyRequests"
          },
          "500": {
            "$ref": "#/components/responses/InternalServerError"
          },
          "502": {
            "$ref": "#/components/responses/BadGateway"
          },
          "503": {
            "$ref": "#/components/responses/ServiceUnavailable"
          },
          "504": {
            "$ref": "#/components/responses/GatewayTimeout"
          }
        }
      },
      "delete": {
        "operationId": "deleteInboundNameserverSet",
        "summary": "Delete an Inbound IP Set",
        "description": "Deletes an Inbound IP Set.\n\nYou can't delete a set that secondary zones still use. If its\n`zoneCount` is more than 0, the API returns `409 Conflict`.\n",
        "tags": [
          "Inbound IP Sets"
        ],
        "x-required-permission": "account.dns_settings.inbound:delete",
        "parameters": [
          {
            "$ref": "#/components/parameters/IdempotencyKeyOptional"
          },
          {
            "$ref": "#/components/parameters/XRequestId"
          }
        ],
        "responses": {
          "204": {
            "description": "The Inbound IP Set was deleted.",
            "headers": {
              "X-Request-Id": {
                "$ref": "#/components/headers/XRequestId"
              },
              "X-Idempotent-Replayed": {
                "$ref": "#/components/headers/XIdempotentReplayed"
              },
              "X-RateLimit-Limit": {
                "$ref": "#/components/headers/XRateLimitLimit"
              },
              "X-RateLimit-Remaining": {
                "$ref": "#/components/headers/XRateLimitRemaining"
              },
              "X-RateLimit-Reset": {
                "$ref": "#/components/headers/XRateLimitReset"
              }
            }
          },
          "401": {
            "$ref": "#/components/responses/Unauthorized"
          },
          "403": {
            "$ref": "#/components/responses/Forbidden"
          },
          "404": {
            "description": "The Inbound IP Set doesn't exist in your account.",
            "content": {
              "application/problem+json": {
                "schema": {
                  "$ref": "#/components/schemas/ProblemDetail"
                },
                "examples": {
                  "unknownId": {
                    "summary": "Unknown set ID",
                    "value": {
                      "type": "https://errors.dns.digicert.com/not-found",
                      "title": "Not Found",
                      "status": 404,
                      "detail": "No Nameserver Set with id '00000000-0000-0000-0000-000000000000' exists in this account."
                    }
                  }
                }
              }
            }
          },
          "409": {
            "description": "Secondary zones still use the Inbound IP Set.\n",
            "content": {
              "application/problem+json": {
                "schema": {
                  "$ref": "#/components/schemas/ProblemDetail"
                },
                "examples": {
                  "inUse": {
                    "summary": "Set used by secondary zones",
                    "value": {
                      "type": "https://errors.dns.digicert.com/conflict",
                      "title": "Conflict",
                      "status": 409,
                      "detail": "This Nameserver Set is in use by 2 SECONDARY zones and cannot be deleted."
                    }
                  }
                }
              }
            }
          },
          "429": {
            "$ref": "#/components/responses/TooManyRequests"
          },
          "500": {
            "$ref": "#/components/responses/InternalServerError"
          },
          "502": {
            "$ref": "#/components/responses/BadGateway"
          },
          "503": {
            "$ref": "#/components/responses/ServiceUnavailable"
          },
          "504": {
            "$ref": "#/components/responses/GatewayTimeout"
          }
        }
      }
    },
    "/dns-settings/outbound/nameserver-sets": {
      "get": {
        "operationId": "listOutboundNameserverSets",
        "summary": "List Outbound IP Sets",
        "description": "Returns your account's Outbound IP Sets, one page at a time. Filter\nby set name, transfer address, NOTIFY address, or the number of\nzones that use the set. Sort by name or zone count.\n",
        "tags": [
          "Outbound IP Sets"
        ],
        "x-required-permission": "account.dns_settings.outbound:read",
        "parameters": [
          {
            "$ref": "#/components/parameters/pageToken"
          },
          {
            "$ref": "#/components/parameters/pageSize"
          },
          {
            "$ref": "#/components/parameters/OutboundNsSetSortBy"
          },
          {
            "$ref": "#/components/parameters/OutboundNsSetSortOrder"
          },
          {
            "name": "name",
            "in": "query",
            "required": false,
            "schema": {
              "type": "string",
              "minLength": 3
            },
            "description": "Returns sets whose name contains this text. Case doesn't matter.\nEnter at least 3 characters.\n",
            "example": "secondary"
          },
          {
            "name": "allowTransferIp",
            "in": "query",
            "required": false,
            "schema": {
              "type": "string",
              "minLength": 3
            },
            "description": "Returns sets with an address in `transferAllowedIPs` that\ncontains this text. Enter at least 3 characters.\n",
            "example": "203.0.113"
          },
          {
            "name": "notifyIp",
            "in": "query",
            "required": false,
            "schema": {
              "type": "string",
              "minLength": 3
            },
            "description": "Returns sets with an address in `notifyDestinations` that\ncontains this text. Enter at least 3 characters.\n",
            "example": "198.51.100"
          },
          {
            "$ref": "#/components/parameters/ZoneCount"
          },
          {
            "$ref": "#/components/parameters/XRequestId"
          }
        ],
        "responses": {
          "200": {
            "description": "A page of your Outbound IP Sets.",
            "headers": {
              "X-Request-Id": {
                "$ref": "#/components/headers/XRequestId"
              },
              "X-RateLimit-Limit": {
                "$ref": "#/components/headers/XRateLimitLimit"
              },
              "X-RateLimit-Remaining": {
                "$ref": "#/components/headers/XRateLimitRemaining"
              },
              "X-RateLimit-Reset": {
                "$ref": "#/components/headers/XRateLimitReset"
              }
            },
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/OutboundNameserverSetList"
                }
              }
            }
          },
          "400": {
            "description": "A query parameter isn't valid.",
            "content": {
              "application/problem+json": {
                "schema": {
                  "$ref": "#/components/schemas/ProblemDetail"
                },
                "examples": {
                  "badPageSize": {
                    "summary": "Page size out of range",
                    "value": {
                      "type": "https://errors.dns.digicert.com/bad-request",
                      "title": "Validation Error",
                      "status": 400,
                      "detail": "'pageSize' must be between 1 and 100."
                    }
                  }
                }
              }
            }
          },
          "401": {
            "$ref": "#/components/responses/Unauthorized"
          },
          "403": {
            "$ref": "#/components/responses/Forbidden"
          },
          "429": {
            "$ref": "#/components/responses/TooManyRequests"
          },
          "500": {
            "$ref": "#/components/responses/InternalServerError"
          },
          "502": {
            "$ref": "#/components/responses/BadGateway"
          },
          "503": {
            "$ref": "#/components/responses/ServiceUnavailable"
          },
          "504": {
            "$ref": "#/components/responses/GatewayTimeout"
          }
        }
      },
      "post": {
        "operationId": "createOutboundNameserverSet",
        "summary": "Create an Outbound IP Set",
        "description": "Creates an Outbound IP Set in your account. To use it, add it to\n`primary.outboundIps` when you create or update a primary zone.\n\nSet names are unique in your account. If a set with the same name\nalready exists, the API returns `409 Conflict`.\n",
        "tags": [
          "Outbound IP Sets"
        ],
        "x-required-permission": "account.dns_settings.outbound:create",
        "parameters": [
          {
            "$ref": "#/components/parameters/IdempotencyKey"
          },
          {
            "$ref": "#/components/parameters/XRequestId"
          }
        ],
        "requestBody": {
          "required": true,
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/OutboundNameserverSetCreate"
              },
              "examples": {
                "cloudflareSecondary": {
                  "summary": "Transfer and NOTIFY addresses for a secondary provider",
                  "value": {
                    "name": "secondary-provider",
                    "description": "Secondary DNS provider",
                    "transferAllowedIPs": [
                      "203.0.113.163",
                      "203.0.113.173",
                      "2001:db8:1000:c47::/64"
                    ],
                    "notifyDestinations": [
                      "198.51.100.82",
                      "198.51.100.145"
                    ]
                  }
                },
                "transferRangeSingleNotify": {
                  "summary": "Transfer address range and one NOTIFY address",
                  "value": {
                    "name": "partner-axfr",
                    "transferAllowedIPs": [
                      "203.0.113.1-203.0.113.9"
                    ],
                    "notifyDestinations": [
                      "198.51.100.82"
                    ]
                  }
                }
              }
            }
          }
        },
        "responses": {
          "201": {
            "description": "The Outbound IP Set was created.",
            "headers": {
              "Location": {
                "$ref": "#/components/headers/Location"
              },
              "X-Request-Id": {
                "$ref": "#/components/headers/XRequestId"
              },
              "X-Idempotent-Replayed": {
                "$ref": "#/components/headers/XIdempotentReplayed"
              },
              "X-RateLimit-Limit": {
                "$ref": "#/components/headers/XRateLimitLimit"
              },
              "X-RateLimit-Remaining": {
                "$ref": "#/components/headers/XRateLimitRemaining"
              },
              "X-RateLimit-Reset": {
                "$ref": "#/components/headers/XRateLimitReset"
              }
            },
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/OutboundNameserverSet"
                }
              }
            }
          },
          "400": {
            "description": "The request body isn't valid.",
            "content": {
              "application/problem+json": {
                "schema": {
                  "$ref": "#/components/schemas/ProblemDetail"
                },
                "examples": {
                  "missingName": {
                    "summary": "Required field missing",
                    "value": {
                      "type": "https://errors.dns.digicert.com/bad-request",
                      "title": "Validation Error",
                      "status": 400,
                      "detail": "The 'name' field mustn't be empty."
                    }
                  },
                  "missingTransferAllowedIPs": {
                    "summary": "No transfer addresses",
                    "value": {
                      "type": "https://errors.dns.digicert.com/bad-request",
                      "title": "Validation Error",
                      "status": 400,
                      "detail": "'transferAllowedIPs' must contain at least one entry."
                    }
                  },
                  "missingNotifyDestinations": {
                    "summary": "No NOTIFY addresses",
                    "value": {
                      "type": "https://errors.dns.digicert.com/bad-request",
                      "title": "Validation Error",
                      "status": 400,
                      "detail": "'notifyDestinations' must contain at least one entry."
                    }
                  }
                }
              }
            }
          },
          "401": {
            "$ref": "#/components/responses/Unauthorized"
          },
          "403": {
            "$ref": "#/components/responses/Forbidden"
          },
          "409": {
            "description": "An Outbound IP Set with this name already exists.",
            "content": {
              "application/problem+json": {
                "schema": {
                  "$ref": "#/components/schemas/ProblemDetail"
                },
                "examples": {
                  "duplicateName": {
                    "summary": "A set with this name already exists",
                    "value": {
                      "type": "https://errors.dns.digicert.com/conflict",
                      "title": "Conflict",
                      "status": 409,
                      "detail": "An Outbound IP Set named 'secondary-provider' already exists in this account."
                    }
                  }
                }
              }
            }
          },
          "415": {
            "$ref": "#/components/responses/UnsupportedMediaType"
          },
          "429": {
            "$ref": "#/components/responses/TooManyRequests"
          },
          "500": {
            "$ref": "#/components/responses/InternalServerError"
          },
          "502": {
            "$ref": "#/components/responses/BadGateway"
          },
          "503": {
            "$ref": "#/components/responses/ServiceUnavailable"
          },
          "504": {
            "$ref": "#/components/responses/GatewayTimeout"
          }
        }
      }
    },
    "/dns-settings/outbound/nameserver-sets/{nameserverSetId}": {
      "parameters": [
        {
          "$ref": "#/components/parameters/OutboundNameserverSetId"
        }
      ],
      "get": {
        "operationId": "getOutboundNameserverSet",
        "summary": "Get an Outbound IP Set",
        "description": "Returns an Outbound IP Set.\n",
        "tags": [
          "Outbound IP Sets"
        ],
        "x-required-permission": "account.dns_settings.outbound:read",
        "parameters": [
          {
            "$ref": "#/components/parameters/XRequestId"
          }
        ],
        "responses": {
          "200": {
            "description": "The Outbound IP Set.",
            "headers": {
              "X-Request-Id": {
                "$ref": "#/components/headers/XRequestId"
              },
              "X-RateLimit-Limit": {
                "$ref": "#/components/headers/XRateLimitLimit"
              },
              "X-RateLimit-Remaining": {
                "$ref": "#/components/headers/XRateLimitRemaining"
              },
              "X-RateLimit-Reset": {
                "$ref": "#/components/headers/XRateLimitReset"
              }
            },
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/OutboundNameserverSet"
                }
              }
            }
          },
          "401": {
            "$ref": "#/components/responses/Unauthorized"
          },
          "403": {
            "$ref": "#/components/responses/Forbidden"
          },
          "404": {
            "description": "The Outbound IP Set doesn't exist in your account.",
            "content": {
              "application/problem+json": {
                "schema": {
                  "$ref": "#/components/schemas/ProblemDetail"
                },
                "examples": {
                  "unknownId": {
                    "summary": "Unknown set ID",
                    "value": {
                      "type": "https://errors.dns.digicert.com/not-found",
                      "title": "Not Found",
                      "status": 404,
                      "detail": "No Outbound IP Set with id '00000000-0000-0000-0000-000000000000' exists in this account."
                    }
                  }
                }
              }
            }
          },
          "429": {
            "$ref": "#/components/responses/TooManyRequests"
          },
          "500": {
            "$ref": "#/components/responses/InternalServerError"
          },
          "502": {
            "$ref": "#/components/responses/BadGateway"
          },
          "503": {
            "$ref": "#/components/responses/ServiceUnavailable"
          },
          "504": {
            "$ref": "#/components/responses/GatewayTimeout"
          }
        }
      },
      "patch": {
        "operationId": "updateOutboundNameserverSet",
        "summary": "Update an Outbound IP Set",
        "description": "Updates an Outbound IP Set. Send only the fields to change. The API\nkeeps the fields you leave out. If you send `transferAllowedIPs` or\n`notifyDestinations`, the new list replaces the old one. Each list\nneeds at least one entry, so you can't empty `notifyDestinations`.\nTo stop sending NOTIFY messages for a zone, remove the set from the\nzone's `primary.outboundIps`. You can't change the set's ID.\n\n**Applying the change**\n\nThe API checks the request before it accepts it, so errors such as\n`409 Conflict` come back right away. The change is then applied to\nevery primary zone that uses the set, so the API returns\n`202 Accepted` and a `Location` header that points to a task. The\nchange takes effect when the task's status is `SUCCEEDED`.\n",
        "tags": [
          "Outbound IP Sets"
        ],
        "x-required-permission": "account.dns_settings.outbound:update",
        "parameters": [
          {
            "$ref": "#/components/parameters/IdempotencyKey"
          },
          {
            "$ref": "#/components/parameters/XRequestId"
          }
        ],
        "requestBody": {
          "required": true,
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/OutboundNameserverSetUpdate"
              },
              "examples": {
                "updateAll": {
                  "summary": "Update every field you can change",
                  "value": {
                    "name": "secondary-provider",
                    "description": "Updated outbound transfer config",
                    "transferAllowedIPs": [
                      "203.0.113.163",
                      "203.0.113.173",
                      "2001:db8:1000:c47::/64"
                    ],
                    "notifyDestinations": [
                      "198.51.100.82",
                      "198.51.100.145"
                    ]
                  }
                },
                "updateNotifyOnly": {
                  "summary": "Replace only the NOTIFY addresses",
                  "value": {
                    "notifyDestinations": [
                      "198.51.100.82"
                    ]
                  }
                }
              }
            }
          }
        },
        "responses": {
          "202": {
            "description": "The API accepted the update. Poll the task in the `Location`\nheader. The change takes effect when the task's status is\n`SUCCEEDED`.\n",
            "headers": {
              "Location": {
                "$ref": "#/components/headers/Location"
              },
              "X-Request-Id": {
                "$ref": "#/components/headers/XRequestId"
              },
              "X-Idempotent-Replayed": {
                "$ref": "#/components/headers/XIdempotentReplayed"
              },
              "X-RateLimit-Limit": {
                "$ref": "#/components/headers/XRateLimitLimit"
              },
              "X-RateLimit-Remaining": {
                "$ref": "#/components/headers/XRateLimitRemaining"
              },
              "X-RateLimit-Reset": {
                "$ref": "#/components/headers/XRateLimitReset"
              }
            },
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/AsyncTask"
                },
                "examples": {
                  "accepted": {
                    "summary": "The update task, waiting to start",
                    "value": {
                      "id": "2a4c6e8f-1b3d-5e7a-9c0b-1d2e3f4a5b6c",
                      "status": "PENDING",
                      "type": "outbound_nameserver_set.update",
                      "submittedAt": "2026-06-09T12:00:00Z"
                    }
                  }
                }
              }
            }
          },
          "400": {
            "description": "The request body isn't valid.",
            "content": {
              "application/problem+json": {
                "schema": {
                  "$ref": "#/components/schemas/ProblemDetail"
                },
                "examples": {
                  "invalidType": {
                    "summary": "Field has the wrong type",
                    "value": {
                      "type": "https://errors.dns.digicert.com/bad-request",
                      "title": "Validation Error",
                      "status": 400,
                      "detail": "'transferAllowedIPs' must be an array."
                    }
                  },
                  "emptyNotifyDestinations": {
                    "summary": "Empty list of NOTIFY addresses",
                    "value": {
                      "type": "https://errors.dns.digicert.com/bad-request",
                      "title": "Validation Error",
                      "status": 400,
                      "detail": "'notifyDestinations' must contain at least one entry."
                    }
                  }
                }
              }
            }
          },
          "401": {
            "$ref": "#/components/responses/Unauthorized"
          },
          "403": {
            "$ref": "#/components/responses/Forbidden"
          },
          "404": {
            "description": "The Outbound IP Set doesn't exist in your account.",
            "content": {
              "application/problem+json": {
                "schema": {
                  "$ref": "#/components/schemas/ProblemDetail"
                },
                "examples": {
                  "unknownId": {
                    "summary": "Unknown set ID",
                    "value": {
                      "type": "https://errors.dns.digicert.com/not-found",
                      "title": "Not Found",
                      "status": 404,
                      "detail": "No Outbound IP Set with id '00000000-0000-0000-0000-000000000000' exists in this account."
                    }
                  }
                }
              }
            }
          },
          "409": {
            "description": "Another Outbound IP Set already has the new name.",
            "content": {
              "application/problem+json": {
                "schema": {
                  "$ref": "#/components/schemas/ProblemDetail"
                },
                "examples": {
                  "renameCollision": {
                    "summary": "New name already in use",
                    "value": {
                      "type": "https://errors.dns.digicert.com/conflict",
                      "title": "Conflict",
                      "status": 409,
                      "detail": "An Outbound IP Set named 'secondary-provider' already exists in this account."
                    }
                  }
                }
              }
            }
          },
          "415": {
            "$ref": "#/components/responses/UnsupportedMediaType"
          },
          "429": {
            "$ref": "#/components/responses/TooManyRequests"
          },
          "500": {
            "$ref": "#/components/responses/InternalServerError"
          },
          "502": {
            "$ref": "#/components/responses/BadGateway"
          },
          "503": {
            "$ref": "#/components/responses/ServiceUnavailable"
          },
          "504": {
            "$ref": "#/components/responses/GatewayTimeout"
          }
        }
      },
      "delete": {
        "operationId": "deleteOutboundNameserverSet",
        "summary": "Delete an Outbound IP Set",
        "description": "Deletes an Outbound IP Set.\n\nYou can't delete a set that primary zones still use. If its\n`zoneCount` is more than 0, the API returns `409 Conflict`. Remove\nthe set from those zones' `primary.outboundIps` first.\n",
        "tags": [
          "Outbound IP Sets"
        ],
        "x-required-permission": "account.dns_settings.outbound:delete",
        "parameters": [
          {
            "$ref": "#/components/parameters/IdempotencyKeyOptional"
          },
          {
            "$ref": "#/components/parameters/XRequestId"
          }
        ],
        "responses": {
          "204": {
            "description": "The Outbound IP Set was deleted.",
            "headers": {
              "X-Request-Id": {
                "$ref": "#/components/headers/XRequestId"
              },
              "X-Idempotent-Replayed": {
                "$ref": "#/components/headers/XIdempotentReplayed"
              },
              "X-RateLimit-Limit": {
                "$ref": "#/components/headers/XRateLimitLimit"
              },
              "X-RateLimit-Remaining": {
                "$ref": "#/components/headers/XRateLimitRemaining"
              },
              "X-RateLimit-Reset": {
                "$ref": "#/components/headers/XRateLimitReset"
              }
            }
          },
          "401": {
            "$ref": "#/components/responses/Unauthorized"
          },
          "403": {
            "$ref": "#/components/responses/Forbidden"
          },
          "404": {
            "description": "The Outbound IP Set doesn't exist in your account.",
            "content": {
              "application/problem+json": {
                "schema": {
                  "$ref": "#/components/schemas/ProblemDetail"
                },
                "examples": {
                  "unknownId": {
                    "summary": "Unknown set ID",
                    "value": {
                      "type": "https://errors.dns.digicert.com/not-found",
                      "title": "Not Found",
                      "status": 404,
                      "detail": "No Outbound IP Set with id '00000000-0000-0000-0000-000000000000' exists in this account."
                    }
                  }
                }
              }
            }
          },
          "409": {
            "description": "Primary zones still use the Outbound IP Set.\n",
            "content": {
              "application/problem+json": {
                "schema": {
                  "$ref": "#/components/schemas/ProblemDetail"
                },
                "examples": {
                  "inUse": {
                    "summary": "Set used by primary zones",
                    "value": {
                      "type": "https://errors.dns.digicert.com/conflict",
                      "title": "Conflict",
                      "status": 409,
                      "detail": "This Outbound IP Set is in use by 2 PRIMARY zones and cannot be deleted."
                    }
                  }
                }
              }
            }
          },
          "429": {
            "$ref": "#/components/responses/TooManyRequests"
          },
          "500": {
            "$ref": "#/components/responses/InternalServerError"
          },
          "502": {
            "$ref": "#/components/responses/BadGateway"
          },
          "503": {
            "$ref": "#/components/responses/ServiceUnavailable"
          },
          "504": {
            "$ref": "#/components/responses/GatewayTimeout"
          }
        }
      }
    },
    "/dns-settings/nameserver-sets": {
      "get": {
        "operationId": "listNameserverSets",
        "summary": "List Nameserver Sets",
        "description": "Returns your account's Nameserver Sets, one page at a time. The list\nincludes the sets you created and the sets DigiCert DNS provides.\nFilter by set name, nameserver name, or the number of zones that use\nthe set. Sort by name, zone count, or type.\n",
        "tags": [
          "Nameserver Sets"
        ],
        "x-required-permission": "account.dns_settings.nameserver_sets:read",
        "parameters": [
          {
            "$ref": "#/components/parameters/pageToken"
          },
          {
            "$ref": "#/components/parameters/pageSize"
          },
          {
            "$ref": "#/components/parameters/NsSetSortBy"
          },
          {
            "$ref": "#/components/parameters/NsSetSortOrder"
          },
          {
            "name": "name",
            "in": "query",
            "required": false,
            "schema": {
              "type": "string",
              "minLength": 3
            },
            "description": "Returns sets whose name contains this text. Case doesn't matter.\nEnter at least 3 characters.\n",
            "example": "prod-ns"
          },
          {
            "name": "nameserver",
            "in": "query",
            "required": false,
            "schema": {
              "type": "string",
              "minLength": 3
            },
            "description": "Returns sets with a nameserver whose name contains this text.\nCase doesn't matter. Enter at least 3 characters.\n",
            "example": "ns1.example.com"
          },
          {
            "$ref": "#/components/parameters/ZoneCount"
          },
          {
            "$ref": "#/components/parameters/XRequestId"
          }
        ],
        "responses": {
          "200": {
            "description": "A page of your Nameserver Sets.",
            "headers": {
              "X-Request-Id": {
                "$ref": "#/components/headers/XRequestId"
              },
              "X-RateLimit-Limit": {
                "$ref": "#/components/headers/XRateLimitLimit"
              },
              "X-RateLimit-Remaining": {
                "$ref": "#/components/headers/XRateLimitRemaining"
              },
              "X-RateLimit-Reset": {
                "$ref": "#/components/headers/XRateLimitReset"
              }
            },
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/DnsNameserverSetList"
                },
                "examples": {
                  "mixedSets": {
                    "summary": "Your own set and a set DigiCert DNS provides",
                    "value": {
                      "data": [
                        {
                          "id": "9f1c2d3e-4a5b-6c7d-8e9f-0a1b2c3d4e5f",
                          "name": "prod-ns",
                          "nameservers": [
                            "ns1.example.com.",
                            "ns2.example.com."
                          ],
                          "type": "USER_DEFINED",
                          "isDefault": true,
                          "zoneCount": 12,
                          "createdAt": "2026-01-15T09:30:00Z",
                          "updatedAt": "2026-06-20T14:05:00Z"
                        },
                        {
                          "id": "11112222-3333-4444-5555-666677778888",
                          "name": "platform-default",
                          "nameservers": [
                            "ns1.dns.digicert.com.",
                            "ns2.dns.digicert.com."
                          ],
                          "type": "SYSTEM",
                          "isDefault": false,
                          "zoneCount": 512,
                          "createdAt": "2025-11-01T00:00:00Z",
                          "updatedAt": "2025-11-01T00:00:00Z"
                        }
                      ],
                      "pagination": {
                        "nextPageToken": null,
                        "prevPageToken": null,
                        "firstPageToken": null,
                        "lastPageToken": null,
                        "hasMore": false
                      }
                    }
                  }
                }
              }
            }
          },
          "400": {
            "description": "A query parameter isn't valid.",
            "content": {
              "application/problem+json": {
                "schema": {
                  "$ref": "#/components/schemas/ProblemDetail"
                },
                "examples": {
                  "badPageSize": {
                    "summary": "Page size out of range",
                    "value": {
                      "type": "https://errors.dns.digicert.com/bad-request",
                      "title": "Validation Error",
                      "status": 400,
                      "detail": "'pageSize' must be between 1 and 100."
                    }
                  }
                }
              }
            }
          },
          "401": {
            "$ref": "#/components/responses/Unauthorized"
          },
          "403": {
            "$ref": "#/components/responses/Forbidden"
          },
          "429": {
            "$ref": "#/components/responses/TooManyRequests"
          },
          "500": {
            "$ref": "#/components/responses/InternalServerError"
          },
          "502": {
            "$ref": "#/components/responses/BadGateway"
          },
          "503": {
            "$ref": "#/components/responses/ServiceUnavailable"
          },
          "504": {
            "$ref": "#/components/responses/GatewayTimeout"
          }
        }
      },
      "post": {
        "operationId": "createNameserverSet",
        "summary": "Create a Nameserver Set",
        "description": "Creates a Nameserver Set in your account. To use it, set\n`primary.nameserverSetName` to its name when you create a primary\nzone. If you set `isDefault` to `true`, the new set becomes your\naccount's default, and the previous default stops being the default.\n\nSet names are unique in your account. If a set with the same name\nalready exists, the API returns `409 Conflict`.\n",
        "tags": [
          "Nameserver Sets"
        ],
        "x-required-permission": "account.dns_settings.nameserver_sets:create",
        "parameters": [
          {
            "$ref": "#/components/parameters/IdempotencyKey"
          },
          {
            "$ref": "#/components/parameters/XRequestId"
          }
        ],
        "requestBody": {
          "required": true,
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/DnsNameserverSetCreate"
              },
              "examples": {
                "multipleNameservers": {
                  "summary": "Default set with three nameservers",
                  "value": {
                    "name": "prod-ns",
                    "nameservers": [
                      "ns1.example.com.",
                      "ns2.example.com.",
                      "ns3.example.com."
                    ],
                    "isDefault": true
                  }
                },
                "singleNameserver": {
                  "summary": "Set with two nameservers",
                  "value": {
                    "name": "internal-lab-ns",
                    "nameservers": [
                      "ns1.example.org.",
                      "ns2.example.org."
                    ]
                  }
                }
              }
            }
          }
        },
        "responses": {
          "201": {
            "description": "The Nameserver Set was created.",
            "headers": {
              "Location": {
                "$ref": "#/components/headers/Location"
              },
              "X-Request-Id": {
                "$ref": "#/components/headers/XRequestId"
              },
              "X-Idempotent-Replayed": {
                "$ref": "#/components/headers/XIdempotentReplayed"
              },
              "X-RateLimit-Limit": {
                "$ref": "#/components/headers/XRateLimitLimit"
              },
              "X-RateLimit-Remaining": {
                "$ref": "#/components/headers/XRateLimitRemaining"
              },
              "X-RateLimit-Reset": {
                "$ref": "#/components/headers/XRateLimitReset"
              }
            },
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/DnsNameserverSet"
                }
              }
            }
          },
          "400": {
            "description": "The request body isn't valid.",
            "content": {
              "application/problem+json": {
                "schema": {
                  "$ref": "#/components/schemas/ProblemDetail"
                },
                "examples": {
                  "missingName": {
                    "summary": "Required field missing",
                    "value": {
                      "type": "https://errors.dns.digicert.com/bad-request",
                      "title": "Validation Error",
                      "status": 400,
                      "detail": "The 'name' field mustn't be empty."
                    }
                  }
                }
              }
            }
          },
          "401": {
            "$ref": "#/components/responses/Unauthorized"
          },
          "403": {
            "$ref": "#/components/responses/Forbidden"
          },
          "409": {
            "description": "A Nameserver Set with this name already exists.",
            "content": {
              "application/problem+json": {
                "schema": {
                  "$ref": "#/components/schemas/ProblemDetail"
                },
                "examples": {
                  "duplicateName": {
                    "summary": "A set with this name already exists",
                    "value": {
                      "type": "https://errors.dns.digicert.com/conflict",
                      "title": "Conflict",
                      "status": 409,
                      "detail": "A Nameserver Set named 'prod-ns' already exists in this account."
                    }
                  }
                }
              }
            }
          },
          "415": {
            "$ref": "#/components/responses/UnsupportedMediaType"
          },
          "429": {
            "$ref": "#/components/responses/TooManyRequests"
          },
          "500": {
            "$ref": "#/components/responses/InternalServerError"
          },
          "502": {
            "$ref": "#/components/responses/BadGateway"
          },
          "503": {
            "$ref": "#/components/responses/ServiceUnavailable"
          },
          "504": {
            "$ref": "#/components/responses/GatewayTimeout"
          }
        }
      }
    },
    "/dns-settings/nameserver-sets/{nameserverSetId}": {
      "parameters": [
        {
          "$ref": "#/components/parameters/NameserverSetId"
        }
      ],
      "get": {
        "operationId": "getNameserverSet",
        "summary": "Get a Nameserver Set",
        "description": "Returns a Nameserver Set.\n",
        "tags": [
          "Nameserver Sets"
        ],
        "x-required-permission": "account.dns_settings.nameserver_sets:read",
        "parameters": [
          {
            "$ref": "#/components/parameters/XRequestId"
          }
        ],
        "responses": {
          "200": {
            "description": "The Nameserver Set.",
            "headers": {
              "X-Request-Id": {
                "$ref": "#/components/headers/XRequestId"
              },
              "X-RateLimit-Limit": {
                "$ref": "#/components/headers/XRateLimitLimit"
              },
              "X-RateLimit-Remaining": {
                "$ref": "#/components/headers/XRateLimitRemaining"
              },
              "X-RateLimit-Reset": {
                "$ref": "#/components/headers/XRateLimitReset"
              }
            },
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/DnsNameserverSet"
                },
                "examples": {
                  "userDefinedSet": {
                    "summary": "A set you created",
                    "value": {
                      "id": "9f1c2d3e-4a5b-6c7d-8e9f-0a1b2c3d4e5f",
                      "name": "prod-ns",
                      "nameservers": [
                        "ns1.example.com.",
                        "ns2.example.com."
                      ],
                      "type": "USER_DEFINED",
                      "isDefault": true,
                      "zoneCount": 12,
                      "createdAt": "2026-01-15T09:30:00Z",
                      "updatedAt": "2026-06-20T14:05:00Z"
                    }
                  },
                  "systemSet": {
                    "summary": "A set DigiCert DNS provides",
                    "value": {
                      "id": "11112222-3333-4444-5555-666677778888",
                      "name": "platform-default",
                      "nameservers": [
                        "ns1.dns.digicert.com.",
                        "ns2.dns.digicert.com."
                      ],
                      "type": "SYSTEM",
                      "isDefault": false,
                      "zoneCount": 512,
                      "createdAt": "2025-11-01T00:00:00Z",
                      "updatedAt": "2025-11-01T00:00:00Z"
                    }
                  }
                }
              }
            }
          },
          "401": {
            "$ref": "#/components/responses/Unauthorized"
          },
          "403": {
            "$ref": "#/components/responses/Forbidden"
          },
          "404": {
            "description": "The Nameserver Set doesn't exist in your account.",
            "content": {
              "application/problem+json": {
                "schema": {
                  "$ref": "#/components/schemas/ProblemDetail"
                },
                "examples": {
                  "unknownId": {
                    "summary": "Unknown set ID",
                    "value": {
                      "type": "https://errors.dns.digicert.com/not-found",
                      "title": "Not Found",
                      "status": 404,
                      "detail": "No Nameserver Set with id '00000000-0000-0000-0000-000000000000' exists in this account."
                    }
                  }
                }
              }
            }
          },
          "429": {
            "$ref": "#/components/responses/TooManyRequests"
          },
          "500": {
            "$ref": "#/components/responses/InternalServerError"
          },
          "502": {
            "$ref": "#/components/responses/BadGateway"
          },
          "503": {
            "$ref": "#/components/responses/ServiceUnavailable"
          },
          "504": {
            "$ref": "#/components/responses/GatewayTimeout"
          }
        }
      },
      "patch": {
        "operationId": "updateNameserverSet",
        "summary": "Update a Nameserver Set",
        "description": "Updates a Nameserver Set. Send only the fields to change. The API\nkeeps the fields you leave out. If you send `nameservers`, the new\nlist replaces the old one. You can rename the set, but the new name\nmust be unique in your account. You can't change the set's ID or\ntype.\n\nTo make the set your account's default, set `isDefault` to `true`.\nZones that use another set keep using it.\n\n**Applying the change**\n\nThe API checks the request before it accepts it, so errors such as\n`409 Conflict` come back right away. The response is always\n`202 Accepted` with a task in the body.\n\n- When the change has to reach zones that use the set, the\n  `Location` header points to the task. The change takes effect when\n  the task's status is `SUCCEEDED`.\n- When no zone needs the change, it takes effect right away. The\n  task's status is already `SUCCEEDED`, and the response has no\n  `Location` header.\n",
        "tags": [
          "Nameserver Sets"
        ],
        "x-required-permission": "account.dns_settings.nameserver_sets:update",
        "parameters": [
          {
            "$ref": "#/components/parameters/IdempotencyKey"
          },
          {
            "$ref": "#/components/parameters/XRequestId"
          }
        ],
        "requestBody": {
          "required": true,
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/DnsNameserverSetUpdate"
              },
              "examples": {
                "updateAll": {
                  "summary": "Update every field you can change",
                  "value": {
                    "name": "prod-ns-updated",
                    "description": "Updated nameserver set for ecomm domains",
                    "nameservers": [
                      "ns1.example.net.",
                      "ns2.example.net.",
                      "ns3.example.net."
                    ],
                    "isDefault": true
                  }
                }
              }
            }
          }
        },
        "responses": {
          "202": {
            "description": "The API accepted the update. If there's a `Location` header, poll\nthe task it points to. The change takes effect when the task's\nstatus is `SUCCEEDED`.\n",
            "headers": {
              "Location": {
                "$ref": "#/components/headers/Location"
              },
              "X-Request-Id": {
                "$ref": "#/components/headers/XRequestId"
              },
              "X-Idempotent-Replayed": {
                "$ref": "#/components/headers/XIdempotentReplayed"
              },
              "X-RateLimit-Limit": {
                "$ref": "#/components/headers/XRateLimitLimit"
              },
              "X-RateLimit-Remaining": {
                "$ref": "#/components/headers/XRateLimitRemaining"
              },
              "X-RateLimit-Reset": {
                "$ref": "#/components/headers/XRateLimitReset"
              }
            },
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/AsyncTask"
                },
                "examples": {
                  "accepted": {
                    "summary": "The update task, waiting to start",
                    "value": {
                      "id": "1f3d5b7a-9c2e-4d6f-8a1b-2c3d4e5f6a7b",
                      "status": "PENDING",
                      "type": "nameserver_set.update",
                      "submittedAt": "2026-06-09T12:00:00Z"
                    }
                  }
                }
              }
            }
          },
          "400": {
            "description": "The request body isn't valid.",
            "content": {
              "application/problem+json": {
                "schema": {
                  "$ref": "#/components/schemas/ProblemDetail"
                },
                "examples": {
                  "emptyNameservers": {
                    "summary": "Empty list of nameservers",
                    "value": {
                      "type": "https://errors.dns.digicert.com/bad-request",
                      "title": "Validation Error",
                      "status": 400,
                      "detail": "'nameservers' must contain at least one entry."
                    }
                  }
                }
              }
            }
          },
          "401": {
            "$ref": "#/components/responses/Unauthorized"
          },
          "403": {
            "$ref": "#/components/responses/Forbidden"
          },
          "404": {
            "description": "The Nameserver Set doesn't exist in your account.",
            "content": {
              "application/problem+json": {
                "schema": {
                  "$ref": "#/components/schemas/ProblemDetail"
                },
                "examples": {
                  "unknownId": {
                    "summary": "Unknown set ID",
                    "value": {
                      "type": "https://errors.dns.digicert.com/not-found",
                      "title": "Not Found",
                      "status": 404,
                      "detail": "No Nameserver Set with id '00000000-0000-0000-0000-000000000000' exists in this account."
                    }
                  }
                }
              }
            }
          },
          "409": {
            "description": "Another Nameserver Set already has the new name.",
            "content": {
              "application/problem+json": {
                "schema": {
                  "$ref": "#/components/schemas/ProblemDetail"
                },
                "examples": {
                  "renameCollision": {
                    "summary": "New name already in use",
                    "value": {
                      "type": "https://errors.dns.digicert.com/conflict",
                      "title": "Conflict",
                      "status": 409,
                      "detail": "A Nameserver Set named 'prod-ns-2' already exists in this account."
                    }
                  }
                }
              }
            }
          },
          "415": {
            "$ref": "#/components/responses/UnsupportedMediaType"
          },
          "429": {
            "$ref": "#/components/responses/TooManyRequests"
          },
          "500": {
            "$ref": "#/components/responses/InternalServerError"
          },
          "502": {
            "$ref": "#/components/responses/BadGateway"
          },
          "503": {
            "$ref": "#/components/responses/ServiceUnavailable"
          },
          "504": {
            "$ref": "#/components/responses/GatewayTimeout"
          }
        }
      },
      "delete": {
        "operationId": "deleteNameserverSet",
        "summary": "Delete a Nameserver Set",
        "description": "Deletes a Nameserver Set.\n\nYou can't delete a set that zones still use. If you try, the API\nreturns `409 Conflict`.\n",
        "tags": [
          "Nameserver Sets"
        ],
        "x-required-permission": "account.dns_settings.nameserver_sets:delete",
        "parameters": [
          {
            "$ref": "#/components/parameters/IdempotencyKeyOptional"
          },
          {
            "$ref": "#/components/parameters/XRequestId"
          }
        ],
        "responses": {
          "204": {
            "description": "The Nameserver Set was deleted.",
            "headers": {
              "X-Request-Id": {
                "$ref": "#/components/headers/XRequestId"
              },
              "X-Idempotent-Replayed": {
                "$ref": "#/components/headers/XIdempotentReplayed"
              },
              "X-RateLimit-Limit": {
                "$ref": "#/components/headers/XRateLimitLimit"
              },
              "X-RateLimit-Remaining": {
                "$ref": "#/components/headers/XRateLimitRemaining"
              },
              "X-RateLimit-Reset": {
                "$ref": "#/components/headers/XRateLimitReset"
              }
            }
          },
          "401": {
            "$ref": "#/components/responses/Unauthorized"
          },
          "403": {
            "$ref": "#/components/responses/Forbidden"
          },
          "404": {
            "description": "The Nameserver Set doesn't exist in your account.",
            "content": {
              "application/problem+json": {
                "schema": {
                  "$ref": "#/components/schemas/ProblemDetail"
                },
                "examples": {
                  "unknownId": {
                    "summary": "Unknown set ID",
                    "value": {
                      "type": "https://errors.dns.digicert.com/not-found",
                      "title": "Not Found",
                      "status": 404,
                      "detail": "No Nameserver Set with id '00000000-0000-0000-0000-000000000000' exists in this account."
                    }
                  }
                }
              }
            }
          },
          "409": {
            "description": "Zones still use the Nameserver Set.\n",
            "content": {
              "application/problem+json": {
                "schema": {
                  "$ref": "#/components/schemas/ProblemDetail"
                },
                "examples": {
                  "inUse": {
                    "summary": "Set still in use",
                    "value": {
                      "type": "https://errors.dns.digicert.com/conflict",
                      "title": "Conflict",
                      "status": 409,
                      "detail": "This Nameserver Set is in use and cannot be deleted."
                    }
                  }
                }
              }
            }
          },
          "429": {
            "$ref": "#/components/responses/TooManyRequests"
          },
          "500": {
            "$ref": "#/components/responses/InternalServerError"
          },
          "502": {
            "$ref": "#/components/responses/BadGateway"
          },
          "503": {
            "$ref": "#/components/responses/ServiceUnavailable"
          },
          "504": {
            "$ref": "#/components/responses/GatewayTimeout"
          }
        }
      }
    },
    "/dns-settings/tsig-keys": {
      "get": {
        "operationId": "listTsigKeys",
        "summary": "List TSIG keys",
        "description": "Returns your account's TSIG keys, one page at a time. Filter by key\nname. The `zoneCount` filters aren't applied to TSIG keys yet. Sort by\nname or zone count. The API never returns a key's secret. Each key shows a masked\n`secretPreview` instead.\n",
        "tags": [
          "TSIG Keys"
        ],
        "x-required-permission": "account.dns_settings.tsigs:read",
        "parameters": [
          {
            "$ref": "#/components/parameters/pageToken"
          },
          {
            "$ref": "#/components/parameters/pageSize"
          },
          {
            "$ref": "#/components/parameters/TsigKeySortBy"
          },
          {
            "$ref": "#/components/parameters/TsigKeySortOrder"
          },
          {
            "name": "name",
            "in": "query",
            "required": false,
            "schema": {
              "type": "string"
            },
            "description": "Returns keys whose name contains this text. Case doesn't matter.\n",
            "example": "primary-key"
          },
          {
            "$ref": "#/components/parameters/ZoneCount"
          },
          {
            "$ref": "#/components/parameters/XRequestId"
          }
        ],
        "responses": {
          "200": {
            "description": "A page of your TSIG keys.",
            "headers": {
              "X-Request-Id": {
                "$ref": "#/components/headers/XRequestId"
              },
              "X-RateLimit-Limit": {
                "$ref": "#/components/headers/XRateLimitLimit"
              },
              "X-RateLimit-Remaining": {
                "$ref": "#/components/headers/XRateLimitRemaining"
              },
              "X-RateLimit-Reset": {
                "$ref": "#/components/headers/XRateLimitReset"
              }
            },
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/TsigKeyList"
                }
              }
            }
          },
          "400": {
            "description": "A query parameter isn't valid.",
            "content": {
              "application/problem+json": {
                "schema": {
                  "$ref": "#/components/schemas/ProblemDetail"
                },
                "examples": {
                  "badPageSize": {
                    "summary": "Page size out of range",
                    "value": {
                      "type": "https://errors.dns.digicert.com/bad-request",
                      "title": "Validation Error",
                      "status": 400,
                      "detail": "'pageSize' must be between 1 and 100."
                    }
                  }
                }
              }
            }
          },
          "401": {
            "$ref": "#/components/responses/Unauthorized"
          },
          "403": {
            "$ref": "#/components/responses/Forbidden"
          },
          "429": {
            "$ref": "#/components/responses/TooManyRequests"
          },
          "500": {
            "$ref": "#/components/responses/InternalServerError"
          },
          "502": {
            "$ref": "#/components/responses/BadGateway"
          },
          "503": {
            "$ref": "#/components/responses/ServiceUnavailable"
          },
          "504": {
            "$ref": "#/components/responses/GatewayTimeout"
          }
        }
      },
      "post": {
        "operationId": "createTsigKey",
        "summary": "Create a TSIG key",
        "description": "Creates a TSIG key in your account. Keep a copy of the secret you\nsend. The API never returns it, in this response or later.\n\nKey names are unique in your account. If a key with the same name\nalready exists, the API returns `409 Conflict`.\n",
        "tags": [
          "TSIG Keys"
        ],
        "x-required-permission": "account.dns_settings.tsigs:create",
        "parameters": [
          {
            "$ref": "#/components/parameters/IdempotencyKey"
          },
          {
            "$ref": "#/components/parameters/XRequestId"
          }
        ],
        "requestBody": {
          "required": true,
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/TsigKeyCreate"
              },
              "examples": {
                "sha256": {
                  "summary": "Key that uses the default hmac-sha256 algorithm",
                  "value": {
                    "name": "upstream-transfer-key",
                    "description": "Auth for AXFR/IXFR from provider X",
                    "secret": "<base64-encoded-hmac-secret>",
                    "algorithm": "hmac-sha256"
                  }
                }
              }
            }
          }
        },
        "responses": {
          "201": {
            "description": "The TSIG key was created. The response doesn't include its secret.\nThe `Location` header isn't currently returned.\n",
            "headers": {
              "Location": {
                "$ref": "#/components/headers/Location"
              },
              "X-Request-Id": {
                "$ref": "#/components/headers/XRequestId"
              },
              "X-Idempotent-Replayed": {
                "$ref": "#/components/headers/XIdempotentReplayed"
              },
              "X-RateLimit-Limit": {
                "$ref": "#/components/headers/XRateLimitLimit"
              },
              "X-RateLimit-Remaining": {
                "$ref": "#/components/headers/XRateLimitRemaining"
              },
              "X-RateLimit-Reset": {
                "$ref": "#/components/headers/XRateLimitReset"
              }
            },
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/TsigKeyResource"
                }
              }
            }
          },
          "400": {
            "description": "The request body isn't valid.",
            "content": {
              "application/problem+json": {
                "schema": {
                  "$ref": "#/components/schemas/ProblemDetail"
                },
                "examples": {
                  "missingSecret": {
                    "summary": "Required field missing",
                    "value": {
                      "type": "https://errors.dns.digicert.com/bad-request",
                      "title": "Validation Error",
                      "status": 400,
                      "detail": "The 'secret' field is required."
                    }
                  }
                }
              }
            }
          },
          "401": {
            "$ref": "#/components/responses/Unauthorized"
          },
          "403": {
            "$ref": "#/components/responses/Forbidden"
          },
          "409": {
            "description": "A TSIG key with this name already exists.",
            "content": {
              "application/problem+json": {
                "schema": {
                  "$ref": "#/components/schemas/ProblemDetail"
                },
                "examples": {
                  "duplicateName": {
                    "summary": "A key with this name already exists",
                    "value": {
                      "type": "https://errors.dns.digicert.com/conflict",
                      "title": "Conflict",
                      "status": 409,
                      "detail": "A TSIG key named 'upstream-transfer-key' already exists in this account."
                    }
                  }
                }
              }
            }
          },
          "415": {
            "$ref": "#/components/responses/UnsupportedMediaType"
          },
          "422": {
            "description": "The API can't use a value in the request, such as an unsupported algorithm.",
            "content": {
              "application/problem+json": {
                "schema": {
                  "$ref": "#/components/schemas/ProblemDetail"
                },
                "examples": {
                  "unsupportedAlgorithm": {
                    "summary": "Unsupported algorithm",
                    "value": {
                      "type": "https://errors.dns.digicert.com/unprocessable-entity",
                      "title": "Unprocessable Entity",
                      "status": 422,
                      "detail": "Unsupported algorithm 'hmac-sha999'."
                    }
                  }
                }
              }
            }
          },
          "429": {
            "$ref": "#/components/responses/TooManyRequests"
          },
          "500": {
            "$ref": "#/components/responses/InternalServerError"
          },
          "502": {
            "$ref": "#/components/responses/BadGateway"
          },
          "503": {
            "$ref": "#/components/responses/ServiceUnavailable"
          },
          "504": {
            "$ref": "#/components/responses/GatewayTimeout"
          }
        }
      }
    },
    "/dns-settings/tsig-keys/{tsigKeyId}": {
      "parameters": [
        {
          "$ref": "#/components/parameters/TsigKeyId"
        }
      ],
      "get": {
        "operationId": "getTsigKey",
        "summary": "Get a TSIG key",
        "description": "Returns a TSIG key. The response never includes the key's secret.\nIt shows a masked `secretPreview` instead.\n",
        "tags": [
          "TSIG Keys"
        ],
        "x-required-permission": "account.dns_settings.tsigs:read",
        "parameters": [
          {
            "$ref": "#/components/parameters/XRequestId"
          }
        ],
        "responses": {
          "200": {
            "description": "The TSIG key, without its secret.",
            "headers": {
              "X-Request-Id": {
                "$ref": "#/components/headers/XRequestId"
              },
              "X-RateLimit-Limit": {
                "$ref": "#/components/headers/XRateLimitLimit"
              },
              "X-RateLimit-Remaining": {
                "$ref": "#/components/headers/XRateLimitRemaining"
              },
              "X-RateLimit-Reset": {
                "$ref": "#/components/headers/XRateLimitReset"
              }
            },
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/TsigKeyResource"
                }
              }
            }
          },
          "401": {
            "$ref": "#/components/responses/Unauthorized"
          },
          "403": {
            "$ref": "#/components/responses/Forbidden"
          },
          "404": {
            "description": "The TSIG key doesn't exist in your account.",
            "content": {
              "application/problem+json": {
                "schema": {
                  "$ref": "#/components/schemas/ProblemDetail"
                },
                "examples": {
                  "unknownId": {
                    "summary": "Unknown key ID",
                    "value": {
                      "type": "https://errors.dns.digicert.com/not-found",
                      "title": "Not Found",
                      "status": 404,
                      "detail": "No TSIG key with id '00000000-0000-0000-0000-000000000000' exists in this account."
                    }
                  }
                }
              }
            }
          },
          "429": {
            "$ref": "#/components/responses/TooManyRequests"
          },
          "500": {
            "$ref": "#/components/responses/InternalServerError"
          },
          "502": {
            "$ref": "#/components/responses/BadGateway"
          },
          "503": {
            "$ref": "#/components/responses/ServiceUnavailable"
          },
          "504": {
            "$ref": "#/components/responses/GatewayTimeout"
          }
        }
      },
      "patch": {
        "operationId": "updateTsigKey",
        "summary": "Update a TSIG key",
        "description": "Updates a TSIG key. Send only the fields to change. The API keeps\nthe fields you leave out.\n\nTo rotate the key, send a new `secret`, and a new `algorithm` if you\nwant to change it. Zones that use the key switch to the new secret at\ntheir next zone transfer, so you don't need to update them. You can\nalso rename the key, but the new name must be unique in your\naccount. You can't change the key's ID.\n\n**Applying the change**\n\nThe API checks the request before it accepts it, so errors such as\n`409 Conflict` come back right away. The change is then applied to\nevery zone that uses the key, so the API returns `202 Accepted` and\na `Location` header that points to a task. The change takes effect\nwhen the task's status is `SUCCEEDED`.\n",
        "tags": [
          "TSIG Keys"
        ],
        "x-required-permission": "account.dns_settings.tsigs:update",
        "parameters": [
          {
            "$ref": "#/components/parameters/IdempotencyKey"
          },
          {
            "$ref": "#/components/parameters/XRequestId"
          }
        ],
        "requestBody": {
          "required": true,
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/TsigKeyUpdate"
              },
              "examples": {
                "replaceSecret": {
                  "summary": "Replace the secret",
                  "value": {
                    "secret": "<new-base64-encoded-hmac-secret>"
                  }
                },
                "replaceSecretAndAlgorithm": {
                  "summary": "Replace the secret and change the algorithm",
                  "value": {
                    "secret": "<new-base64-encoded-hmac-secret>",
                    "algorithm": "hmac-sha512"
                  }
                },
                "renameKey": {
                  "summary": "Rename the key",
                  "value": {
                    "name": "upstream-transfer-key-2"
                  }
                },
                "updateDescription": {
                  "summary": "Update only the description",
                  "value": {
                    "description": "Upstream transfer key (provider X)"
                  }
                }
              }
            }
          }
        },
        "responses": {
          "202": {
            "description": "The API accepted the update. Poll the task in the `Location`\nheader. The change takes effect when the task's status is\n`SUCCEEDED`. The response doesn't include the key's secret.\n",
            "headers": {
              "Location": {
                "$ref": "#/components/headers/Location"
              },
              "X-Request-Id": {
                "$ref": "#/components/headers/XRequestId"
              },
              "X-Idempotent-Replayed": {
                "$ref": "#/components/headers/XIdempotentReplayed"
              },
              "X-RateLimit-Limit": {
                "$ref": "#/components/headers/XRateLimitLimit"
              },
              "X-RateLimit-Remaining": {
                "$ref": "#/components/headers/XRateLimitRemaining"
              },
              "X-RateLimit-Reset": {
                "$ref": "#/components/headers/XRateLimitReset"
              }
            },
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/AsyncTask"
                },
                "examples": {
                  "accepted": {
                    "summary": "The update task, waiting to start",
                    "value": {
                      "id": "2a4c6e8f-1b3d-4f5a-9c7e-0d2f4a6b8c1e",
                      "status": "PENDING",
                      "type": "tsig_key.update",
                      "submittedAt": "2026-06-09T12:05:00Z"
                    }
                  }
                }
              }
            }
          },
          "400": {
            "description": "The request body isn't valid.",
            "content": {
              "application/problem+json": {
                "schema": {
                  "$ref": "#/components/schemas/ProblemDetail"
                },
                "examples": {
                  "invalidType": {
                    "summary": "Field has the wrong type",
                    "value": {
                      "type": "https://errors.dns.digicert.com/bad-request",
                      "title": "Validation Error",
                      "status": 400,
                      "detail": "'algorithm' must be a string."
                    }
                  }
                }
              }
            }
          },
          "401": {
            "$ref": "#/components/responses/Unauthorized"
          },
          "403": {
            "$ref": "#/components/responses/Forbidden"
          },
          "404": {
            "description": "The TSIG key doesn't exist in your account.",
            "content": {
              "application/problem+json": {
                "schema": {
                  "$ref": "#/components/schemas/ProblemDetail"
                },
                "examples": {
                  "unknownId": {
                    "summary": "Unknown key ID",
                    "value": {
                      "type": "https://errors.dns.digicert.com/not-found",
                      "title": "Not Found",
                      "status": 404,
                      "detail": "No TSIG key with id '00000000-0000-0000-0000-000000000000' exists in this account."
                    }
                  }
                }
              }
            }
          },
          "409": {
            "description": "Another TSIG key already has the new name.",
            "content": {
              "application/problem+json": {
                "schema": {
                  "$ref": "#/components/schemas/ProblemDetail"
                },
                "examples": {
                  "renameCollision": {
                    "summary": "New name already in use",
                    "value": {
                      "type": "https://errors.dns.digicert.com/conflict",
                      "title": "Conflict",
                      "status": 409,
                      "detail": "A TSIG key named 'upstream-transfer-key-2' already exists in this account."
                    }
                  }
                }
              }
            }
          },
          "415": {
            "$ref": "#/components/responses/UnsupportedMediaType"
          },
          "422": {
            "description": "The API can't use a value in the request, such as an unsupported algorithm.",
            "content": {
              "application/problem+json": {
                "schema": {
                  "$ref": "#/components/schemas/ProblemDetail"
                },
                "examples": {
                  "unsupportedAlgorithm": {
                    "summary": "Unsupported algorithm",
                    "value": {
                      "type": "https://errors.dns.digicert.com/unprocessable-entity",
                      "title": "Unprocessable Entity",
                      "status": 422,
                      "detail": "Unsupported algorithm 'hmac-sha999'."
                    }
                  }
                }
              }
            }
          },
          "429": {
            "$ref": "#/components/responses/TooManyRequests"
          },
          "500": {
            "$ref": "#/components/responses/InternalServerError"
          },
          "502": {
            "$ref": "#/components/responses/BadGateway"
          },
          "503": {
            "$ref": "#/components/responses/ServiceUnavailable"
          },
          "504": {
            "$ref": "#/components/responses/GatewayTimeout"
          }
        }
      },
      "delete": {
        "operationId": "deleteTsigKey",
        "summary": "Delete a TSIG key",
        "description": "Deletes a TSIG key.\n\nYou can't delete a key that zones still use. If its `zoneCount` is\nmore than 0, the API returns `409 Conflict`.\n",
        "tags": [
          "TSIG Keys"
        ],
        "x-required-permission": "account.dns_settings.tsigs:delete",
        "parameters": [
          {
            "$ref": "#/components/parameters/IdempotencyKeyOptional"
          },
          {
            "$ref": "#/components/parameters/XRequestId"
          }
        ],
        "responses": {
          "204": {
            "description": "The TSIG key was deleted.",
            "headers": {
              "X-Request-Id": {
                "$ref": "#/components/headers/XRequestId"
              },
              "X-Idempotent-Replayed": {
                "$ref": "#/components/headers/XIdempotentReplayed"
              },
              "X-RateLimit-Limit": {
                "$ref": "#/components/headers/XRateLimitLimit"
              },
              "X-RateLimit-Remaining": {
                "$ref": "#/components/headers/XRateLimitRemaining"
              },
              "X-RateLimit-Reset": {
                "$ref": "#/components/headers/XRateLimitReset"
              }
            }
          },
          "401": {
            "$ref": "#/components/responses/Unauthorized"
          },
          "403": {
            "$ref": "#/components/responses/Forbidden"
          },
          "404": {
            "description": "The TSIG key doesn't exist in your account.",
            "content": {
              "application/problem+json": {
                "schema": {
                  "$ref": "#/components/schemas/ProblemDetail"
                },
                "examples": {
                  "unknownId": {
                    "summary": "Unknown key ID",
                    "value": {
                      "type": "https://errors.dns.digicert.com/not-found",
                      "title": "Not Found",
                      "status": 404,
                      "detail": "No TSIG key with id '00000000-0000-0000-0000-000000000000' exists in this account."
                    }
                  }
                }
              }
            }
          },
          "409": {
            "description": "Zones still use the TSIG key.\n",
            "content": {
              "application/problem+json": {
                "schema": {
                  "$ref": "#/components/schemas/ProblemDetail"
                },
                "examples": {
                  "inUse": {
                    "summary": "Key used by a zone",
                    "value": {
                      "type": "https://errors.dns.digicert.com/conflict",
                      "title": "Conflict",
                      "status": 409,
                      "detail": "This TSIG key is in use by 1 zone and cannot be deleted."
                    }
                  }
                }
              }
            }
          },
          "429": {
            "$ref": "#/components/responses/TooManyRequests"
          },
          "500": {
            "$ref": "#/components/responses/InternalServerError"
          },
          "502": {
            "$ref": "#/components/responses/BadGateway"
          },
          "503": {
            "$ref": "#/components/responses/ServiceUnavailable"
          },
          "504": {
            "$ref": "#/components/responses/GatewayTimeout"
          }
        }
      }
    },
    "/audit": {
      "get": {
        "operationId": "listAuditRecords",
        "x-required-permission": "account.reporting.audit:read",
        "summary": "List audit records",
        "description": "Returns the audit records for DNS configuration changes in your\naccount, one page at a time. By default, the newest changes come\nfirst. Set `sortOrder` to `asc` to get the oldest first.\n\n**Filters**\n\n- Filter by user, change type, object type, object name, parent\n  name, or text in the change's comment. Records must match every\n  filter you send.\n- Filter values can't contain `:`. If one does, the API returns\n  `400 Bad Request`.\n- Set the time window with either `dateRange` or both `dateFrom` and\n  `dateTo`. If you send `dateRange` with both `dateFrom` and `dateTo`,\n  the API uses `dateFrom` and `dateTo`. Without either, you get the last 24\n  hours.\n\n**Format**\n\nRecords come back as JSON by default. To get CSV, set the `Accept`\nheader to `text/csv`.\n",
        "tags": [
          "Audit"
        ],
        "parameters": [
          {
            "$ref": "#/components/parameters/AuditPageSize"
          },
          {
            "$ref": "#/components/parameters/pageToken"
          },
          {
            "$ref": "#/components/parameters/AuditUsers"
          },
          {
            "$ref": "#/components/parameters/AuditChangeType"
          },
          {
            "$ref": "#/components/parameters/AuditObjectType"
          },
          {
            "$ref": "#/components/parameters/AuditObjectName"
          },
          {
            "$ref": "#/components/parameters/AuditParentName"
          },
          {
            "$ref": "#/components/parameters/AuditDateRange"
          },
          {
            "$ref": "#/components/parameters/AuditDateFrom"
          },
          {
            "$ref": "#/components/parameters/AuditDateTo"
          },
          {
            "$ref": "#/components/parameters/AuditReason"
          },
          {
            "$ref": "#/components/parameters/AuditSortOrder"
          },
          {
            "$ref": "#/components/parameters/XRequestId"
          }
        ],
        "responses": {
          "200": {
            "description": "A page of audit records, as JSON or CSV.",
            "headers": {
              "X-Request-Id": {
                "$ref": "#/components/headers/XRequestId"
              },
              "X-RateLimit-Limit": {
                "$ref": "#/components/headers/XRateLimitLimit"
              },
              "X-RateLimit-Remaining": {
                "$ref": "#/components/headers/XRateLimitRemaining"
              },
              "X-RateLimit-Reset": {
                "$ref": "#/components/headers/XRateLimitReset"
              }
            },
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/AuditRecordList"
                },
                "examples": {
                  "newestFirst": {
                    "summary": "Newest changes first, the default",
                    "value": {
                      "data": [
                        {
                          "account": "10012345",
                          "user": "user@example.com",
                          "ipAddress": "203.0.113.10",
                          "objectType": "RRSET",
                          "changeType": "MODIFY",
                          "objectName": "www.example.com.",
                          "parentName": "example.com.",
                          "reason": "Lowered TTL for maintenance",
                          "detail": {
                            "changes": [
                              {
                                "name": "ttl",
                                "from": "3600",
                                "to": "300"
                              }
                            ]
                          },
                          "changedAt": "2026-09-09T18:00:00Z"
                        }
                      ],
                      "pagination": {
                        "hasMore": false,
                        "nextPageToken": null
                      }
                    }
                  },
                  "oldestFirst": {
                    "summary": "Oldest changes first",
                    "description": "The result of `GET /audit?sortOrder=asc`. Records are in\norder from oldest to newest by `changedAt`.\n",
                    "value": {
                      "data": [
                        {
                          "account": "10012345",
                          "user": "user@example.com",
                          "ipAddress": "203.0.113.10",
                          "objectType": "ZONE",
                          "changeType": "ADD",
                          "objectName": "example.com.",
                          "parentName": null,
                          "reason": null,
                          "detail": {
                            "others": [
                              {
                                "name": "source",
                                "value": "api"
                              }
                            ]
                          },
                          "changedAt": "2026-06-01T09:15:00Z"
                        }
                      ],
                      "pagination": {
                        "hasMore": true,
                        "nextPageToken": "eyJsYXN0Q2hhbmdlZEF0IjoiMjAyNi0wNi0wMVQwOToxNTowMFoifQ=="
                      }
                    }
                  }
                }
              },
              "text/csv": {
                "schema": {
                  "type": "string",
                  "description": "Audit records as CSV. The first row has the column names,\nand each row after it is one audit record.\n"
                }
              }
            }
          },
          "400": {
            "$ref": "#/components/responses/BadRequest"
          },
          "401": {
            "$ref": "#/components/responses/Unauthorized"
          },
          "403": {
            "$ref": "#/components/responses/Forbidden"
          },
          "429": {
            "$ref": "#/components/responses/TooManyRequests"
          },
          "500": {
            "$ref": "#/components/responses/InternalServerError"
          },
          "502": {
            "$ref": "#/components/responses/BadGateway"
          },
          "503": {
            "$ref": "#/components/responses/ServiceUnavailable"
          },
          "504": {
            "$ref": "#/components/responses/GatewayTimeout"
          }
        }
      }
    },
    "/audit/filters": {
      "get": {
        "operationId": "getAuditFilters",
        "x-required-permission": "account.reporting.audit:read",
        "summary": "Get audit filter values",
        "description": "Returns the values you can filter audit records by: the accounts,\nusers, object types, and change types that appear in your audit log\nfor a time window. Without `dateFrom` and `dateTo`, the window is the\nlast 24 hours.\n",
        "tags": [
          "Audit"
        ],
        "parameters": [
          {
            "$ref": "#/components/parameters/AuditFiltersDateFrom"
          },
          {
            "$ref": "#/components/parameters/AuditFiltersDateTo"
          },
          {
            "$ref": "#/components/parameters/XRequestId"
          }
        ],
        "responses": {
          "200": {
            "description": "The values you can filter audit records by.",
            "headers": {
              "X-Request-Id": {
                "$ref": "#/components/headers/XRequestId"
              },
              "X-RateLimit-Limit": {
                "$ref": "#/components/headers/XRateLimitLimit"
              },
              "X-RateLimit-Remaining": {
                "$ref": "#/components/headers/XRateLimitRemaining"
              },
              "X-RateLimit-Reset": {
                "$ref": "#/components/headers/XRateLimitReset"
              }
            },
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/AuditFilters"
                }
              }
            }
          },
          "400": {
            "$ref": "#/components/responses/BadRequest"
          },
          "401": {
            "$ref": "#/components/responses/Unauthorized"
          },
          "403": {
            "$ref": "#/components/responses/Forbidden"
          },
          "429": {
            "$ref": "#/components/responses/TooManyRequests"
          },
          "500": {
            "$ref": "#/components/responses/InternalServerError"
          },
          "502": {
            "$ref": "#/components/responses/BadGateway"
          },
          "503": {
            "$ref": "#/components/responses/ServiceUnavailable"
          },
          "504": {
            "$ref": "#/components/responses/GatewayTimeout"
          }
        }
      }
    },
    "/zones/{zoneName}/snapshots": {
      "parameters": [
        {
          "$ref": "#/components/parameters/ZoneName"
        }
      ],
      "post": {
        "operationId": "createZoneSnapshot",
        "x-required-permission": "account.zones:update",
        "summary": "Create a zone snapshot",
        "description": "Starts a snapshot of the zone: a point-in-time copy of the zone's\nrecord sets. You can restore the zone from the snapshot later.\nCreating a snapshot takes time, so the API returns `202 Accepted` and\na `Location` header that points to a task.\n\nYou can take a snapshot of a primary zone that isn't DNSSEC-signed or\nsuspended and has no more than 50,000 records. For any other zone, the\nAPI returns `422 Unprocessable Entity`.\n\n**Finding the snapshot ID**\n\nWhen the task's status is `SUCCEEDED`, list the zone's snapshots with\n`GET /zones/{zoneName}/snapshots` to find the new snapshot's `id`. Use\nit as `snapshotId` to get, delete, or restore the snapshot.\n",
        "tags": [
          "Snapshots"
        ],
        "parameters": [
          {
            "$ref": "#/components/parameters/IdempotencyKey"
          },
          {
            "$ref": "#/components/parameters/XRequestId"
          }
        ],
        "requestBody": {
          "required": false,
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/ZoneSnapshotCreateRequest"
              },
              "examples": {
                "withDescription": {
                  "summary": "Snapshot with a name and description",
                  "value": {
                    "name": "pre-migration",
                    "description": "Pre-migration backup"
                  }
                }
              }
            }
          }
        },
        "responses": {
          "202": {
            "description": "The snapshot has started. Check its progress with the task in the\n`Location` header.\n",
            "headers": {
              "Location": {
                "$ref": "#/components/headers/Location"
              },
              "X-Request-Id": {
                "$ref": "#/components/headers/XRequestId"
              },
              "X-Idempotent-Replayed": {
                "$ref": "#/components/headers/XIdempotentReplayed"
              },
              "X-RateLimit-Limit": {
                "$ref": "#/components/headers/XRateLimitLimit"
              },
              "X-RateLimit-Remaining": {
                "$ref": "#/components/headers/XRateLimitRemaining"
              },
              "X-RateLimit-Reset": {
                "$ref": "#/components/headers/XRateLimitReset"
              }
            },
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/AsyncTask"
                },
                "examples": {
                  "accepted": {
                    "summary": "The snapshot task, waiting to start",
                    "value": {
                      "id": "f7a38d29-1c5e-4b02-9f6a-2d8e0c473b91",
                      "status": "PENDING",
                      "type": "zone.snapshot",
                      "submittedAt": "2026-06-05T14:00:00Z"
                    }
                  }
                }
              }
            }
          },
          "400": {
            "$ref": "#/components/responses/BadRequest"
          },
          "401": {
            "$ref": "#/components/responses/Unauthorized"
          },
          "403": {
            "$ref": "#/components/responses/Forbidden"
          },
          "404": {
            "$ref": "#/components/responses/NotFound"
          },
          "409": {
            "$ref": "#/components/responses/Conflict"
          },
          "415": {
            "$ref": "#/components/responses/UnsupportedMediaType"
          },
          "422": {
            "$ref": "#/components/responses/UnprocessableEntity"
          },
          "429": {
            "$ref": "#/components/responses/TooManyRequests"
          },
          "500": {
            "$ref": "#/components/responses/InternalServerError"
          },
          "502": {
            "$ref": "#/components/responses/BadGateway"
          },
          "503": {
            "$ref": "#/components/responses/ServiceUnavailable"
          },
          "504": {
            "$ref": "#/components/responses/GatewayTimeout"
          }
        }
      },
      "get": {
        "operationId": "listZoneSnapshots",
        "x-required-permission": "account.zones:read",
        "summary": "List snapshots for a zone",
        "description": "Returns the zone's snapshots, one page at a time. Each item has the\nsnapshot's details but not its records. To see a snapshot's records,\nget the snapshot with `GET /zones/{zoneName}/snapshots/{snapshotId}`.\n\nYou can filter by part of the snapshot's name, and sort by `name` or\n`createdAt`. If you send no sort parameters, the API lists the newest snapshot first.\n",
        "tags": [
          "Snapshots"
        ],
        "parameters": [
          {
            "$ref": "#/components/parameters/pageToken"
          },
          {
            "$ref": "#/components/parameters/pageSize"
          },
          {
            "$ref": "#/components/parameters/ZoneSnapshotName"
          },
          {
            "$ref": "#/components/parameters/ZoneSnapshotSortBy"
          },
          {
            "$ref": "#/components/parameters/ZoneSnapshotSortOrder"
          },
          {
            "$ref": "#/components/parameters/XRequestId"
          }
        ],
        "responses": {
          "200": {
            "description": "A page of the zone's snapshots.",
            "headers": {
              "X-Request-Id": {
                "$ref": "#/components/headers/XRequestId"
              },
              "X-RateLimit-Limit": {
                "$ref": "#/components/headers/XRateLimitLimit"
              },
              "X-RateLimit-Remaining": {
                "$ref": "#/components/headers/XRateLimitRemaining"
              },
              "X-RateLimit-Reset": {
                "$ref": "#/components/headers/XRateLimitReset"
              }
            },
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ZoneSnapshotList"
                },
                "examples": {
                  "snapshotList": {
                    "summary": "A page of snapshots",
                    "description": "This response shows the result when you omit both sort parameters. The newest\nsnapshot comes first.\n",
                    "value": {
                      "data": [
                        {
                          "id": "c3e0a2d5-8f4b-4d9c-a032-1b6f7e8d9c40",
                          "zoneName": "example.com.",
                          "isRegionalViewEnabled": false,
                          "name": "pre-migration",
                          "description": "Pre-migration backup",
                          "createdAt": "2026-06-05T14:00:00Z"
                        },
                        {
                          "id": "7d1e6b4a-2c9f-4a11-9e3d-5f0a8c6b1e22",
                          "zoneName": "example.com.",
                          "isRegionalViewEnabled": true,
                          "description": "Nightly automated snapshot",
                          "createdAt": "2026-06-04T02:00:00Z"
                        }
                      ],
                      "pagination": {
                        "hasMore": false,
                        "nextPageToken": null
                      }
                    }
                  },
                  "sortedByName": {
                    "summary": "Snapshots sorted by name",
                    "description": "The result of `GET /zones/{zoneName}/snapshots?sortBy=name&sortOrder=asc`.\nSnapshots are in alphabetical order by `name`. A snapshot\nwithout a name sorts first.\n",
                    "value": {
                      "data": [
                        {
                          "id": "7d1e6b4a-2c9f-4a11-9e3d-5f0a8c6b1e22",
                          "zoneName": "example.com.",
                          "isRegionalViewEnabled": true,
                          "description": "Nightly automated snapshot",
                          "createdAt": "2026-06-04T02:00:00Z"
                        },
                        {
                          "id": "c3e0a2d5-8f4b-4d9c-a032-1b6f7e8d9c40",
                          "zoneName": "example.com.",
                          "isRegionalViewEnabled": false,
                          "name": "pre-migration",
                          "description": "Pre-migration backup",
                          "createdAt": "2026-06-05T14:00:00Z"
                        }
                      ],
                      "pagination": {
                        "hasMore": false,
                        "nextPageToken": null
                      }
                    }
                  }
                }
              }
            }
          },
          "400": {
            "$ref": "#/components/responses/BadRequest"
          },
          "401": {
            "$ref": "#/components/responses/Unauthorized"
          },
          "403": {
            "$ref": "#/components/responses/Forbidden"
          },
          "404": {
            "$ref": "#/components/responses/NotFound"
          },
          "429": {
            "$ref": "#/components/responses/TooManyRequests"
          },
          "500": {
            "$ref": "#/components/responses/InternalServerError"
          },
          "502": {
            "$ref": "#/components/responses/BadGateway"
          },
          "503": {
            "$ref": "#/components/responses/ServiceUnavailable"
          },
          "504": {
            "$ref": "#/components/responses/GatewayTimeout"
          }
        }
      }
    },
    "/zones/{zoneName}/snapshots/{snapshotId}": {
      "parameters": [
        {
          "$ref": "#/components/parameters/ZoneName"
        },
        {
          "$ref": "#/components/parameters/SnapshotId"
        }
      ],
      "get": {
        "operationId": "getZoneSnapshot",
        "x-required-permission": "account.zones:read",
        "summary": "Get a zone snapshot",
        "description": "Returns a snapshot of the zone, with its details and the record sets\nit captured. Each record set has the same fields as in\n`GET /zones/{zoneName}/records`, including `routing.systemGenerated`.\n",
        "tags": [
          "Snapshots"
        ],
        "parameters": [
          {
            "$ref": "#/components/parameters/XRequestId"
          }
        ],
        "responses": {
          "200": {
            "description": "The snapshot's details and record sets.",
            "headers": {
              "X-Request-Id": {
                "$ref": "#/components/headers/XRequestId"
              },
              "X-RateLimit-Limit": {
                "$ref": "#/components/headers/XRateLimitLimit"
              },
              "X-RateLimit-Remaining": {
                "$ref": "#/components/headers/XRateLimitRemaining"
              },
              "X-RateLimit-Reset": {
                "$ref": "#/components/headers/XRateLimitReset"
              }
            },
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ZoneSnapshot"
                },
                "examples": {
                  "snapshot": {
                    "summary": "A snapshot with record sets",
                    "value": {
                      "id": "c3e0a2d5-8f4b-4d9c-a032-1b6f7e8d9c40",
                      "zoneName": "example.com.",
                      "isRegionalViewEnabled": false,
                      "name": "pre-migration",
                      "description": "Pre-migration backup",
                      "createdAt": "2026-06-05T14:00:00Z",
                      "rrSets": [
                        {
                          "zoneName": "example.com.",
                          "name": "example.com.",
                          "rrtype": "A",
                          "ttl": 300,
                          "routing": {
                            "policy": "NONE",
                            "content": [
                              "203.0.113.1"
                            ]
                          },
                          "createdAt": "2026-07-30T10:00:00Z",
                          "updatedAt": "2026-07-30T10:00:00Z"
                        },
                        {
                          "zoneName": "example.com.",
                          "name": "www.example.com.",
                          "rrtype": "A",
                          "ttl": 300,
                          "routing": {
                            "policy": "SIMPLE_FAILOVER",
                            "status": "Healthy",
                            "failureSensitivity": "MEDIUM",
                            "monitor": {
                              "protocol": "HTTPS",
                              "host": "www.example.com",
                              "port": 443,
                              "path": "/health",
                              "searchString": "OK"
                            },
                            "endpoints": [
                              {
                                "target": "192.0.2.1",
                                "priority": 1,
                                "isEnabled": true,
                                "health": "Healthy",
                                "isServing": true
                              },
                              {
                                "target": "192.0.2.2",
                                "priority": 2,
                                "isEnabled": true,
                                "health": "Healthy",
                                "isServing": false
                              }
                            ],
                            "systemGenerated": [
                              "USER_DEFINED",
                              "USER_DEFINED"
                            ]
                          },
                          "createdAt": "2026-07-30T10:00:00Z",
                          "updatedAt": "2026-07-30T10:00:00Z"
                        }
                      ]
                    }
                  },
                  "snapshotRegionalView": {
                    "summary": "A snapshot with regional records",
                    "description": "When the zone uses regional views, each record set in the\nsnapshot has a `region` field.\n",
                    "value": {
                      "id": "d4f1b3e6-9a5c-4e0d-b143-2c7a8f0e1d51",
                      "zoneName": "example.com.",
                      "isRegionalViewEnabled": true,
                      "name": "regional-backup",
                      "description": "Backup with regional overrides",
                      "createdAt": "2026-07-30T14:00:00Z",
                      "rrSets": [
                        {
                          "zoneName": "example.com.",
                          "name": "www.example.com.",
                          "rrtype": "A",
                          "ttl": 300,
                          "routing": {
                            "policy": "SIMPLE_FAILOVER",
                            "status": "Healthy",
                            "failureSensitivity": "MEDIUM",
                            "monitor": {
                              "protocol": "HTTPS",
                              "host": "www.example.com",
                              "port": 443,
                              "path": "/health",
                              "searchString": "OK"
                            },
                            "endpoints": [
                              {
                                "target": "192.0.2.1",
                                "priority": 1,
                                "isEnabled": true,
                                "health": "Healthy",
                                "isServing": true
                              },
                              {
                                "target": "192.0.2.2",
                                "priority": 2,
                                "isEnabled": true,
                                "health": "Healthy",
                                "isServing": false
                              }
                            ],
                            "systemGenerated": [
                              "USER_DEFINED",
                              "USER_DEFINED"
                            ]
                          },
                          "region": "GLOBAL",
                          "createdAt": "2026-07-30T10:00:00Z",
                          "updatedAt": "2026-07-30T10:00:00Z"
                        },
                        {
                          "zoneName": "example.com.",
                          "name": "www.example.com.",
                          "rrtype": "A",
                          "ttl": 120,
                          "routing": {
                            "policy": "SIMPLE_FAILOVER",
                            "status": "Healthy",
                            "failureSensitivity": "HIGH",
                            "monitor": {
                              "protocol": "HTTPS",
                              "host": "www.example.com",
                              "port": 443,
                              "path": "/health",
                              "searchString": "OK"
                            },
                            "endpoints": [
                              {
                                "target": "192.0.2.50",
                                "priority": 1,
                                "isEnabled": true,
                                "health": "Healthy",
                                "isServing": true
                              },
                              {
                                "target": "192.0.2.51",
                                "priority": 2,
                                "isEnabled": true,
                                "health": "Healthy",
                                "isServing": false
                              }
                            ],
                            "systemGenerated": [
                              "USER_DEFINED",
                              "USER_DEFINED"
                            ]
                          },
                          "region": "EUROPE",
                          "createdAt": "2026-07-30T10:00:00Z",
                          "updatedAt": "2026-07-30T10:00:00Z"
                        },
                        {
                          "zoneName": "example.com.",
                          "name": "api.example.com.",
                          "rrtype": "A",
                          "ttl": 300,
                          "routing": {
                            "policy": "NONE",
                            "content": [
                              "192.0.2.10"
                            ]
                          },
                          "region": "GLOBAL",
                          "createdAt": "2026-07-30T10:00:00Z",
                          "updatedAt": "2026-07-30T10:00:00Z"
                        }
                      ]
                    }
                  }
                }
              }
            }
          },
          "401": {
            "$ref": "#/components/responses/Unauthorized"
          },
          "403": {
            "$ref": "#/components/responses/Forbidden"
          },
          "404": {
            "$ref": "#/components/responses/NotFound"
          },
          "429": {
            "$ref": "#/components/responses/TooManyRequests"
          },
          "500": {
            "$ref": "#/components/responses/InternalServerError"
          },
          "502": {
            "$ref": "#/components/responses/BadGateway"
          },
          "503": {
            "$ref": "#/components/responses/ServiceUnavailable"
          },
          "504": {
            "$ref": "#/components/responses/GatewayTimeout"
          }
        }
      },
      "delete": {
        "operationId": "deleteZoneSnapshot",
        "x-required-permission": "account.zones:update",
        "summary": "Delete a zone snapshot",
        "description": "Deletes a snapshot of the zone. The zone's records don't change.\n",
        "tags": [
          "Snapshots"
        ],
        "parameters": [
          {
            "$ref": "#/components/parameters/IdempotencyKeyOptional"
          },
          {
            "$ref": "#/components/parameters/XRequestId"
          }
        ],
        "responses": {
          "204": {
            "description": "The API deleted the snapshot.",
            "headers": {
              "X-Request-Id": {
                "$ref": "#/components/headers/XRequestId"
              },
              "X-Idempotent-Replayed": {
                "$ref": "#/components/headers/XIdempotentReplayed"
              },
              "X-RateLimit-Limit": {
                "$ref": "#/components/headers/XRateLimitLimit"
              },
              "X-RateLimit-Remaining": {
                "$ref": "#/components/headers/XRateLimitRemaining"
              },
              "X-RateLimit-Reset": {
                "$ref": "#/components/headers/XRateLimitReset"
              }
            }
          },
          "401": {
            "$ref": "#/components/responses/Unauthorized"
          },
          "403": {
            "$ref": "#/components/responses/Forbidden"
          },
          "404": {
            "$ref": "#/components/responses/NotFound"
          },
          "409": {
            "$ref": "#/components/responses/Conflict"
          },
          "429": {
            "$ref": "#/components/responses/TooManyRequests"
          },
          "500": {
            "$ref": "#/components/responses/InternalServerError"
          },
          "502": {
            "$ref": "#/components/responses/BadGateway"
          },
          "503": {
            "$ref": "#/components/responses/ServiceUnavailable"
          },
          "504": {
            "$ref": "#/components/responses/GatewayTimeout"
          }
        }
      }
    },
    "/zones/{zoneName}/snapshots/{snapshotId}:restore": {
      "parameters": [
        {
          "$ref": "#/components/parameters/ZoneName"
        },
        {
          "$ref": "#/components/parameters/SnapshotId"
        }
      ],
      "post": {
        "operationId": "restoreZoneSnapshot",
        "x-required-permission": "account.zones:update",
        "summary": "Restore a zone from a snapshot",
        "description": "Replaces the zone's records with the records in the snapshot.\nRestoring takes time, so the API returns `202 Accepted` and a\n`Location` header that points to a task. The zone has the snapshot's\nrecords when the task's status is `SUCCEEDED`.\n\nThe request body has no fields, because the path already says which\nsnapshot to use. Send no body or an empty object, `{}`.\n",
        "tags": [
          "Snapshots"
        ],
        "parameters": [
          {
            "$ref": "#/components/parameters/IdempotencyKey"
          },
          {
            "$ref": "#/components/parameters/XRequestId"
          }
        ],
        "requestBody": {
          "required": false,
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/RestoreZoneRequest"
              },
              "examples": {
                "empty": {
                  "summary": "An empty body",
                  "value": {}
                }
              }
            }
          }
        },
        "responses": {
          "202": {
            "description": "The restore has started. Check its progress with the task in the\n`Location` header.\n",
            "headers": {
              "Location": {
                "$ref": "#/components/headers/Location"
              },
              "X-Request-Id": {
                "$ref": "#/components/headers/XRequestId"
              },
              "X-Idempotent-Replayed": {
                "$ref": "#/components/headers/XIdempotentReplayed"
              },
              "X-RateLimit-Limit": {
                "$ref": "#/components/headers/XRateLimitLimit"
              },
              "X-RateLimit-Remaining": {
                "$ref": "#/components/headers/XRateLimitRemaining"
              },
              "X-RateLimit-Reset": {
                "$ref": "#/components/headers/XRateLimitReset"
              }
            },
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/AsyncTask"
                },
                "examples": {
                  "accepted": {
                    "summary": "The restore task, waiting to start",
                    "value": {
                      "id": "d4f1b3e6-9a5c-4e0d-b143-2c7a8f9e0d51",
                      "status": "PENDING",
                      "type": "zone.restore",
                      "submittedAt": "2026-06-05T14:00:00Z"
                    }
                  }
                }
              }
            }
          },
          "401": {
            "$ref": "#/components/responses/Unauthorized"
          },
          "403": {
            "$ref": "#/components/responses/Forbidden"
          },
          "404": {
            "$ref": "#/components/responses/NotFound"
          },
          "409": {
            "$ref": "#/components/responses/Conflict"
          },
          "422": {
            "$ref": "#/components/responses/UnprocessableEntity"
          },
          "429": {
            "$ref": "#/components/responses/TooManyRequests"
          },
          "500": {
            "$ref": "#/components/responses/InternalServerError"
          },
          "502": {
            "$ref": "#/components/responses/BadGateway"
          },
          "503": {
            "$ref": "#/components/responses/ServiceUnavailable"
          },
          "504": {
            "$ref": "#/components/responses/GatewayTimeout"
          }
        }
      }
    },
    "/tasks/batch": {
      "post": {
        "operationId": "executeBatch",
        "x-required-permission": "account.tasks.batch:create",
        "summary": "Run a batch of requests",
        "description": "Runs several create, update, and delete requests in one call. Each\nsub-request is a `POST`, `PUT`, `PATCH`, or `DELETE` request to\nanother path in this API. Zone actions such as `:transfer` can't be\nbatched. To read several resources in one call, send a batch read\nrequest to `POST /tasks/batch:get`.\n\nThe API checks every sub-request before it runs any of them. If a\nsub-request has an unsupported path or method, or a body the API\ncan't read, the API returns `400 Bad Request` for the whole batch\nrequest and runs none of the sub-requests.\n\n**Running as a task or right away**\n\n- By default, the batch runs as a task. The API returns\n  `202 Accepted` and a `Location` header that points to the task.\n  When the task succeeds, it has a result for each sub-request.\n- To get the results in the response, set `async` to `false`. The API\n  returns `200 OK` with a result for each sub-request, in the same\n  order as the requests. A synchronous batch can have up to 50\n  sub-requests, and a task can have up to 1,000.\n\n**When a sub-request fails**\n\nA batch is all or nothing. If a sub-request fails, the API doesn't run\nthe sub-requests after it, and it doesn't keep the changes that the\nearlier sub-requests made. `onFailure` isn't applied yet.\n\n- With `async` set to `false`, the API returns the failed\n  sub-request's error, such as `404 Not Found`, for the whole batch\n  request. A `200 OK` response means that every sub-request\n  succeeded.\n- As a task, the task's status is `FAILED`, and its `result`\n  describes the first error.\n\n**Changing several record sets at once**\n\nA `PATCH` or `DELETE` sub-request to `/zones/{zoneName}/records` with\na `records` list makes one change for each record set in the list and\nreturns one result for the whole list. Each of those changes counts\ntoward the 50 or 1,000 limit.\n",
        "tags": [
          "Batch"
        ],
        "parameters": [
          {
            "$ref": "#/components/parameters/BatchAsync"
          },
          {
            "$ref": "#/components/parameters/OnFailure"
          },
          {
            "$ref": "#/components/parameters/IdempotencyKey"
          },
          {
            "$ref": "#/components/parameters/XRequestId"
          }
        ],
        "requestBody": {
          "required": true,
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/BatchRequest"
              },
              "examples": {
                "syncBatch": {
                  "summary": "A synchronous batch, with async=false",
                  "value": {
                    "requests": [
                      {
                        "method": "POST",
                        "uri": "/zones",
                        "body": {
                          "zoneName": "example.com.",
                          "type": "PRIMARY"
                        }
                      },
                      {
                        "method": "DELETE",
                        "uri": "/zones/old.example.com."
                      }
                    ]
                  }
                },
                "asyncBatch": {
                  "summary": "A batch that runs as a task, with async=true",
                  "value": {
                    "requests": [
                      {
                        "method": "POST",
                        "uri": "/zones",
                        "body": {
                          "zoneName": "example.com.",
                          "type": "PRIMARY"
                        }
                      },
                      {
                        "method": "DELETE",
                        "uri": "/zones/old.example.com."
                      }
                    ]
                  }
                },
                "createSecondaryZones": {
                  "summary": "Create secondary zones",
                  "description": "Each sub-request is `POST /zones` with the same body you'd\nsend to create one secondary zone. `secondary.inboundIpSetName`\nnames an Inbound IP Set in your account, and the optional\n`secondary.tsigKeyName` names a TSIG key that all the\nprimary servers in that set use.\n\nPut `zoneName` in the body, because there's no\n`POST /zones/{zoneName}`. Don't send `advancedConfig`,\n`primary`, or `recordImport`, because they only apply to\nprimary zones. A secondary zone gets its records by zone\ntransfer from its primary servers.\n\nCreating a secondary zone always runs as a task, so each\nresult has status `202` and a task to poll, not the zone.\n",
                  "value": {
                    "requests": [
                      {
                        "method": "POST",
                        "uri": "/zones",
                        "body": {
                          "type": "SECONDARY",
                          "zoneName": "secondary.example.com.",
                          "secondary": {
                            "inboundIpSetName": "upstream-prod-ns",
                            "tsigKeyName": "primary-key"
                          }
                        }
                      },
                      {
                        "method": "POST",
                        "uri": "/zones",
                        "body": {
                          "type": "SECONDARY",
                          "zoneName": "secondary.example.net.",
                          "secondary": {
                            "inboundIpSetName": "upstream-prod-ns"
                          },
                          "reason": "Onboarding secondary zones for the EU rollout"
                        }
                      }
                    ]
                  }
                },
                "updateSecondaryZones": {
                  "summary": "Update secondary zones",
                  "description": "Each sub-request is `PATCH /zones/{zoneName}` with the same\nbody you'd send to update one zone. For a secondary zone, you\ncan change `status`, `secondary`, and `reason`. If you send\n`advancedConfig` or `primary`, or set `status` to `DISABLED`,\nthat sub-request fails with `422`.\n\nThe `secondary` object replaces the zone's whole primary\nserver setup, so `inboundIpSetName` is required in it. Inside\nit, leave out `tsigKeyName` to keep the current key, or set it\nto `null` to stop using a TSIG key.\n\nIf a sub-request doesn't change anything, it fails with\n`400`. If its zone doesn't exist, it fails with `404`, the\nsame as a single `PATCH /zones/{zoneName}` request. A failed\nsub-request fails the whole batch, and none of its updates\nare kept.\n",
                  "value": {
                    "requests": [
                      {
                        "method": "PATCH",
                        "uri": "/zones/secondary.example.com.",
                        "body": {
                          "secondary": {
                            "inboundIpSetName": "upstream-dr",
                            "tsigKeyName": "primary-key"
                          },
                          "reason": "Switching upstream provider"
                        }
                      },
                      {
                        "method": "PATCH",
                        "uri": "/zones/secondary.example.net.",
                        "body": {
                          "secondary": {
                            "inboundIpSetName": "upstream-dr",
                            "tsigKeyName": null
                          },
                          "reason": "Rotating upstream TSIG credentials"
                        }
                      },
                      {
                        "method": "PATCH",
                        "uri": "/zones/retired.example.org.",
                        "body": {
                          "status": "SUSPENDED",
                          "reason": "Customer offboarding"
                        }
                      }
                    ]
                  }
                }
              }
            }
          }
        },
        "responses": {
          "200": {
            "description": "Every sub-request succeeded. Each result is for the sub-request\nat the same position in the request.\n",
            "headers": {
              "X-Request-Id": {
                "$ref": "#/components/headers/XRequestId"
              },
              "X-Idempotent-Replayed": {
                "$ref": "#/components/headers/XIdempotentReplayed"
              },
              "X-RateLimit-Limit": {
                "$ref": "#/components/headers/XRateLimitLimit"
              },
              "X-RateLimit-Remaining": {
                "$ref": "#/components/headers/XRateLimitRemaining"
              },
              "X-RateLimit-Reset": {
                "$ref": "#/components/headers/XRateLimitReset"
              }
            },
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/BatchExecuteResponse"
                },
                "examples": {
                  "secondaryZonesCreated": {
                    "summary": "Results of creating secondary zones, with async=false",
                    "description": "Each result is what a single `POST /zones` request would\nreturn. Creating a secondary zone always runs as a task,\nso each result has status `202` and the task for the\nzone's first zone transfer. Poll each task to find out\nwhen the zone has its records.\n",
                    "value": [
                      {
                        "status": 202,
                        "response": {
                          "id": "3f1a7c29-88e4-4d2b-a501-9b3e6f7c1204",
                          "status": "PENDING",
                          "type": "zone.records.import",
                          "submittedAt": "2026-06-05T14:00:00Z"
                        }
                      },
                      {
                        "status": 202,
                        "response": {
                          "id": "c4e8b015-6a73-4f9d-8e21-5d0a9b2c7f38",
                          "status": "PENDING",
                          "type": "zone.records.import",
                          "submittedAt": "2026-06-05T14:00:00Z"
                        }
                      }
                    ]
                  },
                  "secondaryZonesUpdated": {
                    "summary": "Results of updating secondary zones",
                    "description": "Both updates succeeded. Each result is what a single\n`PATCH /zones/{zoneName}` request would return.\n",
                    "value": [
                      {
                        "status": 200,
                        "response": {
                          "name": "secondary.example.com.",
                          "type": "SECONDARY",
                          "status": "ACTIVE",
                          "isDnssecEnabled": false,
                          "recordCount": 42,
                          "secondary": {
                            "inboundIpSetName": "upstream-dr",
                            "tsigKeyName": "primary-key"
                          },
                          "transferDetails": {
                            "lastTransferStatus": "SUCCEEDED",
                            "lastTransferAt": "2026-06-05T13:00:00Z",
                            "nextTransferAt": "2026-06-05T19:00:00Z",
                            "lastTransferStatusMessage": null
                          },
                          "createdAt": "2026-05-19T08:00:00Z",
                          "updatedAt": "2026-06-05T14:00:00Z"
                        }
                      },
                      {
                        "status": 200,
                        "response": {
                          "name": "secondary.example.net.",
                          "type": "SECONDARY",
                          "status": "ACTIVE",
                          "isDnssecEnabled": false,
                          "recordCount": 17,
                          "secondary": {
                            "inboundIpSetName": "upstream-dr",
                            "tsigKeyName": null
                          },
                          "transferDetails": {
                            "lastTransferStatus": "SUCCEEDED",
                            "lastTransferAt": "2026-06-05T13:00:00Z",
                            "nextTransferAt": "2026-06-05T19:00:00Z",
                            "lastTransferStatusMessage": null
                          },
                          "createdAt": "2026-05-19T08:00:00Z",
                          "updatedAt": "2026-06-05T14:00:00Z"
                        }
                      }
                    ]
                  }
                }
              }
            }
          },
          "202": {
            "description": "The batch is running as a task. Poll the task in the `Location`\nheader to get a result for each sub-request.\n",
            "headers": {
              "Location": {
                "$ref": "#/components/headers/Location"
              },
              "X-Request-Id": {
                "$ref": "#/components/headers/XRequestId"
              },
              "X-Idempotent-Replayed": {
                "$ref": "#/components/headers/XIdempotentReplayed"
              },
              "X-RateLimit-Limit": {
                "$ref": "#/components/headers/XRateLimitLimit"
              },
              "X-RateLimit-Remaining": {
                "$ref": "#/components/headers/XRateLimitRemaining"
              },
              "X-RateLimit-Reset": {
                "$ref": "#/components/headers/XRateLimitReset"
              }
            },
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/AsyncTaskWithResource"
                },
                "examples": {
                  "accepted": {
                    "summary": "The batch task, waiting to start",
                    "value": {
                      "id": "e5a2c4f7-0b6d-4f1e-c254-3d8b9a0f1e62",
                      "status": "PENDING",
                      "type": "batch",
                      "submittedAt": "2026-06-05T14:00:00Z"
                    }
                  }
                }
              }
            }
          },
          "400": {
            "$ref": "#/components/responses/BadRequest"
          },
          "401": {
            "$ref": "#/components/responses/Unauthorized"
          },
          "403": {
            "$ref": "#/components/responses/Forbidden"
          },
          "409": {
            "$ref": "#/components/responses/Conflict"
          },
          "413": {
            "$ref": "#/components/responses/PayloadTooLarge"
          },
          "415": {
            "$ref": "#/components/responses/UnsupportedMediaType"
          },
          "429": {
            "$ref": "#/components/responses/TooManyRequests"
          },
          "500": {
            "$ref": "#/components/responses/InternalServerError"
          },
          "502": {
            "$ref": "#/components/responses/BadGateway"
          },
          "503": {
            "$ref": "#/components/responses/ServiceUnavailable"
          },
          "504": {
            "$ref": "#/components/responses/GatewayTimeout"
          }
        }
      }
    },
    "/tasks/batch:get": {
      "post": {
        "operationId": "executeBatchGet",
        "x-required-permission": "account.tasks.batch:read",
        "summary": "Read several resources in one call",
        "description": "Runs several `GET` requests in one call and returns their results\ntogether. To create, update, or delete in one call, send a batch\nrequest to `POST /tasks/batch`.\n\nYou can read these paths:\n\n- `/zones/{zoneName}`\n- `/zones/{zoneName}/records`\n- `/zones/{zoneName}/records/{rrtype}/{name}`\n- `/zones/{zoneName}/records/{rrtype}/{name}/regions/{region}`\n\nThe API runs the reads right away and returns `200 OK` with a result\nfor each sub-request, in the same order as the requests. You can send\nup to 50 sub-requests. If one fails, the API still runs the others.\nA list read returns one page, the same as when you send it on its own.\nTo get the next page, send another sub-request with `pageToken` set to\nthe `nextPageToken` from the result.\n\n**Results for each sub-request**\n\nEach result has its own `status`:\n\n- A `2xx` status means the read succeeded.\n- `400` means the API can't read the sub-request's path. For example,\n  the path isn't supported, or it has an unknown record type or\n  region. The API doesn't run that sub-request, and the error's\n  `instance` is the path you sent.\n- `404` means the resource doesn't exist. A list with no matches is an\n  empty page with status `200`, not `404`.\n\n**Errors for the whole call**\n\nFor any other error, the whole call fails and you don't get results\nfor any sub-request:\n\n- `400` means the batch read request itself isn't valid. For example, it\n  has no sub-requests or more than 50, a method other than `GET`, or\n  a `uri` that's a full URL instead of a path.\n- `401` or `403` means your API key isn't valid or isn't allowed to\n  make the call. If it isn't allowed to make one of the reads, the\n  whole call fails with `403`. To get partial results, put reads that\n  need different permissions in separate batches.\n\n**Idempotency keys**\n\nThe call is a `POST` because the reads are in the request body, but\nit doesn't change anything. It still needs an `Idempotency-Key`\nheader. The API doesn't compare request bodies, so if you reuse a\nkey, you get the first response again, even if the reads are\ndifferent. Use a new key for each call.\n",
        "tags": [
          "Batch"
        ],
        "parameters": [
          {
            "$ref": "#/components/parameters/IdempotencyKey"
          },
          {
            "$ref": "#/components/parameters/XRequestId"
          }
        ],
        "requestBody": {
          "required": true,
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/BatchGetRequest"
              },
              "examples": {
                "mixedReads": {
                  "summary": "Fetch a zone and its record sets",
                  "value": {
                    "requests": [
                      {
                        "method": "GET",
                        "uri": "/zones/example.com."
                      },
                      {
                        "method": "GET",
                        "uri": "/zones/example.com./records?pageSize=25"
                      }
                    ]
                  }
                },
                "fanOutByZone": {
                  "summary": "Read the same resource in several zones",
                  "value": {
                    "requests": [
                      {
                        "method": "GET",
                        "uri": "/zones/example.com."
                      },
                      {
                        "method": "GET",
                        "uri": "/zones/example.net."
                      },
                      {
                        "method": "GET",
                        "uri": "/zones/missing.example.org."
                      }
                    ]
                  }
                },
                "recordByName": {
                  "summary": "Get record sets by name",
                  "description": "Each sub-request gets one record set by its zone, record\ntype, and owner name, the same as\n`GET /zones/{zoneName}/records/{rrtype}/{name}`. That path\ntakes one name, so a batch is how you read several names in\none call.\n",
                  "value": {
                    "requests": [
                      {
                        "method": "GET",
                        "uri": "/zones/example.com./records/A/www.example.com."
                      },
                      {
                        "method": "GET",
                        "uri": "/zones/example.com./records/MX/example.com."
                      },
                      {
                        "method": "GET",
                        "uri": "/zones/example.com./records/A/api.example.com.?systemGeneratedStatus=true"
                      }
                    ]
                  }
                },
                "regionalRecordByName": {
                  "summary": "Get a record set's regional versions by name",
                  "description": "Reads a record set and its regional versions in one call.\nThis only works for zones where\n`advancedConfig.isRegionalViewEnabled` is `true`.\n\nThe first sub-request leaves out the region, because\n`GLOBAL` is the default version for every region and isn't\na valid `/regions/{region}` value.\n\nIf a region has no version of its own, its result is the\n`GLOBAL` record set, with `region` set to `GLOBAL`. If the\nrecord set is excluded from a region, the result is the\nrecord set the exclusion applies to, with `isExcluded` set\nto `true`: the region's own version if it has one,\notherwise the `GLOBAL` record set. A\nsub-request fails with `404` only when there's neither a\nregional version nor a `GLOBAL` record set.\n",
                  "value": {
                    "requests": [
                      {
                        "method": "GET",
                        "uri": "/zones/example.com./records/A/www.example.com."
                      },
                      {
                        "method": "GET",
                        "uri": "/zones/example.com./records/A/www.example.com./regions/EUROPE"
                      },
                      {
                        "method": "GET",
                        "uri": "/zones/example.com./records/A/www.example.com./regions/ASIA_PAC"
                      }
                    ]
                  }
                }
              }
            }
          }
        },
        "responses": {
          "200": {
            "description": "The API ran the reads. Each result is for the sub-request at the\nsame position in the request.\n",
            "headers": {
              "X-Request-Id": {
                "$ref": "#/components/headers/XRequestId"
              },
              "X-Idempotent-Replayed": {
                "$ref": "#/components/headers/XIdempotentReplayed"
              },
              "X-RateLimit-Limit": {
                "$ref": "#/components/headers/XRateLimitLimit"
              },
              "X-RateLimit-Remaining": {
                "$ref": "#/components/headers/XRateLimitRemaining"
              },
              "X-RateLimit-Reset": {
                "$ref": "#/components/headers/XRateLimitReset"
              }
            },
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/BatchGetResponse"
                },
                "examples": {
                  "allSucceeded": {
                    "summary": "Every sub-request succeeded",
                    "value": [
                      {
                        "status": 200,
                        "response": {
                          "name": "example.com.",
                          "type": "PRIMARY",
                          "status": "ACTIVE",
                          "advancedConfig": {
                            "isCertCentralEnabled": false,
                            "isValimailEnabled": false,
                            "isRegionalViewEnabled": false
                          },
                          "createdAt": "2026-07-30T10:00:00Z",
                          "updatedAt": "2026-07-30T10:00:00Z"
                        }
                      },
                      {
                        "status": 200,
                        "response": {
                          "data": [
                            {
                              "zoneName": "example.com.",
                              "name": "www.example.com.",
                              "rrtype": "A",
                              "ttl": 300,
                              "routing": {
                                "policy": "NONE",
                                "content": [
                                  "192.0.2.1"
                                ]
                              },
                              "createdAt": "2026-07-30T10:00:00Z",
                              "updatedAt": "2026-07-30T10:00:00Z"
                            }
                          ],
                          "pagination": {
                            "hasMore": false,
                            "nextPageToken": null,
                            "prevPageToken": null,
                            "firstPageToken": null,
                            "lastPageToken": null
                          },
                          "totalCount": 1
                        }
                      }
                    ]
                  },
                  "partialFailure": {
                    "summary": "Some reads failed and the batch still returned 200",
                    "description": "The second zone doesn't exist, so its result is `404`.\nThe API can't read the third path, so it didn't run that\nsub-request and its result is `400`, with `instance` set\nto the path you sent. The other results aren't affected.\n\nA result can't have status `403`. If your API key isn't\nallowed to make one of the reads, the whole call fails\nwith `403`.\n",
                    "value": [
                      {
                        "status": 200,
                        "response": {
                          "name": "example.com.",
                          "type": "PRIMARY",
                          "status": "ACTIVE",
                          "advancedConfig": {
                            "isCertCentralEnabled": false,
                            "isValimailEnabled": false,
                            "isRegionalViewEnabled": false
                          },
                          "createdAt": "2026-07-30T10:00:00Z",
                          "updatedAt": "2026-07-30T10:00:00Z"
                        }
                      },
                      {
                        "status": 404,
                        "response": {
                          "type": "https://errors.dns.digicert.com/not-found",
                          "title": "Not Found",
                          "status": 404,
                          "detail": "The requested resource does not exist",
                          "code": "RESOURCE_NOT_FOUND",
                          "instance": "/zones/missing.example.org."
                        }
                      },
                      {
                        "status": 400,
                        "response": {
                          "type": "https://errors.dns.digicert.com/bad-request",
                          "title": "Bad Request",
                          "status": 400,
                          "detail": "Unsupported batch read sub-request uri: /dns-settings/tsig-keys; supported: /zones/{zoneName}, /zones/{zoneName}/records, /zones/{zoneName}/records/{rrtype}/{name} and /zones/{zoneName}/records/{rrtype}/{name}/regions/{region}",
                          "code": "BAD_REQUEST",
                          "instance": "/dns-settings/tsig-keys"
                        }
                      }
                    ]
                  },
                  "recordsByName": {
                    "summary": "Results of getting record sets by name",
                    "description": "Each result is the record set that a single\n`GET /zones/{zoneName}/records/{rrtype}/{name}` request\nwould return. The third sub-request had\n`systemGeneratedStatus=true`, so its result has\n`routing.systemGenerated`, with one item for each item in\n`routing.content`.\n",
                    "value": [
                      {
                        "status": 200,
                        "response": {
                          "zoneName": "example.com.",
                          "name": "www.example.com.",
                          "rrtype": "A",
                          "ttl": 300,
                          "routing": {
                            "policy": "NONE",
                            "content": [
                              "192.0.2.1",
                              "192.0.2.2"
                            ]
                          },
                          "createdAt": "2026-07-30T10:00:00Z",
                          "updatedAt": "2026-07-30T10:00:00Z"
                        }
                      },
                      {
                        "status": 200,
                        "response": {
                          "zoneName": "example.com.",
                          "name": "example.com.",
                          "rrtype": "MX",
                          "ttl": 3600,
                          "routing": {
                            "policy": "NONE",
                            "content": [
                              "10 mail.example.com."
                            ]
                          },
                          "createdAt": "2026-07-30T10:00:00Z",
                          "updatedAt": "2026-07-30T10:00:00Z"
                        }
                      },
                      {
                        "status": 200,
                        "response": {
                          "zoneName": "example.com.",
                          "name": "api.example.com.",
                          "rrtype": "A",
                          "ttl": 300,
                          "routing": {
                            "policy": "NONE",
                            "content": [
                              "192.0.2.10"
                            ],
                            "systemGenerated": [
                              "USER_DEFINED"
                            ]
                          },
                          "createdAt": "2026-07-30T10:00:00Z",
                          "updatedAt": "2026-07-30T10:00:00Z"
                        }
                      }
                    ]
                  },
                  "regionalRecordsByName": {
                    "summary": "Results of getting regional versions by name",
                    "description": "The first result is the record set from the path without\na region, with `region` set to `GLOBAL`. The second is\nthe `EUROPE` version. `ASIA_PAC` has no version of its\nown, so its result is the `GLOBAL` record set instead of\n`404`. An excluded region's result looks the same, but\nwith `isExcluded` set to `true`. If the excluded region\nhas a version of its own, the result is that version,\nwith its own `region` and `isExcluded` set to `true`.\n\nAll three results have the same fields, because a\nregional read can return the `GLOBAL` record set, which\nhas `region` and `isExcluded`.\n",
                    "value": [
                      {
                        "status": 200,
                        "response": {
                          "zoneName": "example.com.",
                          "name": "www.example.com.",
                          "rrtype": "A",
                          "ttl": 300,
                          "routing": {
                            "policy": "NONE",
                            "content": [
                              "192.0.2.1"
                            ]
                          },
                          "region": "GLOBAL",
                          "createdAt": "2026-07-30T10:00:00Z",
                          "updatedAt": "2026-07-30T10:00:00Z"
                        }
                      },
                      {
                        "status": 200,
                        "response": {
                          "zoneName": "example.com.",
                          "name": "www.example.com.",
                          "rrtype": "A",
                          "ttl": 120,
                          "routing": {
                            "policy": "SIMPLE_FAILOVER",
                            "status": "Healthy",
                            "failureSensitivity": "HIGH",
                            "monitor": {
                              "protocol": "HTTPS",
                              "host": "www.example.com",
                              "port": 443,
                              "path": "/health",
                              "searchString": "OK"
                            },
                            "endpoints": [
                              {
                                "target": "192.0.2.50",
                                "priority": 1,
                                "isEnabled": true,
                                "health": "Healthy",
                                "isServing": true
                              },
                              {
                                "target": "192.0.2.51",
                                "priority": 2,
                                "isEnabled": true,
                                "health": "Healthy",
                                "isServing": false
                              }
                            ],
                            "systemGenerated": [
                              "USER_DEFINED",
                              "USER_DEFINED"
                            ]
                          },
                          "region": "EUROPE",
                          "createdAt": "2026-07-30T10:00:00Z",
                          "updatedAt": "2026-07-30T10:00:00Z"
                        }
                      },
                      {
                        "status": 200,
                        "response": {
                          "zoneName": "example.com.",
                          "name": "www.example.com.",
                          "rrtype": "A",
                          "ttl": 300,
                          "routing": {
                            "policy": "NONE",
                            "content": [
                              "192.0.2.1"
                            ]
                          },
                          "region": "GLOBAL",
                          "createdAt": "2026-07-30T10:00:00Z",
                          "updatedAt": "2026-07-30T10:00:00Z"
                        }
                      }
                    ]
                  }
                }
              }
            }
          },
          "400": {
            "$ref": "#/components/responses/BadRequest"
          },
          "401": {
            "$ref": "#/components/responses/Unauthorized"
          },
          "403": {
            "$ref": "#/components/responses/Forbidden"
          },
          "409": {
            "$ref": "#/components/responses/Conflict"
          },
          "413": {
            "$ref": "#/components/responses/PayloadTooLarge"
          },
          "415": {
            "$ref": "#/components/responses/UnsupportedMediaType"
          },
          "429": {
            "$ref": "#/components/responses/TooManyRequests"
          },
          "500": {
            "$ref": "#/components/responses/InternalServerError"
          },
          "502": {
            "$ref": "#/components/responses/BadGateway"
          },
          "503": {
            "$ref": "#/components/responses/ServiceUnavailable"
          },
          "504": {
            "$ref": "#/components/responses/GatewayTimeout"
          }
        }
      }
    },
    "/integrations/{name}": {
      "parameters": [
        {
          "$ref": "#/components/parameters/IntegrationName"
        }
      ],
      "post": {
        "operationId": "linkIntegration",
        "x-required-permission": "account.management.integrations:create",
        "summary": "Link an integration",
        "description": "Links an integration to your account. The request has no body.\n\n- Linking `CERTCENTRAL` returns status `PENDING` with an `apiKey` and\n  `apiSecret`. Configure them in CertCentral to activate the\n  integration. Only this response returns them, so store them\n  securely.\n- Linking `VALIMAIL-MONITOR` returns status `ACTIVE`, because it\n  doesn't need activation.\n",
        "tags": [
          "Integrations"
        ],
        "parameters": [
          {
            "$ref": "#/components/parameters/IdempotencyKey"
          },
          {
            "$ref": "#/components/parameters/XRequestId"
          }
        ],
        "requestBody": {
          "required": false,
          "content": {
            "application/json": {
              "schema": {
                "type": "object",
                "additionalProperties": false
              }
            }
          }
        },
        "responses": {
          "201": {
            "description": "The API linked the integration. The `Location` header isn't\ncurrently returned.\n",
            "headers": {
              "Location": {
                "$ref": "#/components/headers/Location"
              },
              "X-Request-Id": {
                "$ref": "#/components/headers/XRequestId"
              },
              "X-Idempotent-Replayed": {
                "$ref": "#/components/headers/XIdempotentReplayed"
              },
              "X-RateLimit-Limit": {
                "$ref": "#/components/headers/XRateLimitLimit"
              },
              "X-RateLimit-Remaining": {
                "$ref": "#/components/headers/XRateLimitRemaining"
              },
              "X-RateLimit-Reset": {
                "$ref": "#/components/headers/XRateLimitReset"
              }
            },
            "content": {
              "application/json": {
                "schema": {
                  "oneOf": [
                    {
                      "$ref": "#/components/schemas/IntegrationLinkResponse"
                    },
                    {
                      "$ref": "#/components/schemas/ValimailIntegrationLinkResponse"
                    }
                  ]
                },
                "examples": {
                  "certCentralLinked": {
                    "summary": "CertCentral linked and waiting for activation",
                    "value": {
                      "status": "PENDING",
                      "apiKey": "<REDACTED_ACTIVATION_API_KEY>",
                      "apiSecret": "<REDACTED_ACTIVATION_API_SECRET>",
                      "createdAt": "2026-07-24T10:15:30Z",
                      "updatedAt": "2026-07-24T10:15:30Z"
                    }
                  },
                  "valimailLinked": {
                    "summary": "Valimail linked and active",
                    "value": {
                      "status": "ACTIVE",
                      "createdAt": "2026-07-24T10:15:30Z",
                      "updatedAt": "2026-07-24T10:15:30Z"
                    }
                  }
                }
              }
            }
          },
          "401": {
            "$ref": "#/components/responses/Unauthorized"
          },
          "403": {
            "$ref": "#/components/responses/Forbidden"
          },
          "429": {
            "$ref": "#/components/responses/TooManyRequests"
          },
          "500": {
            "$ref": "#/components/responses/InternalServerError"
          },
          "502": {
            "$ref": "#/components/responses/BadGateway"
          },
          "503": {
            "$ref": "#/components/responses/ServiceUnavailable"
          },
          "504": {
            "$ref": "#/components/responses/GatewayTimeout"
          }
        }
      },
      "put": {
        "operationId": "updateIntegration",
        "x-required-permission": "account.management.integrations:update",
        "summary": "Issue new activation credentials for an integration",
        "description": "Issues a new `apiKey` and `apiSecret` for an integration that's\nalready linked to your account, and sets its status back to\n`PENDING`. Configure the new values in CertCentral to activate the\nintegration again. The request has no body.\n\nYou can only use this with `CERTCENTRAL`. `VALIMAIL-MONITOR` doesn't\nuse activation credentials, so the API returns `400 Bad Request` for\nit.\n",
        "tags": [
          "Integrations"
        ],
        "parameters": [
          {
            "$ref": "#/components/parameters/IdempotencyKeyOptional"
          },
          {
            "$ref": "#/components/parameters/XRequestId"
          },
          {
            "name": "name",
            "in": "path",
            "required": true,
            "description": "The integration to update. Only `CERTCENTRAL` is supported.",
            "schema": {
              "type": "string",
              "enum": [
                "CERTCENTRAL"
              ]
            }
          }
        ],
        "requestBody": {
          "required": false,
          "content": {
            "application/json": {
              "schema": {
                "type": "object",
                "additionalProperties": false
              }
            }
          }
        },
        "responses": {
          "200": {
            "description": "The API issued new credentials, and the integration is waiting for activation.",
            "headers": {
              "X-Request-Id": {
                "$ref": "#/components/headers/XRequestId"
              },
              "X-Idempotent-Replayed": {
                "$ref": "#/components/headers/XIdempotentReplayed"
              },
              "X-RateLimit-Limit": {
                "$ref": "#/components/headers/XRateLimitLimit"
              },
              "X-RateLimit-Remaining": {
                "$ref": "#/components/headers/XRateLimitRemaining"
              },
              "X-RateLimit-Reset": {
                "$ref": "#/components/headers/XRateLimitReset"
              }
            },
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/IntegrationLinkResponse"
                },
                "examples": {
                  "updated": {
                    "summary": "New credentials, waiting for activation",
                    "value": {
                      "status": "PENDING",
                      "apiKey": "<REDACTED_ACTIVATION_API_KEY>",
                      "apiSecret": "<REDACTED_ACTIVATION_API_SECRET>",
                      "createdAt": "2026-07-24T10:15:30Z",
                      "updatedAt": "2026-07-24T11:42:05Z"
                    }
                  }
                }
              }
            }
          },
          "401": {
            "$ref": "#/components/responses/Unauthorized"
          },
          "403": {
            "$ref": "#/components/responses/Forbidden"
          },
          "404": {
            "$ref": "#/components/responses/NotFound"
          },
          "429": {
            "$ref": "#/components/responses/TooManyRequests"
          },
          "500": {
            "$ref": "#/components/responses/InternalServerError"
          },
          "502": {
            "$ref": "#/components/responses/BadGateway"
          },
          "503": {
            "$ref": "#/components/responses/ServiceUnavailable"
          },
          "504": {
            "$ref": "#/components/responses/GatewayTimeout"
          }
        }
      },
      "get": {
        "operationId": "getIntegration",
        "x-required-permission": "account.management.integrations:read",
        "summary": "Get an integration's status",
        "description": "Returns the status of an integration in your account.\n\n- `CERTCENTRAL` can be `PENDING`, `ACTIVE`, `NOT_LINKED`, or `ERROR`.\n- `VALIMAIL-MONITOR` can be `ACTIVE` or `NOT_LINKED`, because it\n  doesn't need activation.\n",
        "tags": [
          "Integrations"
        ],
        "parameters": [
          {
            "$ref": "#/components/parameters/XRequestId"
          }
        ],
        "responses": {
          "200": {
            "description": "The integration's status.",
            "headers": {
              "X-Request-Id": {
                "$ref": "#/components/headers/XRequestId"
              },
              "X-RateLimit-Limit": {
                "$ref": "#/components/headers/XRateLimitLimit"
              },
              "X-RateLimit-Remaining": {
                "$ref": "#/components/headers/XRateLimitRemaining"
              },
              "X-RateLimit-Reset": {
                "$ref": "#/components/headers/XRateLimitReset"
              }
            },
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/Integration"
                },
                "examples": {
                  "active": {
                    "summary": "An active integration",
                    "value": {
                      "status": "ACTIVE",
                      "createdAt": "2026-06-01T10:00:00Z",
                      "updatedAt": "2026-06-16T10:30:00Z"
                    }
                  }
                }
              }
            }
          },
          "401": {
            "$ref": "#/components/responses/Unauthorized"
          },
          "403": {
            "$ref": "#/components/responses/Forbidden"
          },
          "404": {
            "$ref": "#/components/responses/NotFound"
          },
          "429": {
            "$ref": "#/components/responses/TooManyRequests"
          },
          "500": {
            "$ref": "#/components/responses/InternalServerError"
          },
          "502": {
            "$ref": "#/components/responses/BadGateway"
          },
          "503": {
            "$ref": "#/components/responses/ServiceUnavailable"
          },
          "504": {
            "$ref": "#/components/responses/GatewayTimeout"
          }
        }
      },
      "delete": {
        "operationId": "unlinkIntegration",
        "x-required-permission": "account.management.integrations:delete",
        "summary": "Unlink an integration",
        "description": "Unlinks an integration from your account. The integration's status\nchanges to `NOT_LINKED` immediately, before the API responds.\n\nThe API then removes the integration's DMARC `TXT` records from your\nzones in the background. It returns `202 Accepted` with the cleanup\ntask in the body and a `Location` header that points to it, for\nexample `/v1/tasks/async/{taskId}`. Poll the task to track the\ncleanup.\n\n- `SUCCEEDED`: the API removed the records from your zones.\n- `FAILED`: some records might still be in your zones. The task's\n  `result` gives the reason.\n\nThe task's outcome doesn't change the integration's status. It stays\n`NOT_LINKED` whether the task succeeds or fails.\n\nIf a cleanup for the same integration is still running, the API\nreturns `409 Conflict` and doesn't start another.\n",
        "tags": [
          "Integrations"
        ],
        "parameters": [
          {
            "$ref": "#/components/parameters/IdempotencyKeyOptional"
          },
          {
            "$ref": "#/components/parameters/XRequestId"
          }
        ],
        "responses": {
          "202": {
            "description": "The API accepted the unlink request, which runs in the\nbackground. The body is the task, and the `Location` header\npoints to it. Poll it for the result.\n",
            "headers": {
              "Location": {
                "$ref": "#/components/headers/Location"
              },
              "X-Request-Id": {
                "$ref": "#/components/headers/XRequestId"
              },
              "X-Idempotent-Replayed": {
                "$ref": "#/components/headers/XIdempotentReplayed"
              },
              "X-RateLimit-Limit": {
                "$ref": "#/components/headers/XRateLimitLimit"
              },
              "X-RateLimit-Remaining": {
                "$ref": "#/components/headers/XRateLimitRemaining"
              },
              "X-RateLimit-Reset": {
                "$ref": "#/components/headers/XRateLimitReset"
              }
            },
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/AsyncTask"
                },
                "examples": {
                  "accepted": {
                    "summary": "Integration unlink task representation",
                    "value": {
                      "id": "7c9e6679-7425-40de-944b-e07fc1f90ae7",
                      "status": "PENDING",
                      "type": "integration.unlink",
                      "submittedAt": "2026-11-05T10:15:30Z"
                    }
                  }
                }
              }
            }
          },
          "401": {
            "$ref": "#/components/responses/Unauthorized"
          },
          "403": {
            "$ref": "#/components/responses/Forbidden"
          },
          "404": {
            "$ref": "#/components/responses/NotFound"
          },
          "409": {
            "description": "An unlink for this integration is already running, or an earlier\nrequest with the same `Idempotency-Key` is still running. The API\ndoesn't start another unlink.\n",
            "headers": {
              "X-Request-Id": {
                "$ref": "#/components/headers/XRequestId"
              }
            },
            "content": {
              "application/problem+json": {
                "schema": {
                  "$ref": "#/components/schemas/ProblemDetail"
                },
                "examples": {
                  "unlinkInProgress": {
                    "summary": "An unlink for this integration is already running",
                    "value": {
                      "type": "https://errors.dns.digicert.com/conflict",
                      "title": "Conflict",
                      "status": 409,
                      "detail": "An unlink for this integration is already in progress.",
                      "code": "CONFLICT"
                    }
                  },
                  "idempotencyInFlight": {
                    "summary": "An earlier request with the same Idempotency-Key is still running",
                    "value": {
                      "type": "https://errors.dns.digicert.com/idempotency-in-flight",
                      "title": "Idempotency In Flight",
                      "status": 409,
                      "detail": "A request with this Idempotency-Key is already in progress. Retry after the first request completes.",
                      "code": "IDEMPOTENCY_IN_FLIGHT"
                    }
                  }
                }
              }
            }
          },
          "429": {
            "$ref": "#/components/responses/TooManyRequests"
          },
          "500": {
            "$ref": "#/components/responses/InternalServerError"
          },
          "502": {
            "$ref": "#/components/responses/BadGateway"
          },
          "503": {
            "$ref": "#/components/responses/ServiceUnavailable"
          },
          "504": {
            "$ref": "#/components/responses/GatewayTimeout"
          }
        }
      }
    }
  },
  "components": {
    "securitySchemes": {
      "apiKey": {
        "type": "apiKey",
        "in": "header",
        "name": "X-API-Key",
        "description": "A public API key, issued through the DigiCert customer portal. The key determines which\naccount a request acts on, so account IDs never appear in the URL path.\n"
      }
    },
    "parameters": {
      "pageToken": {
        "name": "pageToken",
        "in": "query",
        "required": false,
        "schema": {
          "type": "string"
        },
        "description": "An opaque cursor from a previous list response, such as `nextPageToken`. Send it to fetch that page."
      },
      "pageSizeLarge": {
        "name": "pageSize",
        "in": "query",
        "required": false,
        "schema": {
          "type": "integer",
          "minimum": 1,
          "maximum": 1000,
          "default": 25
        },
        "description": "The maximum number of items to return in a page, from 1 to 1000. The default is 25.\n\nZone and record set lists allow up to 1000 items in a page, so you can retrieve them in bulk.\nOther lists allow up to 100.\n",
        "example": 1000
      },
      "ZoneType": {
        "name": "type",
        "in": "query",
        "required": false,
        "schema": {
          "type": "string",
          "enum": [
            "PRIMARY",
            "SECONDARY"
          ]
        },
        "description": "Filter zones by type. When omitted, zones of all types are returned.\n",
        "example": "PRIMARY"
      },
      "ZoneStatus": {
        "name": "status",
        "in": "query",
        "required": false,
        "schema": {
          "type": "string",
          "enum": [
            "ACTIVE",
            "DISABLED",
            "SUSPENDED"
          ]
        },
        "description": "Filter zones by operational status.\n\n- `ACTIVE`: The authoritative nameservers serve the zone and answer DNS\n  queries for it normally.\n- `DISABLED`: The zone exists and you can still manage it, but it isn't\n  served. The platform doesn't answer queries for it authoritatively.\n  A zone becomes disabled only when you disable it, and its records and\n  properties are kept.\n- `SUSPENDED`: The zone is suspended, for example for billing or policy\n  reasons.\n",
        "example": "ACTIVE"
      },
      "ZoneQuery": {
        "name": "name",
        "in": "query",
        "required": false,
        "schema": {
          "type": "string",
          "minLength": 1,
          "maxLength": 255
        },
        "description": "Substring filter on the zone name. It's case-insensitive and ignores a\ntrailing dot, so `example.com` matches `example.com.` and\n`my-example.com.`. For `SECONDARY` zones, it matches only the start of\nthe name.\n",
        "example": "example.com"
      },
      "ZoneNameserverSetName": {
        "name": "nameserverSetName",
        "in": "query",
        "required": false,
        "schema": {
          "type": "string",
          "minLength": 1,
          "maxLength": 255
        },
        "description": "Filter PRIMARY zones by the name of the bound Nameserver Set\n(`primary.nameserverSetName`). Case-insensitive substring / contains match.\n",
        "example": "prod-ns"
      },
      "ZoneInboundIpSetName": {
        "name": "inboundIpSetName",
        "in": "query",
        "required": false,
        "schema": {
          "type": "string",
          "minLength": 1,
          "maxLength": 255
        },
        "description": "Filter SECONDARY zones by the name of the bound Inbound IP Set\n(`secondary.inboundIpSetName`). Case-insensitive substring /\ncontains match.\n",
        "example": "inbound-ns"
      },
      "ZoneOutboundIpSetName": {
        "name": "outboundIpSetName",
        "in": "query",
        "required": false,
        "schema": {
          "type": "string",
          "minLength": 1,
          "maxLength": 255
        },
        "description": "Filter PRIMARY zones by the name of a bound Outbound IP Set\n(matches any entry in `primary.outboundIps[].outboundIpSetName`).\nCase-insensitive substring / contains match.\n",
        "example": "outbound-ips"
      },
      "ZoneTsigKeyName": {
        "name": "tsigKeyName",
        "in": "query",
        "required": false,
        "schema": {
          "type": "string",
          "minLength": 1,
          "maxLength": 255
        },
        "description": "Filter zones by the name of a bound TSIG key. Matches\n`secondary.tsigKeyName` (SECONDARY zones) and any entry's\n`tsigKeyName` in `primary.outboundIps` (PRIMARY zones).\nCase-insensitive substring / contains match.\n",
        "example": "transfer-key"
      },
      "ZoneLastTransferStatus": {
        "name": "lastTransferStatus",
        "in": "query",
        "required": false,
        "schema": {
          "$ref": "#/components/schemas/ZoneTransferStatus"
        },
        "description": "Filter SECONDARY zones by the last transfer execution status\n(`transferDetails.lastTransferStatus`).\n",
        "example": "FAILED"
      },
      "ZoneIncludeStats": {
        "name": "includeStats",
        "in": "query",
        "required": false,
        "schema": {
          "type": "boolean",
          "default": false
        },
        "description": "When `true`, include aggregate `stats` in the list response. When omitted\nor `false`, the server may omit `stats`.\n\nStats reflect the `name` filter only. Other active filters don't narrow\nthe counts.\n"
      },
      "ZoneIsDnssecEnabled": {
        "name": "isDnssecEnabled",
        "in": "query",
        "required": false,
        "schema": {
          "type": "boolean"
        },
        "description": "Filter zones by DNSSEC state. `true` returns only DNSSEC-enabled\nzones; `false` returns only zones with DNSSEC disabled. Omit to\nreturn all zones regardless of DNSSEC state. Applies to both\nPRIMARY and SECONDARY zones.\n"
      },
      "ZoneIsCertCentralEnabled": {
        "name": "isCertCentralEnabled",
        "in": "query",
        "required": false,
        "schema": {
          "type": "boolean"
        },
        "description": "Filter PRIMARY zones by CertCentral integration state. `true`\nreturns only zones with CertCentral enabled; `false` returns only\nzones with it disabled. Omit to return all zones. Ignored for\nSECONDARY zones.\n"
      },
      "ZoneIsValimailEnabled": {
        "name": "isValimailEnabled",
        "in": "query",
        "required": false,
        "schema": {
          "type": "boolean"
        },
        "description": "Filter PRIMARY zones by Valimail integration state. `true`\nreturns only zones with Valimail enabled; `false` returns only\nzones with it disabled. Omit to return all zones. Ignored for\nSECONDARY zones.\n"
      },
      "ZoneIsRegionalViewEnabled": {
        "name": "isRegionalViewEnabled",
        "in": "query",
        "required": false,
        "schema": {
          "type": "boolean"
        },
        "description": "Filter PRIMARY zones by regional view state. `true` returns only zones\nwith regional views enabled; `false` returns only zones with it disabled.\nOmit to return all zones regardless of regional view state. Ignored for\nSECONDARY zones.\n"
      },
      "ZoneRecordCount": {
        "name": "recordCount",
        "in": "query",
        "required": false,
        "style": "deepObject",
        "explode": true,
        "schema": {
          "type": "object",
          "additionalProperties": false,
          "properties": {
            "gte": {
              "type": "integer",
              "minimum": 0,
              "description": "Minimum record count, inclusive."
            },
            "lte": {
              "type": "integer",
              "minimum": 0,
              "description": "Maximum record count, inclusive."
            },
            "gt": {
              "type": "integer",
              "minimum": 0,
              "description": "Minimum record count, exclusive."
            },
            "lt": {
              "type": "integer",
              "minimum": 0,
              "description": "Maximum record count, exclusive."
            },
            "eq": {
              "type": "integer",
              "minimum": 0,
              "description": "Exact record count."
            }
          }
        },
        "description": "Filter zones by record count range using bracket-suffix notation.\nSupply one or more of the sub-keys `gte`, `lte`, `gt`, `lt`, and `eq`\nto narrow the results.\n\nFor example:\n- `recordCount[gte]=10` returns zones with at least 10 records.\n- `recordCount[lte]=500` returns zones with at most 500 records.\n- `recordCount[gte]=10&recordCount[lte]=500` returns zones with 10 to\n  500 records.\n"
      },
      "ZoneSortBy": {
        "name": "sortBy",
        "in": "query",
        "required": false,
        "schema": {
          "type": "string",
          "enum": [
            "name",
            "recordCount",
            "status",
            "nameserverSetName",
            "outboundIpSetName",
            "inboundIpSetName",
            "tsigKeyName",
            "lastTransferStatus",
            "lastTransferAt",
            "isDnssecEnabled",
            "isCertCentralEnabled",
            "isValimailEnabled",
            "isRegionalViewEnabled"
          ]
        },
        "description": "Field to sort zones by. When omitted, zones are sorted alphabetically by\n`name`. `sortOrder` also applies to this default order. For example,\n`sortOrder=desc` with `sortBy` omitted reverses it, which is the same as\n`sortBy=name&sortOrder=desc`.\n\nThese keys apply to both zone types:\n\n- `name`: The zone name. This is the default.\n- `recordCount`: The number of records in the zone.\n- `status`: The zone's status, sorted alphabetically by value.\n- `isDnssecEnabled`: Whether DNSSEC is enabled.\n- `tsigKeyName`: The display name of the zone's TSIG key. For\n  `SECONDARY` zones, it's `secondary.tsigKeyName`. For `PRIMARY` zones,\n  it's the key of the first entry in `primary.outboundIps`. Zones\n  without a key have no value.\n\nThe other keys apply to one zone type. Zones of the other type have no\nvalue for the key, except where noted. Zones without a value sort\ntogether and are then sorted by `name`.\n\n- `nameserverSetName`: The display name of the zone's Nameserver Set.\n  Applies to `PRIMARY` zones.\n- `outboundIpSetName`: The display name of the first Outbound IP Set in\n  `primary.outboundIps`. Applies to `PRIMARY` zones.\n- `inboundIpSetName`: The display name of the zone's Inbound IP Set.\n  Applies to `SECONDARY` zones.\n- `lastTransferStatus`: The status of the most recent transfer, sorted\n  alphabetically by value. Applies to `SECONDARY` zones.\n- `lastTransferAt`: The time of the most recent completed transfer.\n  Applies to `SECONDARY` zones. A `SECONDARY` zone without a completed\n  transfer also has no value. Zones without a value sort first when\n  `sortOrder` is `asc`.\n- `isCertCentralEnabled`: Whether the CertCentral integration is\n  enabled. Applies to `PRIMARY` zones. `SECONDARY` zones sort as\n  `false`.\n- `isValimailEnabled`: Whether the Valimail integration is enabled.\n  Applies to `PRIMARY` zones. `SECONDARY` zones sort as `false`.\n- `isRegionalViewEnabled`: Whether regional views are enabled. Applies\n  to `PRIMARY` zones. `SECONDARY` zones sort as `false`.\n",
        "example": "nameserverSetName"
      },
      "ZoneSortOrder": {
        "name": "sortOrder",
        "in": "query",
        "required": false,
        "schema": {
          "type": "string",
          "enum": [
            "asc",
            "desc"
          ],
          "default": "asc"
        },
        "description": "Sort direction. Default is `asc` (A–Z / oldest first, depending on\n`sortBy`).\n",
        "example": "asc"
      },
      "XRequestId": {
        "name": "X-Request-Id",
        "in": "header",
        "required": false,
        "schema": {
          "type": "string",
          "pattern": "^[A-Za-z0-9._~-]{8,128}$",
          "example": "req_2033dc03-f17d-47fe-a619-897ae3629d16"
        },
        "description": "You can send this header, but don't rely on getting the same value back. The API can replace it\nwith its own ID, which has a `req_` prefix. When you contact support, use the ID from the\n`X-Request-Id` response header.\n"
      },
      "IdempotencyKey": {
        "name": "Idempotency-Key",
        "in": "header",
        "required": true,
        "schema": {
          "type": "string",
          "format": "uuid",
          "maxLength": 36
        },
        "description": "A client-generated UUID that makes the request safe to retry. If you repeat a request with the\nsame key, method, and path, the API returns the stored response without running the request\nagain. It doesn't compare query parameters or the request body, so use a new key for each new\nrequest.\n\nThe API doesn't store `429` or `5xx` responses, so a retry after one of them runs the request\nagain. If the first request with the key is still running, a retry gets `409 Conflict` with the\ncode `IDEMPOTENCY_IN_FLIGHT`.\n\nThe header is required on POST and PATCH, optional on PUT and DELETE, and mustn't be sent on\nGET.\n"
      },
      "ZoneName": {
        "name": "zoneName",
        "in": "path",
        "required": true,
        "schema": {
          "$ref": "#/components/schemas/DomainName"
        },
        "description": "The zone's fully qualified domain name, for example `example.com.`. A zone name is unique\nwithin an account, and the zone must belong to the account that owns the API key.\n\nThe trailing dot is optional. The API normalizes the name before it looks up the zone.\n",
        "examples": {
          "primary": {
            "value": "example.com.",
            "summary": "A primary zone FQDN with the canonical trailing dot."
          },
          "withoutTrailingDot": {
            "value": "example.com",
            "summary": "The same zone without the trailing dot."
          }
        }
      },
      "IdempotencyKeyOptional": {
        "name": "Idempotency-Key",
        "in": "header",
        "required": false,
        "schema": {
          "type": "string",
          "format": "uuid",
          "maxLength": 36
        },
        "description": "An optional client-generated UUID that makes a retry return the original response. PUT and\nDELETE are already idempotent. With a key, if you repeat a request with the same key, method,\nand path, the API returns the stored response without running the request again. It doesn't\ncompare query parameters or the request body, so use a new key for each new request.\n\nThe API doesn't store `429` or `5xx` responses, so a retry after one of them runs the request\nagain. If an earlier request with the same key is still running, the API returns\n`409 Conflict` with the code `IDEMPOTENCY_IN_FLIGHT`. Retry after the first request completes.\n\nWithout a key, every request runs.\n"
      },
      "HealthDomainType": {
        "name": "type",
        "in": "query",
        "required": false,
        "schema": {
          "$ref": "#/components/schemas/DnsHealthZoneType",
          "default": "primary"
        },
        "description": "The zone type to check: `primary` (default) or `secondary`. The zone\nmust exist as this type. If it doesn't, the API returns\n`404 Not Found`.\n",
        "example": "primary"
      },
      "ZoneTypeDisambiguator": {
        "name": "type",
        "in": "query",
        "required": false,
        "schema": {
          "type": "string",
          "enum": [
            "PRIMARY",
            "SECONDARY"
          ],
          "default": "PRIMARY"
        },
        "description": "The type of zone to use when `zoneName` matches both a primary zone and\na secondary zone. The same zone name can exist once as each type. The\nparameter only selects the zone. It doesn't filter the response. If the\nzone doesn't exist as the requested type, the API returns `404`.\n\n- `PRIMARY`: Use the primary zone. This is the default.\n- `SECONDARY`: Use the secondary zone.\n",
        "example": "PRIMARY"
      },
      "DnsHealthTypeRequired": {
        "name": "type",
        "in": "query",
        "required": true,
        "schema": {
          "$ref": "#/components/schemas/DnsHealthZoneType"
        },
        "description": "The zone type to check: `primary` or `secondary`. There's no default,\nbecause the peers and the transfer direction differ by zone type. The\nzone must exist as this type. If it doesn't, the API returns\n`404 Not Found`.\n",
        "example": "primary"
      },
      "RegionQuery": {
        "name": "region",
        "in": "query",
        "required": false,
        "schema": {
          "type": "string",
          "enum": [
            "NA_EAST",
            "NA_WEST",
            "SOUTH_AMERICA",
            "EUROPE",
            "ASIA_PAC",
            "OCEANIA",
            "AFRICA"
          ]
        },
        "description": "Region whose view of the zone to return. Where the region has a regional\nrecord set, the API returns it. Otherwise, it returns the `GLOBAL` record\nset. If the region has an exclusion for the record set, the record set\nreturned has `isExcluded` set to `true`: the regional record set when the\nregion has one, otherwise the `GLOBAL` record set. To leave out the\n`GLOBAL` record sets, also send `overrideRecordOnly=true`. To get the\n`GLOBAL` view, omit `region`.\n\n`region` applies to zones with `advancedConfig.isRegionalViewEnabled`\nset to `true`, and the API ignores it for other zones. You can combine\n`region` with `globalSearch`. The API resolves the region's view before\nit matches the search.\n",
        "example": "EUROPE"
      },
      "OverrideRecordOnly": {
        "name": "overrideRecordOnly",
        "in": "query",
        "required": false,
        "schema": {
          "type": "boolean",
          "default": false
        },
        "description": "Whether to return only the regional record sets for the requested\n`region`. The API applies `overrideRecordOnly` only when you also send\n`region`, and ignores it otherwise.\n\n- `true`: The API returns only record sets that have a regional record\n  set in `region`. It leaves out `GLOBAL` record sets, including those\n  the region falls back to.\n- `false`: The API returns the region's effective view. Where the region\n  has no regional record set, it returns the `GLOBAL` record set. This is\n  the default.\n\nTo get the `GLOBAL` view, omit `region` rather than setting it to\n`GLOBAL`. If you set `region` to `GLOBAL` and `overrideRecordOnly` to\n`true`, the API returns `400`. You can combine `overrideRecordOnly` with\n`globalSearch`. The API applies the overrides-only filter before it\nmatches the search.\n"
      },
      "RRSetName": {
        "name": "name",
        "in": "query",
        "required": false,
        "schema": {
          "type": "string",
          "minLength": 1,
          "maxLength": 255
        },
        "description": "Text to match in the owner name. A record set matches when its fully\nqualified owner name contains the text, ignoring case and a trailing dot.\nFor example, `name=example.com` matches `example.com.` and\n`my-example.com.`. You can't combine `name` with `globalSearch`.\n",
        "example": "example.com"
      },
      "RRSetTtl": {
        "name": "ttl",
        "in": "query",
        "required": false,
        "style": "deepObject",
        "explode": true,
        "schema": {
          "type": "object",
          "additionalProperties": false,
          "properties": {
            "gte": {
              "type": "integer",
              "minimum": 0,
              "description": "Minimum TTL in seconds, inclusive."
            },
            "lte": {
              "type": "integer",
              "minimum": 0,
              "description": "Maximum TTL in seconds, inclusive."
            },
            "gt": {
              "type": "integer",
              "minimum": 0,
              "description": "Minimum TTL in seconds, exclusive. The TTL must be greater than the number."
            },
            "lt": {
              "type": "integer",
              "minimum": 0,
              "description": "Maximum TTL in seconds, exclusive. The TTL must be less than the number."
            },
            "eq": {
              "type": "integer",
              "minimum": 0,
              "description": "Exact TTL in seconds."
            }
          }
        },
        "description": "Range of TTLs to match, in seconds. Add one or more operators in\nbrackets: `gte`, `lte`, `gt`, `lt`, or `eq`. A record set matches when\nits TTL meets every operator you send. For example,\n`ttl[gte]=300&ttl[lte]=3600` matches TTLs from 300 to 3600 seconds.\n\nThe API returns `400` if the operators can't all match at once, such as\n`ttl[gte]=600&ttl[lte]=300`, or an `eq` value outside the range. It also\nreturns `400` for an unknown operator or a value that isn't a\nnon-negative integer. You can't combine `ttl` with `globalSearch`.\n"
      },
      "RRSetContent": {
        "name": "content",
        "in": "query",
        "required": false,
        "schema": {
          "type": "string",
          "minLength": 1,
          "maxLength": 255
        },
        "description": "Text to match in the record data of `NONE` record sets. A record set\nmatches when any `routing.content` value contains the text, ignoring\ncase. `SIMPLE_FAILOVER` record sets never match.\n\nThe API compares values in BIND presentation format. Domain names in the\nrecord data match regardless of case or a trailing dot. For example,\n`content=example.com` matches an `MX` record set with the value\n`10 mail.example.com.`.\n\nYou can't combine `content` with `globalSearch`.\n",
        "example": "example.com"
      },
      "SystemGeneratedStatus": {
        "name": "systemGeneratedStatus",
        "in": "query",
        "required": false,
        "schema": {
          "type": "boolean",
          "default": false
        },
        "description": "Whether to return `routing.systemGenerated` on `NONE` record sets. The\narray says who created each value in `routing.content`, in the same\norder:\n\n- `USER_DEFINED`: A user created the value.\n- `NSSET`: DigiCert DNS created the `NS` record from a Nameserver Set\n  bound to the zone.\n- `SYSTEM`: DigiCert DNS created the record, such as a default DMARC or\n  SPF `TXT` record.\n\nWhen `systemGeneratedStatus` is `false` or omitted, `NONE` record sets\ndon't include `routing.systemGenerated`. `SIMPLE_FAILOVER` record sets\nalways include it, with one `USER_DEFINED` entry for each endpoint in\n`routing.endpoints`, because DigiCert DNS never creates failover\nendpoints.\n\nYou can combine `systemGeneratedStatus` with `globalSearch`.\n",
        "example": true
      },
      "RRSetSortBy": {
        "name": "sortBy",
        "in": "query",
        "required": false,
        "schema": {
          "type": "string",
          "enum": [
            "name"
          ]
        },
        "description": "Field to sort record sets by. The only key is `name`, the owner name,\nwhich is also the default. You can't combine `sortBy` with\n`globalSearch`.\n"
      },
      "RRSetSortOrder": {
        "name": "sortOrder",
        "in": "query",
        "required": false,
        "schema": {
          "type": "string",
          "enum": [
            "asc",
            "desc"
          ],
          "default": "asc"
        },
        "description": "Sort direction: `asc` for ascending or `desc` for descending. The\ndefault is `asc`. You can't combine `sortOrder` with `globalSearch`.\n"
      },
      "RRSetGlobalSearch": {
        "name": "globalSearch",
        "in": "query",
        "required": false,
        "schema": {
          "type": "string"
        },
        "description": "Text to search for across several fields of the zone's record sets. A\nrecord set matches when any of these fields contains the text:\n\n- The owner name.\n- The record type, `rrtype`.\n- The TTL, `ttl`.\n- The record data in BIND presentation format, `routing.content`. Only\n  `NONE` record sets match on record data.\n\nMatching ignores case. `*` matches any run of characters, and every\nother character matches literally. For example, `globalSearch=mail*example`\nmatches the owner names `mail.example.com.` and `mail2.example.net.`.\n\nThe API doesn't search other fields, such as `zoneName`, `region`, the\nrouting policy, or timestamps. For `TLSA`, `HTTPS`, and `SVCB` record\nsets, it searches the `routing.content` text, not the separate fields\nin `routing.rdata`. `SIMPLE_FAILOVER` record sets match on owner name,\nrecord type, and TTL only, not on their endpoints.\n\nSearch works the same way for `PRIMARY` and `SECONDARY` zones.\n\n- You can combine `globalSearch` with `region`, `overrideRecordOnly`,\n  `systemGeneratedStatus`, and the pagination parameters. The API\n  resolves the regional view and the overrides-only filter before it\n  matches the search.\n- You can't combine `globalSearch` with `name`, `ttl`, `content`,\n  `sortBy`, or `sortOrder`. The API returns `400` if you do.\n",
        "examples": {
          "ownerNameWildcard": {
            "value": "www*",
            "summary": "Text followed by a wildcard, such as an owner name that contains `www`."
          },
          "rrtypeSubstring": {
            "value": "CNAME",
            "summary": "`CNAME` record sets, plus any record set with `CNAME` in another\nsearched field, such as its owner name or record data.\n"
          },
          "ttlSubstring": {
            "value": "300",
            "summary": "Record sets with `300` in a searched field, such as a TTL of `300` or `3000`."
          },
          "contentWildcard": {
            "value": "*192.0.2.*",
            "summary": "Record sets whose record data contains `192.0.2.`."
          },
          "structuredRdataSubstring": {
            "value": "3 1 1 aaaa",
            "summary": "A `TLSA` record set with certificate usage 3, selector 1, matching\ntype 1, and certificate data that starts with `aaaa`. The API\nsearches the `routing.content` text, not the fields in\n`routing.rdata`.\n"
          }
        }
      },
      "RecordType": {
        "name": "rrtype",
        "in": "path",
        "required": true,
        "description": "Record type of the record set, such as `A` or `MX`. It must be one of\nthe supported record types, in uppercase.\n",
        "schema": {
          "$ref": "#/components/schemas/RecordType"
        },
        "examples": {
          "aRecord": {
            "value": "A",
            "summary": "An IPv4 address record set."
          },
          "aaaaRecord": {
            "value": "AAAA",
            "summary": "An IPv6 address record set."
          }
        }
      },
      "Name": {
        "name": "name",
        "in": "path",
        "required": true,
        "description": "Owner name, also called host name, of the record set within the zone.\nSupply it relative to the zone, for example `www`, or fully qualified,\nfor example `www.example.com.`. The API converts a relative name to its\nfully qualified form. Use `@` for the zone apex, which the API expands\nto the zone name.\n",
        "schema": {
          "type": "string",
          "minLength": 1
        },
        "examples": {
          "relative": {
            "value": "www",
            "summary": "Owner name relative to the zone"
          },
          "fqdn": {
            "value": "www.example.com.",
            "summary": "Fully qualified owner name"
          },
          "apex": {
            "value": "@",
            "summary": "Zone apex, which resolves to the zone name"
          }
        }
      },
      "Region": {
        "name": "region",
        "in": "path",
        "required": true,
        "schema": {
          "type": "string",
          "enum": [
            "NA_EAST",
            "NA_WEST",
            "SOUTH_AMERICA",
            "EUROPE",
            "ASIA_PAC",
            "OCEANIA",
            "AFRICA"
          ]
        },
        "description": "Geographic region of the regional record set.\n`GLOBAL` is the base zone view and isn't a valid value here. Regional\nrecord sets apply only to named geographic regions. To get the global\nbase view, use the path without a region.\n",
        "example": "EUROPE"
      },
      "TaskId": {
        "name": "taskId",
        "in": "path",
        "required": true,
        "description": "Unique identifier of the asynchronous task to retrieve. This is the\n`id` returned in the body of the originating 202 Accepted response and the\nfinal path segment of its `Location` header.\n",
        "schema": {
          "type": "string",
          "format": "uuid"
        },
        "example": "0d8c8a3c-9c2b-4f2b-bf2a-3a3a8a9c0a11"
      },
      "ReportMonth": {
        "name": "month",
        "in": "path",
        "required": true,
        "description": "Target calendar month in `YYYY-MM` format.\n",
        "schema": {
          "type": "string",
          "pattern": "^[0-9]{4}-(0[1-9]|1[0-2])$"
        },
        "example": "2026-06"
      },
      "pageSize": {
        "name": "pageSize",
        "in": "query",
        "required": false,
        "schema": {
          "type": "integer",
          "minimum": 1,
          "maximum": 100,
          "default": 25
        },
        "description": "The maximum number of items to return in a page, from 1 to 100. The default is 25."
      },
      "TaskStatus": {
        "name": "status",
        "in": "query",
        "required": false,
        "schema": {
          "type": "string",
          "enum": [
            "PENDING",
            "RUNNING",
            "SUCCEEDED",
            "FAILED",
            "CANCELLED"
          ]
        },
        "description": "Not supported yet. If you send it, the API returns `400 Bad Request`, so leave it out to get\ntasks in every status.\n",
        "example": "RUNNING"
      },
      "TaskSortBy": {
        "name": "sortBy",
        "in": "query",
        "required": false,
        "schema": {
          "type": "string",
          "enum": [
            "submittedAt",
            "completedAt"
          ],
          "default": "submittedAt"
        },
        "description": "Field to sort tasks by. The default is `submittedAt`.\n\n- `submittedAt`: When the task was submitted. With the default `sortOrder` of `desc`, the most\n  recently submitted tasks come first.\n- `completedAt`: When the task finished. Tasks that haven't finished sort last when `sortOrder`\n  is `desc`.\n",
        "example": "submittedAt"
      },
      "TaskSortOrder": {
        "name": "sortOrder",
        "in": "query",
        "required": false,
        "schema": {
          "type": "string",
          "enum": [
            "asc",
            "desc"
          ],
          "default": "desc"
        },
        "description": "Sort direction: `asc` for ascending or `desc` for descending. The default is `desc`, which puts\nthe most recent tasks first.\n",
        "example": "desc"
      },
      "InboundNsSetSortBy": {
        "name": "sortBy",
        "in": "query",
        "required": false,
        "schema": {
          "type": "string",
          "enum": [
            "name",
            "zoneCount"
          ],
          "default": "name"
        },
        "description": "Field to sort Inbound IP Sets by. For example, `sortBy=zoneCount&sortOrder=desc`\nlists the sets that the most zones use first.\n\n- `name`: The set's display name. This is the default.\n- `zoneCount`: The number of `SECONDARY` zones that use the set.\n",
        "example": "name"
      },
      "InboundNsSetSortOrder": {
        "name": "sortOrder",
        "in": "query",
        "required": false,
        "schema": {
          "type": "string",
          "enum": [
            "asc",
            "desc"
          ],
          "default": "asc"
        },
        "description": "Sort direction: `asc` for ascending or `desc` for descending. The\ndefault is `asc`.\n",
        "example": "asc"
      },
      "ZoneCount": {
        "name": "zoneCount",
        "in": "query",
        "required": false,
        "style": "deepObject",
        "explode": true,
        "schema": {
          "type": "object",
          "additionalProperties": false,
          "properties": {
            "gte": {
              "type": "integer",
              "minimum": 0,
              "description": "The zone count is at least the given number."
            },
            "lte": {
              "type": "integer",
              "minimum": 0,
              "description": "The zone count is at most the given number."
            },
            "gt": {
              "type": "integer",
              "minimum": 0,
              "description": "The zone count is more than the given number."
            },
            "lt": {
              "type": "integer",
              "minimum": 0,
              "description": "The zone count is less than the given number."
            },
            "eq": {
              "type": "integer",
              "minimum": 0,
              "description": "The zone count equals the given number."
            }
          }
        },
        "description": "Filter by `zoneCount`, the number of zones that use each set or key.\nSend one or more bounds as sub-keys in brackets: `gte`, `lte`, `gt`,\n`lt`, or `eq`. Combine 2 bounds to filter by a range. The filter isn't\napplied to TSIG keys yet.\n\n- `zoneCount[gte]=1` returns the entries that at least 1 zone uses.\n- `zoneCount[lte]=100` returns the entries that at most 100 zones use.\n- `zoneCount[gte]=1&zoneCount[lte]=100` returns the entries that 1 to\n  100 zones use.\n"
      },
      "NameserverSetId": {
        "name": "nameserverSetId",
        "in": "path",
        "required": true,
        "schema": {
          "type": "string",
          "format": "uuid"
        },
        "description": "Server-assigned **UUID** of a Nameserver Set — the immutable, stable\nidentifier for the resource and its URI. (The set's `name` is a mutable,\naccount-unique display label and is **not** used for addressing.) Must\nbelong to the account associated with the authenticated `X-API-Key`\nprincipal; an unknown or cross-account id is rejected with\n`404 Not Found`.\n"
      },
      "OutboundNsSetSortBy": {
        "name": "sortBy",
        "in": "query",
        "required": false,
        "schema": {
          "type": "string",
          "enum": [
            "name",
            "zoneCount"
          ],
          "default": "name"
        },
        "description": "Field to sort Outbound IP Sets by. For example, `sortBy=zoneCount&sortOrder=desc`\nlists the sets that the most zones use first.\n\n- `name`: The set's display name. This is the default.\n- `zoneCount`: The number of `PRIMARY` zones that use the set.\n",
        "example": "name"
      },
      "OutboundNsSetSortOrder": {
        "name": "sortOrder",
        "in": "query",
        "required": false,
        "schema": {
          "type": "string",
          "enum": [
            "asc",
            "desc"
          ],
          "default": "asc"
        },
        "description": "Sort direction: `asc` for ascending or `desc` for descending. The\ndefault is `asc`.\n",
        "example": "asc"
      },
      "OutboundNameserverSetId": {
        "name": "nameserverSetId",
        "in": "path",
        "required": true,
        "schema": {
          "type": "string",
          "format": "uuid"
        },
        "description": "Server-assigned **UUID** of an Outbound IP Set — the immutable,\nstable identifier for the resource and its URI. (The set's `name` is a\nmutable, account-unique display label and is **not** used for\naddressing.) Must belong to the account associated with the\nauthenticated `X-API-Key` principal; an unknown or cross-account id is\nrejected with `404 Not Found`.\n"
      },
      "NsSetSortBy": {
        "name": "sortBy",
        "in": "query",
        "required": false,
        "schema": {
          "type": "string",
          "enum": [
            "name",
            "zoneCount",
            "type"
          ],
          "default": "name"
        },
        "description": "Field to sort Nameserver Sets by. For example, `sortBy=zoneCount&sortOrder=desc`\nlists the sets that the most zones use first.\n\n- `name`: The set's display name. This is the default.\n- `zoneCount`: The number of zones that use the set.\n- `type`: The set's type, `SYSTEM` or `USER_DEFINED`.\n",
        "example": "name"
      },
      "NsSetSortOrder": {
        "name": "sortOrder",
        "in": "query",
        "required": false,
        "schema": {
          "type": "string",
          "enum": [
            "asc",
            "desc"
          ],
          "default": "asc"
        },
        "description": "Sort direction: `asc` for ascending or `desc` for descending. The\ndefault is `asc`.\n",
        "example": "asc"
      },
      "TsigKeySortBy": {
        "name": "sortBy",
        "in": "query",
        "required": false,
        "schema": {
          "type": "string",
          "enum": [
            "name",
            "zoneCount"
          ],
          "default": "name"
        },
        "description": "Field to sort TSIG keys by. For example, `sortBy=zoneCount&sortOrder=desc`\nlists the keys that the most zones use first.\n\n- `name`: The key's display name. This is the default.\n- `zoneCount`: The number of zones that use the key.\n",
        "example": "name"
      },
      "TsigKeySortOrder": {
        "name": "sortOrder",
        "in": "query",
        "required": false,
        "schema": {
          "type": "string",
          "enum": [
            "asc",
            "desc"
          ],
          "default": "asc"
        },
        "description": "Sort direction: `asc` for ascending or `desc` for descending. The\ndefault is `asc`.\n",
        "example": "asc"
      },
      "TsigKeyId": {
        "name": "tsigKeyId",
        "in": "path",
        "required": true,
        "schema": {
          "type": "string",
          "format": "uuid"
        },
        "description": "Server-assigned **UUID** of a TSIG key — the immutable, stable\nidentifier for the resource and its URI. (The key's `name` is a mutable,\naccount-unique display label and is **not** used for addressing.) Must\nbelong to the account associated with the authenticated `X-API-Key`\nprincipal; an unknown or cross-account id is rejected with\n`404 Not Found`.\n"
      },
      "AuditPageSize": {
        "name": "pageSize",
        "in": "query",
        "required": false,
        "schema": {
          "type": "integer",
          "minimum": 1,
          "maximum": 250,
          "default": 50
        },
        "description": "The maximum number of audit records to return in a page, from 1 to 250. The default is\n50. Use a larger page size to export the audit log in fewer requests.\n"
      },
      "AuditUsers": {
        "name": "users",
        "in": "query",
        "required": false,
        "schema": {
          "type": "string"
        },
        "description": "A comma-separated list of usernames to filter by, for example `alice,bob`. The match is\npartial and case-sensitive. The value can't contain a colon (`:`), even URL-encoded. If\nit does, the API returns `400`. When omitted, changes by all users are returned.\n",
        "example": "alice,bob"
      },
      "AuditChangeType": {
        "name": "changeType",
        "in": "query",
        "required": false,
        "schema": {
          "type": "string"
        },
        "description": "The change type to filter by, such as `ADD`, `MODIFY`, or `DELETE`. To see the change\ntypes in your audit log, use `GET /audit/filters`. When omitted, records of every change\ntype are returned.\n",
        "example": "MODIFY"
      },
      "AuditObjectType": {
        "name": "objectType",
        "in": "query",
        "required": false,
        "schema": {
          "type": "string"
        },
        "description": "The type of changed object to filter by, such as `ZONE`, `RRSET`, `USER`, `ACCOUNT`,\n`NAMESERVER_SET`, `TSIG_KEY`, or `ACCOUNT_PREFERENCES`. To see the object types in your\naudit log, use `GET /audit/filters`. When omitted, records for every object type are\nreturned.\n",
        "example": "ZONE"
      },
      "AuditObjectName": {
        "name": "objectName",
        "in": "query",
        "required": false,
        "schema": {
          "type": "string"
        },
        "description": "The name of the changed object to filter by, such as a zone name. The match is partial\nand case-sensitive. URL-encode special characters. The value can't contain a colon\n(`:`), even URL-encoded. If it does, the API returns `400`. When omitted, records for\nobjects of any name are returned.\n",
        "example": "example.com."
      },
      "AuditParentName": {
        "name": "parentName",
        "in": "query",
        "required": false,
        "schema": {
          "type": "string"
        },
        "description": "The name of the changed object's parent to filter by, for example the zone name when\n`objectType` is `RRSET`. The match is partial and case-sensitive. The value can't\ncontain a colon (`:`), even URL-encoded. If it does, the API returns `400`. When\nomitted, records with any parent name are returned.\n",
        "example": "example.com."
      },
      "AuditDateRange": {
        "name": "dateRange",
        "in": "query",
        "required": false,
        "schema": {
          "type": "string",
          "pattern": "^([0-9]+(m|h|d|w)|1month)$",
          "default": "24h"
        },
        "description": "A relative date range for the audit log. If you also send both `dateFrom` and `dateTo`,\nthe API uses them and ignores `dateRange`.\n\nSend a number followed by a unit, or `1month`:\n\n- `m`: Minutes, for example `15m`.\n- `h`: Hours, for example `5h`. The default is `24h`.\n- `d`: Days, for example `30d`.\n- `w`: Weeks, for example `5w`.\n- `1month`: The last full calendar month.\n",
        "example": "24h"
      },
      "AuditDateFrom": {
        "name": "dateFrom",
        "in": "query",
        "required": false,
        "schema": {
          "type": "string",
          "pattern": "^[0-9]{14}$"
        },
        "description": "The start of an absolute date range, in UTC, formatted as `yyyyMMddHHmmss`. For example,\n`20260601000000`. Send it with `dateTo`. If you send both, the API uses them and ignores\n`dateRange`. If you send `dateFrom` without `dateTo`, the API ignores it.\n",
        "example": "20260601000000"
      },
      "AuditDateTo": {
        "name": "dateTo",
        "in": "query",
        "required": false,
        "schema": {
          "type": "string",
          "pattern": "^[0-9]{14}$"
        },
        "description": "The end of an absolute date range, in UTC, formatted as `yyyyMMddHHmmss`. For example,\n`20260616235959`. Send it with `dateFrom`. If you send both, the API uses them and ignores\n`dateRange`. If you send `dateTo` without `dateFrom`, the API ignores it.\n\nIf `dateTo` is midnight, such as `20260616000000`, or equals `dateFrom`, the API moves\nit to 23:59:59 on the same date so that the range includes the whole day.\n",
        "example": "20260616235959"
      },
      "AuditReason": {
        "name": "reason",
        "in": "query",
        "required": false,
        "schema": {
          "type": "string"
        },
        "description": "Text to search for in the comments recorded with changes. The match is partial and\ncase-sensitive. URL-encode special characters, for example a space as `%20` and `@` as\n`%40`. The value can't contain a colon (`:`), even URL-encoded. If it does, the API\nreturns `400`.\n",
        "example": "migration"
      },
      "AuditSortOrder": {
        "name": "sortOrder",
        "in": "query",
        "required": false,
        "schema": {
          "type": "string",
          "enum": [
            "asc",
            "desc"
          ],
          "default": "desc"
        },
        "description": "The sort direction for audit records, by `changedAt`.\n\n- `desc`: The newest changes come first. This is the default.\n- `asc`: The oldest changes come first.\n",
        "example": "desc"
      },
      "AuditFiltersDateFrom": {
        "name": "dateFrom",
        "in": "query",
        "required": false,
        "schema": {
          "type": "string",
          "format": "date-time"
        },
        "description": "The start of the date range to list filter values for, as an RFC 3339 timestamp. The\ndefault is 24 hours before the request.\n",
        "example": "2026-06-15T00:00:00Z"
      },
      "AuditFiltersDateTo": {
        "name": "dateTo",
        "in": "query",
        "required": false,
        "schema": {
          "type": "string",
          "format": "date-time"
        },
        "description": "The end of the date range to list filter values for, as an RFC 3339 timestamp. The\ndefault is the time of the request.\n\nIf `dateTo` is midnight or equals the start of the range, the API moves it to 23:59:59\non the same date, in the UTC offset of `dateTo`, so that the range includes the whole\nday.\n",
        "example": "2026-06-16T00:00:00Z"
      },
      "ZoneSnapshotName": {
        "name": "name",
        "in": "query",
        "required": false,
        "schema": {
          "type": "string",
          "minLength": 1,
          "maxLength": 255
        },
        "description": "Filter snapshots by name. A snapshot matches when its `name` contains the text you send,\nignoring case. For example, `name=pre` matches a snapshot named `pre-migration`.\n",
        "example": "pre-migration"
      },
      "ZoneSnapshotSortBy": {
        "name": "sortBy",
        "in": "query",
        "required": false,
        "schema": {
          "type": "string",
          "enum": [
            "name",
            "createdAt"
          ]
        },
        "description": "The `sortBy` parameter selects the field used to sort snapshots. If you omit `sortBy`, the API\nsorts by `createdAt`.\n\n- `name`: The snapshot's name. A snapshot without a name sorts as an empty string, so it comes\n  first when `sortOrder` is `asc` and last when it's `desc`.\n- `createdAt`: When the snapshot was taken.\n",
        "example": "createdAt"
      },
      "ZoneSnapshotSortOrder": {
        "name": "sortOrder",
        "in": "query",
        "required": false,
        "schema": {
          "type": "string",
          "enum": [
            "asc",
            "desc"
          ]
        },
        "description": "The API sorts results in ascending order (`asc`) or descending order (`desc`). If you omit both\n`sortBy` and `sortOrder`, the API lists snapshots newest first. If you send `sortBy` without\n`sortOrder`, the API sorts in ascending order. If you send only `sortOrder`, the API sorts by\n`createdAt` in that direction.\n",
        "example": "desc"
      },
      "SnapshotId": {
        "name": "snapshotId",
        "in": "path",
        "required": true,
        "schema": {
          "type": "string",
          "format": "uuid"
        },
        "description": "Server-generated UUID that uniquely identifies a zone snapshot within\nthe authenticated account.\n",
        "examples": {
          "example": {
            "value": "c3e0a2d5-8f4b-4d9c-a032-1b6f7e8d9c40",
            "summary": "A snapshot UUID."
          }
        }
      },
      "BatchAsync": {
        "name": "async",
        "in": "query",
        "required": false,
        "schema": {
          "type": "boolean",
          "default": true
        },
        "description": "Whether to run the batch request as a task. The default is `true`.\n\n- `true`: The API returns `202 Accepted` and runs the sub-requests as a task. To check its\n  status, poll the URI in the `Location` header.\n- `false`: The API runs the sub-requests before it responds, then returns `200 OK` with a\n  result for each sub-request.\n\nEither way, a batch is all or nothing: if a sub-request fails, the API keeps none of the\nbatch's changes. `onFailure` isn't applied yet.\n",
        "example": true
      },
      "OnFailure": {
        "name": "onFailure",
        "in": "query",
        "required": false,
        "schema": {
          "type": "string",
          "enum": [
            "CONTINUE",
            "STOP"
          ],
          "default": "CONTINUE"
        },
        "description": "What the API does when a sub-request fails. It isn't applied yet. Whatever you send, and when\nyou leave it out, a batch is all or nothing, as with `STOP`. The declared default, `CONTINUE`,\nisn't applied either.\n\n- `CONTINUE`: Run the remaining sub-requests after a failure, and keep the changes that\n  succeeded.\n- `STOP`: Stop at the first sub-request that fails, and keep none of the batch's changes.\n",
        "example": "STOP"
      },
      "IntegrationName": {
        "name": "name",
        "in": "path",
        "required": true,
        "description": "Integration identifier. Supported values are `CERTCENTRAL` and `VALIMAIL-MONITOR`.\n",
        "schema": {
          "type": "string",
          "enum": [
            "CERTCENTRAL",
            "VALIMAIL-MONITOR"
          ]
        },
        "examples": {
          "certCentral": {
            "value": "CERTCENTRAL",
            "summary": "The CertCentral DCV integration."
          },
          "valimailMonitor": {
            "value": "VALIMAIL-MONITOR",
            "summary": "The Valimail Monitor integration."
          }
        }
      }
    },
    "schemas": {
      "ZoneTransferStatus": {
        "type": "string",
        "enum": [
          "PENDING",
          "IN_PROGRESS",
          "SUCCEEDED",
          "FAILED",
          "NOT_REQUESTED"
        ],
        "description": "Most recent transfer execution status.",
        "example": "FAILED"
      },
      "DomainName": {
        "type": "string",
        "minLength": 1,
        "maxLength": 253,
        "pattern": "^(?=.{1,253}$)(?!.*\\.\\.)(?:[A-Za-z0-9_/-]{1,63}\\.)+[A-Za-z0-9-]{2,63}\\.?$",
        "description": "A fully qualified domain name with at least two labels. Each label is 1–63 characters, and the\nlast label is at least 2 characters of letters, digits, or hyphens. The whole name is at most\n253 characters, including the trailing dot if you send one. The trailing dot is optional on\ninput.\n\nPunycode labels, underscore-prefixed labels, and reverse lookup zones are accepted. That\nincludes RFC 2317 classless `in-addr.arpa` delegation, whose labels can contain `/`.\n",
        "examples": [
          "example.com",
          "example.com.",
          "1.168.192.in-addr.arpa",
          "0/1.70.78.208.in-addr.arpa",
          "xn--nxasmq6b.xn--wgbh1c"
        ]
      },
      "ZoneType": {
        "type": "string",
        "enum": [
          "PRIMARY",
          "SECONDARY"
        ],
        "description": "The zone type:\n\n- `PRIMARY`: you manage the zone's records in DigiCert DNS.\n- `SECONDARY`: the zone copies its records from an upstream primary\n  nameserver by zone transfer (AXFR).\n",
        "example": "PRIMARY"
      },
      "ZoneAdvancedConfig": {
        "type": "object",
        "description": "Primary-zone advanced configuration and integration status.\n",
        "properties": {
          "isCertCentralEnabled": {
            "type": "boolean",
            "description": "Whether CertCentral integration is enabled."
          },
          "isValimailEnabled": {
            "type": "boolean",
            "description": "Whether Valimail integration is enabled."
          },
          "isRegionalViewEnabled": {
            "type": "boolean",
            "description": "Whether regional views are enabled for this zone. When `true`, all\nrecord sets become `GLOBAL` and may have per-region overrides via\nthe `/regions/{region}` sub-resource. Record responses include a\n`region` field. PRIMARY zones only.\n"
          }
        }
      },
      "OutboundIpSetBinding": {
        "type": "object",
        "description": "A single outbound-transfer binding for a PRIMARY zone: the account-level\nOutbound IP Set (`transferAllowedIPs` / `notifyDestinations`) used for\noutbound zone transfer, plus the optional TSIG key that signs transfers\nauthorized by that set.\n",
        "required": [
          "outboundIpSetName"
        ],
        "properties": {
          "outboundIpSetName": {
            "type": "string",
            "minLength": 1,
            "maxLength": 255,
            "description": "Display name of the account-level Outbound IP Set\n(`/dns-settings/outbound/nameserver-sets`). Must match an existing\nset name in the authenticated account.\n",
            "examples": [
              "secondary-provider-a"
            ]
          },
          "tsigKeyName": {
            "type": [
              "string",
              "null"
            ],
            "description": "Display name of the account-level TSIG key (`/dns-settings/tsig-keys`)\nused to sign transfers authorized by `outboundIpSetName`. `null` (or\nomitted) when this binding has no TSIG key.\n",
            "examples": [
              "outbound-tsig"
            ]
          }
        }
      },
      "PrimaryZoneDetails": {
        "type": "object",
        "description": "Primary-zone outbound binding snapshot. Present when `type` is `PRIMARY`.\nReturns the display names of the account-level Nameserver Set and the\nOutbound IP Set + TSIG key pairs currently bound to the zone.\n",
        "properties": {
          "nameserverSetName": {
            "type": [
              "string",
              "null"
            ],
            "readOnly": true,
            "description": "Display name of the bound Nameserver Set, or `null` when none is bound."
          },
          "outboundIps": {
            "type": "array",
            "readOnly": true,
            "maxItems": 3,
            "items": {
              "$ref": "#/components/schemas/OutboundIpSetBinding"
            },
            "description": "Outbound IP Set + TSIG key bindings currently bound to the zone\n(up to 3), or an empty array when none are bound.\n"
          }
        }
      },
      "ZoneTransferDetails": {
        "type": "object",
        "description": "The state of a `SECONDARY` zone's transfers from its upstream primary\nservers.\n",
        "properties": {
          "lastTransferStatus": {
            "$ref": "#/components/schemas/ZoneTransferStatus"
          },
          "lastTransferAt": {
            "type": [
              "string",
              "null"
            ],
            "format": "date-time",
            "description": "Timestamp of the most recent completed transfer."
          },
          "nextTransferAt": {
            "type": [
              "string",
              "null"
            ],
            "format": "date-time",
            "description": "Timestamp of the next scheduled transfer, when known."
          },
          "lastTransferStatusMessage": {
            "type": [
              "string",
              "null"
            ],
            "description": "Human-readable detail about the most recent transfer status, such\nas a failure reason or a progress note.\n"
          }
        }
      },
      "SecondaryZoneDetails": {
        "type": "object",
        "description": "Secondary DNS binding snapshot. Present when `type` is `SECONDARY`.\nReturns the display names of the account-level Inbound IP Set and\noptional TSIG key bound to the zone. Names are mutable; use\n`GET /dns-settings/inbound/nameserver-sets` to resolve the authoritative\nset by name.\n",
        "required": [
          "inboundIpSetName"
        ],
        "properties": {
          "inboundIpSetName": {
            "type": "string",
            "readOnly": true,
            "description": "Display name of the bound Inbound IP Set."
          },
          "tsigKeyName": {
            "type": [
              "string",
              "null"
            ],
            "readOnly": true,
            "description": "Display name of the bound TSIG key, or `null` when none is bound."
          }
        }
      },
      "ZoneSummary": {
        "type": "object",
        "description": "A zone, as returned in the list from `GET /zones`. It has the same\nfields as `GET /zones/{zoneName}`.\n",
        "required": [
          "name",
          "type",
          "status",
          "recordCount",
          "createdAt"
        ],
        "properties": {
          "name": {
            "$ref": "#/components/schemas/DomainName",
            "description": "Fully qualified domain name of the zone, for example `example.com.`.\nIt's the zone's identifier and the `zoneName` path parameter for\nevery single-zone request. The trailing dot is optional on input.\n",
            "examples": [
              "example.com."
            ]
          },
          "type": {
            "$ref": "#/components/schemas/ZoneType"
          },
          "status": {
            "type": "string",
            "enum": [
              "ACTIVE",
              "DISABLED",
              "SUSPENDED"
            ],
            "description": "Current operational status of the zone.\n\n- `ACTIVE`: The authoritative nameservers serve the zone.\n- `DISABLED`: The zone exists but isn't served. The account owner\n  disabled it through the API.\n- `SUSPENDED`: The zone is suspended, for example for billing or\n  policy reasons.\n"
          },
          "isDnssecEnabled": {
            "type": "boolean",
            "default": false,
            "description": "Whether DNSSEC signing is currently enabled for the zone."
          },
          "advancedConfig": {
            "description": "The zone's integration settings. Present when `type` is `PRIMARY`.\n",
            "$ref": "#/components/schemas/ZoneAdvancedConfig"
          },
          "primary": {
            "description": "The zone's Nameserver Set, Outbound IP Sets, and TSIG keys. Present\nwhen `type` is `PRIMARY`.\n",
            "$ref": "#/components/schemas/PrimaryZoneDetails"
          },
          "transferDetails": {
            "description": "The state of the zone's transfers from its upstream primary\nservers. Present when `type` is `SECONDARY`.\n",
            "$ref": "#/components/schemas/ZoneTransferDetails"
          },
          "secondary": {
            "description": "The zone's Inbound IP Set and optional TSIG key. Present when `type`\nis `SECONDARY`.\n",
            "$ref": "#/components/schemas/SecondaryZoneDetails"
          },
          "recordCount": {
            "type": "integer",
            "format": "int64",
            "minimum": 0,
            "description": "Number of DNS records currently in the zone."
          },
          "createdAt": {
            "type": "string",
            "format": "date-time",
            "readOnly": true,
            "description": "When the zone was created, as an RFC 3339 timestamp.",
            "example": "2026-06-05T14:00:00Z"
          },
          "updatedAt": {
            "type": "string",
            "format": "date-time",
            "readOnly": true,
            "description": "When the zone was last changed, as an RFC 3339 timestamp.",
            "example": "2026-06-05T14:00:00Z"
          }
        },
        "allOf": [
          {
            "if": {
              "properties": {
                "type": {
                  "const": "PRIMARY"
                }
              },
              "required": [
                "type"
              ]
            },
            "then": {
              "required": [
                "advancedConfig"
              ]
            }
          },
          {
            "if": {
              "properties": {
                "type": {
                  "const": "SECONDARY"
                }
              },
              "required": [
                "type"
              ]
            },
            "then": {
              "required": [
                "transferDetails"
              ]
            }
          }
        ]
      },
      "ZoneStats": {
        "type": "object",
        "description": "Aggregate counts for zones matching the current list request filters.\nCounts are computed over the full filtered result set, not just the\ncurrent page.\n",
        "required": [
          "total",
          "primary",
          "secondary",
          "dnssec"
        ],
        "properties": {
          "total": {
            "type": "integer",
            "format": "int64",
            "minimum": 0,
            "description": "Total number of zones matching the current filters."
          },
          "primary": {
            "type": "integer",
            "format": "int64",
            "minimum": 0,
            "description": "Number of matching zones with `type = PRIMARY`."
          },
          "secondary": {
            "type": "integer",
            "format": "int64",
            "minimum": 0,
            "description": "Number of matching zones with `type = SECONDARY`."
          },
          "dnssec": {
            "type": "integer",
            "format": "int64",
            "minimum": 0,
            "description": "Number of matching zones where DNSSEC is enabled."
          }
        }
      },
      "Pagination": {
        "type": "object",
        "description": "The pagination details that every list operation returns.\n\nTest `hasMore` to decide whether to fetch another page. It's the only field to test, and it's\nreliable on every list operation.\n\nOn a **cursor-based** operation, `nextPageToken` is set whenever `hasMore` is `true`. Send it\nas the `pageToken` query parameter on the next request. When `prevPageToken`,\n`firstPageToken`, and `lastPageToken` are present, they're cursors for moving back or jumping\nto the first or last page.\n\nOn an **offset-based** operation, `nextPageToken` is always `null`, and the other cursors\naren't returned. Use `offset` to move between pages. A response with `hasMore: true` and\n`nextPageToken: null` is normal on these operations.\n",
        "required": [
          "nextPageToken",
          "hasMore"
        ],
        "properties": {
          "nextPageToken": {
            "type": [
              "string",
              "null"
            ],
            "description": "An opaque cursor for the next page. On a cursor-based operation, it's set only when\n`hasMore` is `true`. On an offset-based operation, it's always `null`. Use it to fetch the\nnext page, and test `hasMore` to decide whether there is one.\n"
          },
          "prevPageToken": {
            "type": [
              "string",
              "null"
            ],
            "description": "An opaque cursor for the previous page. It's `null` on the first page, or when the\noperation doesn't support moving back.\n"
          },
          "firstPageToken": {
            "type": [
              "string",
              "null"
            ],
            "description": "An opaque cursor for the first page. Sending it usually has the same effect as omitting\n`pageToken`.\n"
          },
          "lastPageToken": {
            "type": [
              "string",
              "null"
            ],
            "description": "An opaque cursor for the last page. It's `null` when there are no results, or when the\noperation doesn't support jumping to the last page. If the data changes after the cursor\nis issued, the API still returns a valid page, which can contain fewer than `pageSize`\nitems.\n"
          },
          "hasMore": {
            "type": "boolean",
            "description": "`true` when more results exist after the current page. Test it to decide whether to fetch the next page."
          }
        }
      },
      "ZoneList": {
        "type": "object",
        "description": "Paginated list of zones.\n`stats` is included when `includeStats=true` on the list request.\n",
        "required": [
          "data",
          "pagination"
        ],
        "properties": {
          "data": {
            "type": "array",
            "items": {
              "$ref": "#/components/schemas/ZoneSummary"
            }
          },
          "stats": {
            "$ref": "#/components/schemas/ZoneStats"
          },
          "pagination": {
            "$ref": "#/components/schemas/Pagination"
          }
        }
      },
      "ProblemDetail": {
        "type": "object",
        "description": "An error response in the Problem Details format that RFC 9457 defines.",
        "required": [
          "type",
          "title",
          "status",
          "code"
        ],
        "properties": {
          "type": {
            "type": "string",
            "format": "uri",
            "description": "A URI that identifies the type of problem.",
            "examples": [
              "https://errors.dns.digicert.com/bad-request"
            ]
          },
          "title": {
            "type": "string",
            "description": "A short, readable summary of the problem.",
            "examples": [
              "Validation Error"
            ]
          },
          "status": {
            "type": "integer",
            "description": "The HTTP status code.",
            "examples": [
              400
            ]
          },
          "detail": {
            "type": "string",
            "description": "A readable explanation of the specific error. When the error comes from the DNS provider,\nit's the provider's message, which can start with a numeric provider code, for example\n`[53001] Invalid zone type`. Several provider messages are joined with `; `.\n",
            "examples": [
              "[53001] Invalid zone type",
              "The 'name' field mustn't be empty."
            ]
          },
          "code": {
            "type": "string",
            "description": "A stable, machine-readable code for the error category. It never changes for a given\ncategory, so you can build automation on it. It's different from `errors[].code`, which\nclassifies a single field error.\n\nThe codes depend on the operation. The two examples are what zone and record operations\nand user and role operations return for the same `400` error. Don't assume that every\noperation returns every code.\n",
            "examples": [
              "VALIDATION_FAILED",
              "VALIDATION_ERROR"
            ]
          },
          "instance": {
            "type": "string",
            "format": "uri",
            "description": "A URI that identifies this occurrence of the problem."
          },
          "errors": {
            "type": "array",
            "maxItems": 100,
            "description": "The field-level validation errors. They're present when a request body or a batch fails\nvalidation, and absent when the error comes from the DNS provider. The list holds at most\n100 entries. If there are more, the list stops at 100 and `detail` says so.\n",
            "items": {
              "type": "object",
              "required": [
                "message"
              ],
              "properties": {
                "field": {
                  "type": "string",
                  "description": "The path of the field within the request or sub-request."
                },
                "message": {
                  "type": "string",
                  "description": "A readable message about the field error."
                },
                "code": {
                  "type": "string",
                  "description": "A machine-readable code for the field error, such as `REQUIRED`, `INVALID_FORMAT`, `INVALID_VALUE`, or `OUT_OF_RANGE`. It's different from the top-level `code`.\n"
                },
                "index": {
                  "type": "integer",
                  "minimum": 0,
                  "description": "The zero-based position of the sub-request in a batch. It's present only in batch responses."
                }
              }
            }
          }
        }
      },
      "CreateZoneRequestBase": {
        "type": "object",
        "required": [
          "type",
          "zoneName"
        ],
        "properties": {
          "type": {
            "type": "string",
            "description": "The zone type, which decides which other fields apply:\n\n- `PRIMARY`: you manage the zone's records in DigiCert DNS.\n- `SECONDARY`: the zone copies its records from an upstream primary\n  nameserver by zone transfer (AXFR).\n",
            "example": "PRIMARY"
          },
          "zoneName": {
            "$ref": "#/components/schemas/DomainName",
            "description": "The fully qualified domain name of the zone to create. A trailing dot\nis optional.\n",
            "examples": [
              "example.com"
            ]
          },
          "status": {
            "type": "string",
            "enum": [
              "ACTIVE",
              "DISABLED"
            ],
            "default": "ACTIVE",
            "description": "The zone's status when it's created:\n\n- `ACTIVE` (default): DigiCert DNS serves the zone.\n- `DISABLED`: the zone is created but not served.\n"
          },
          "reason": {
            "type": "string",
            "maxLength": 512,
            "description": "A comment to record in the audit log."
          }
        }
      },
      "AdvancedConfig": {
        "type": "object",
        "description": "Optional integration and regional view settings for the zone.\n",
        "properties": {
          "isCertCentralEnabled": {
            "type": "boolean",
            "description": "Enable DigiCert CertCentral integration for this zone."
          },
          "isValimailEnabled": {
            "type": "boolean",
            "description": "Enable Valimail Monitor DMARC integration. Only valid for\n`PRIMARY` zones, including those created via the asynchronous\n`EXISTING_ZONE` copy flow.\n"
          },
          "isRegionalViewEnabled": {
            "type": "boolean",
            "description": "Enable regional views for this zone. When `true`, all record sets\nbecome `GLOBAL` and may have per-region overrides via the\n`/regions/{region}` sub-resource. `PRIMARY` zones only.\n"
          }
        }
      },
      "PrimaryZoneBinding": {
        "type": "object",
        "description": "The account-level Nameserver Set and up to 3 pairs of Outbound IP Set and\nTSIG key for a `PRIMARY` zone. The Outbound IP Sets list the addresses\nthat can request a zone transfer, and the addresses that receive `NOTIFY`\nmessages when the zone changes so that downstream secondary providers\ncan transfer it.\n\nEvery field is optional in the schema, so you can set some bindings and\nnot others. `createZone` requires `nameserverSetName` for some import\nmethods. On `PATCH`, omit a field to keep its current binding, or set\n`outboundIps` to `[]` to remove every Outbound IP Set.\n",
        "properties": {
          "nameserverSetName": {
            "type": [
              "string",
              "null"
            ],
            "description": "The display name of an existing Nameserver Set in your account, from\n`/dns-settings/nameserver-sets`.\n",
            "examples": [
              "prod-ns"
            ]
          },
          "outboundIps": {
            "type": "array",
            "maxItems": 3,
            "items": {
              "$ref": "#/components/schemas/OutboundIpSetBinding"
            },
            "description": "Up to 3 pairs of Outbound IP Set and TSIG key for transferring the\nzone out. Each `outboundIpSetName` must name an existing Outbound IP\nSet in your account and can appear only once in the list.\n\nOn `PATCH`, the list **replaces** the zone's current list. Entries\naren't merged. For example, sending `[C]` for a zone bound to `[A, B]`\nleaves `[C]`, not `[A, B, C]`. Omit `outboundIps` to keep the current\nlist, or send `[]` to remove every Outbound IP Set.\n",
            "examples": [
              [
                {
                  "outboundIpSetName": "secondary-provider-a",
                  "tsigKeyName": "outbound-tsig"
                }
              ]
            ]
          }
        }
      },
      "RecordImportNone": {
        "type": "object",
        "title": "RecordImportNone",
        "description": "Create an empty zone with no imported records.",
        "required": [
          "method"
        ],
        "properties": {
          "method": {
            "type": "string"
          },
          "isImportFromParent": {
            "type": "boolean",
            "default": false,
            "description": "Whether to import records from parent zones in your account into the\nnew zone. Applies only to `POST /zones` when `type` is `PRIMARY` and\n`recordImport.method` is `NONE`.\n\n- `true`: Import records from parent zones.\n- `false`: Create an empty zone. This is the default.\n"
          }
        }
      },
      "NameserverEntry": {
        "type": "object",
        "additionalProperties": false,
        "description": "An upstream nameserver for a one-time AXFR import into a primary zone,\nused by `AxfrImport` when `recordImport.method` is `AXFR`. It has a\n`host` and an optional `tsigKeyId`.\n\nA `NameserverSet` doesn't use it. Set entries use `NameserverSetEntry`,\nwhich has a host only. For secondary zones, TSIG is set at the zone\nlevel in `secondary.tsigKeyName`, as one key shared by all upstream\nservers and referenced by display name.\n\nThe TSIG key is referenced by ID in `tsigKeyId`. Inline TSIG keys\naren't accepted, so zone-create requests never expose secret key\nmaterial.\n",
        "required": [
          "host"
        ],
        "properties": {
          "host": {
            "type": "string",
            "minLength": 1,
            "description": "Hostname, IPv4, or IPv6 address of the upstream nameserver.\n",
            "examples": [
              "ns1.upstream.net",
              "192.0.2.10"
            ]
          },
          "tsigKeyId": {
            "type": "string",
            "format": "uuid",
            "description": "ID of the account-level TSIG key, from\n`/dns-settings/tsig-keys/{tsigKeyId}`, that authenticates AXFR and\nIXFR transfers with the nameserver. Omit it if the upstream server\ndoesn't require TSIG.\n"
          }
        }
      },
      "AxfrImport": {
        "type": "object",
        "description": "The upstream server for a **one-time AXFR import into a new primary\nzone**, used when `recordImport.method` is `AXFR`. It has the same\nshape as `NameserverEntry`: a `host` and an optional `tsigKeyId`.\nThe import contacts exactly one upstream server once, so Nameserver\nSets aren't used here. They apply only to inbound transfers for\nsecondary zones. See `SecondaryZoneConfig`.\n",
        "allOf": [
          {
            "$ref": "#/components/schemas/NameserverEntry"
          }
        ]
      },
      "RecordImportAxfr": {
        "type": "object",
        "title": "RecordImportAxfr",
        "description": "Bootstrap via AXFR zone transfer from an upstream nameserver.",
        "required": [
          "method",
          "axfr"
        ],
        "properties": {
          "method": {
            "type": "string"
          },
          "axfr": {
            "$ref": "#/components/schemas/AxfrImport"
          }
        }
      },
      "ExistingZoneImport": {
        "type": "object",
        "description": "Reference to a zone already on the platform whose records and configuration\nshould be cloned into the new zone. The source zone is identified by its\nFQDN via `zoneName`.\n\nConfiguration values are copied from the source zone by default. Any fields\nexplicitly provided in the `primary` configuration of the create request\ntake precedence over the copied values; fields not specified in the request\nfall back to the source zone's values.\n",
        "properties": {
          "zoneName": {
            "$ref": "#/components/schemas/DomainName",
            "description": "FQDN of the source zone to copy records and configuration from. Required.\n"
          }
        },
        "required": [
          "zoneName"
        ],
        "examples": [
          {
            "zoneName": "template.example.com."
          }
        ]
      },
      "RecordImportExistingZone": {
        "type": "object",
        "title": "RecordImportExistingZone",
        "description": "Copy records from an existing zone already on the platform.\n\nSubmitting this variant triggers an **asynchronous** import:\n`POST /zones` returns `202 Accepted` with an `AsyncTask` body\nand a `Location` header pointing at the operation resource to poll.\nLarge source zones can take longer than a typical synchronous request\nbudget to copy, which is why this method is never processed\nsynchronously.\n",
        "required": [
          "method",
          "existingZone"
        ],
        "properties": {
          "method": {
            "type": "string"
          },
          "existingZone": {
            "$ref": "#/components/schemas/ExistingZoneImport"
          }
        }
      },
      "RecordImportZoneFile": {
        "type": "object",
        "title": "RecordImportZoneFile",
        "description": "Import records from a BIND zone file using multipart form upload.\nWhen `method = ZONE_FILE`, the file content is supplied in\n`POST /zones` as `multipart/form-data` in the top-level `file` part,\nnot inside the JSON payload.\n",
        "required": [
          "method"
        ],
        "properties": {
          "method": {
            "type": "string"
          }
        }
      },
      "RecordImport": {
        "description": "Discriminated record-import descriptor. The `method` field selects\nthe import strategy:\n- NONE: No import (zone created empty; `POST /zones` returns 201)\n- AXFR: Import via DNS zone transfer (asynchronous; `POST /zones`\n  returns 202 + AsyncTask)\n- EXISTING_ZONE: Copy from another zone on the platform\n  (asynchronous; `POST /zones` returns 202 + AsyncTask).\n  Copying large source zones can exceed a typical synchronous\n  request budget, so this method is always processed asynchronously.\n- ZONE_FILE: Import from a BIND zone file via multipart upload\n  (asynchronous; `POST /zones` returns 202 + AsyncTask).\n  Send the request as `multipart/form-data` with the BIND zone file\n  as the binary `file` part.\n\nOnly fields required by the selected `method` variant are required.\n",
        "type": "object",
        "properties": {
          "method": {
            "type": "string"
          }
        },
        "discriminator": {
          "propertyName": "method",
          "mapping": {
            "NONE": "#/components/schemas/RecordImportNone",
            "AXFR": "#/components/schemas/RecordImportAxfr",
            "EXISTING_ZONE": "#/components/schemas/RecordImportExistingZone",
            "ZONE_FILE": "#/components/schemas/RecordImportZoneFile"
          }
        },
        "oneOf": [
          {
            "$ref": "#/components/schemas/RecordImportNone"
          },
          {
            "$ref": "#/components/schemas/RecordImportAxfr"
          },
          {
            "$ref": "#/components/schemas/RecordImportExistingZone"
          },
          {
            "$ref": "#/components/schemas/RecordImportZoneFile"
          }
        ]
      },
      "PrimaryZoneConfig": {
        "type": "object",
        "description": "Primary-zone configuration supplied at create time. Combines the optional\noutbound binding (Nameserver Set, Outbound IP Set, TSIG key) with\nthe initial record-import instructions.\n",
        "allOf": [
          {
            "$ref": "#/components/schemas/PrimaryZoneBinding"
          },
          {
            "type": "object",
            "properties": {
              "recordImport": {
                "$ref": "#/components/schemas/RecordImport"
              }
            }
          }
        ]
      },
      "CreatePrimaryZoneRequest": {
        "description": "Primary-zone variant of `CreateZoneRequest`.",
        "unevaluatedProperties": false,
        "allOf": [
          {
            "$ref": "#/components/schemas/CreateZoneRequestBase"
          },
          {
            "type": "object",
            "required": [
              "primary"
            ],
            "properties": {
              "advancedConfig": {
                "$ref": "#/components/schemas/AdvancedConfig"
              },
              "primary": {
                "$ref": "#/components/schemas/PrimaryZoneConfig"
              }
            }
          }
        ]
      },
      "SecondaryZoneConfig": {
        "type": "object",
        "description": "Secondary-zone configuration. Identifies the account-level Inbound\nIP Set that provides the upstream `primaryNameservers`\nused for inbound AXFR/IXFR. Manage sets via\n`/dns-settings/inbound/nameserver-sets`.\n\nTSIG authentication is applied at the **zone level** as a single\noptional key shared across all upstreams in the set. Set `tsigKeyName`\nto bind a TSIG key by display name; set it to `null` to detach; omit\nit to leave the current binding unchanged (PATCH semantics).\n",
        "required": [
          "inboundIpSetName"
        ],
        "properties": {
          "inboundIpSetName": {
            "type": "string",
            "description": "Display name of the account-level Inbound IP Set\n(`/dns-settings/inbound/nameserver-sets`) defining the upstream NS\ntopology for this secondary zone. Must match an existing set name\nin the authenticated account.\n"
          },
          "tsigKeyName": {
            "type": [
              "string",
              "null"
            ],
            "description": "Display name of the account-level TSIG key\n(`/dns-settings/tsig-keys`) applied as a single shared key to all\nupstreams in the bound Inbound IP Set. Omit to leave the current\nbinding unchanged (PATCH semantics); set to `null` to detach TSIG\nfrom the zone entirely.\n"
          }
        }
      },
      "CreateSecondaryZoneRequest": {
        "description": "Secondary-zone variant of `CreateZoneRequest`.",
        "unevaluatedProperties": false,
        "allOf": [
          {
            "$ref": "#/components/schemas/CreateZoneRequestBase"
          },
          {
            "type": "object",
            "required": [
              "secondary"
            ],
            "properties": {
              "secondary": {
                "$ref": "#/components/schemas/SecondaryZoneConfig"
              }
            }
          }
        ]
      },
      "CreateZoneRequest": {
        "description": "Discriminated request body for creating a zone. The `type` field\nselects the variant:\n- When `type = PRIMARY`: only `primary` and `advancedConfig` are valid\n- When `type = SECONDARY`: only `secondary` is valid\nRequests with invalid field combinations are rejected at validation time.\n",
        "type": "object",
        "discriminator": {
          "propertyName": "type",
          "mapping": {
            "PRIMARY": "#/components/schemas/CreatePrimaryZoneRequest",
            "SECONDARY": "#/components/schemas/CreateSecondaryZoneRequest"
          }
        },
        "oneOf": [
          {
            "$ref": "#/components/schemas/CreatePrimaryZoneRequest"
          },
          {
            "$ref": "#/components/schemas/CreateSecondaryZoneRequest"
          }
        ]
      },
      "Zone": {
        "type": "object",
        "description": "A DNS zone. Each zone's fully qualified `name` is unique within your\naccount. The owning account comes from the authenticated `X-API-Key`\nand isn't shown in the path or response body.\n",
        "required": [
          "name",
          "type",
          "status",
          "createdAt"
        ],
        "properties": {
          "name": {
            "$ref": "#/components/schemas/DomainName",
            "description": "Fully qualified domain name of the zone, for example `example.com.`.\nIt's the zone's identifier and the `zoneName` path parameter for\nevery single-zone request. The trailing dot is optional on input.\n",
            "examples": [
              "example.com."
            ]
          },
          "type": {
            "$ref": "#/components/schemas/ZoneType"
          },
          "status": {
            "type": "string",
            "enum": [
              "ACTIVE",
              "DISABLED",
              "SUSPENDED"
            ],
            "description": "Current operational status of the zone.\n\n- `ACTIVE`: The authoritative nameservers serve the zone.\n- `DISABLED`: The zone exists but isn't served. The account owner\n  disabled it through the API.\n- `SUSPENDED`: The zone is suspended, for example for billing or\n  policy reasons.\n"
          },
          "isDnssecEnabled": {
            "type": "boolean",
            "default": false,
            "description": "Whether DNSSEC signing is currently enabled for the zone."
          },
          "advancedConfig": {
            "description": "The zone's integration settings. Present when `type` is `PRIMARY`.\n",
            "$ref": "#/components/schemas/ZoneAdvancedConfig"
          },
          "primary": {
            "description": "The zone's Nameserver Set, Outbound IP Sets, and TSIG keys. Present\nwhen `type` is `PRIMARY`.\n",
            "$ref": "#/components/schemas/PrimaryZoneDetails"
          },
          "transferDetails": {
            "description": "The state of the zone's transfers from its upstream primary\nservers. Present when `type` is `SECONDARY`.\n",
            "$ref": "#/components/schemas/ZoneTransferDetails"
          },
          "secondary": {
            "description": "The zone's Inbound IP Set and optional TSIG key. Present when `type`\nis `SECONDARY`.\n",
            "$ref": "#/components/schemas/SecondaryZoneDetails"
          },
          "recordCount": {
            "type": "integer",
            "format": "int64",
            "minimum": 0,
            "description": "Number of DNS records currently in the zone."
          },
          "createdAt": {
            "type": "string",
            "format": "date-time",
            "readOnly": true,
            "description": "When the zone was created, as an RFC 3339 timestamp.",
            "example": "2026-06-05T14:00:00Z"
          },
          "updatedAt": {
            "type": "string",
            "format": "date-time",
            "readOnly": true,
            "description": "When the zone was last changed, as an RFC 3339 timestamp.",
            "example": "2026-06-05T14:00:00Z"
          }
        },
        "allOf": [
          {
            "if": {
              "properties": {
                "type": {
                  "const": "PRIMARY"
                }
              },
              "required": [
                "type"
              ]
            },
            "then": {
              "required": [
                "advancedConfig"
              ]
            }
          },
          {
            "if": {
              "properties": {
                "type": {
                  "const": "SECONDARY"
                }
              },
              "required": [
                "type"
              ]
            },
            "then": {
              "required": [
                "transferDetails"
              ]
            }
          }
        ]
      },
      "AsyncTask": {
        "type": "object",
        "description": "A long-running task. The API returns it with `202 Accepted`. To check its status, poll the URI\nin the `Location` header.\n",
        "required": [
          "id",
          "status",
          "type",
          "submittedAt"
        ],
        "properties": {
          "id": {
            "type": "string",
            "format": "uuid",
            "description": "The task's unique ID."
          },
          "status": {
            "type": "string",
            "enum": [
              "PENDING",
              "RUNNING",
              "SUCCEEDED",
              "FAILED",
              "CANCELLED"
            ],
            "description": "The task's current status. `CANCELLED` isn't currently returned."
          },
          "type": {
            "type": "string",
            "description": "The kind of task, such as `zone.records.import`, `zone.sign`, `zone.snapshot`,\n`zone.restore`, `integration.unlink`, or `batch`.\n",
            "examples": [
              "zone.records.import",
              "zone.sign",
              "zone.snapshot",
              "zone.restore",
              "integration.unlink",
              "batch"
            ]
          },
          "submittedAt": {
            "type": "string",
            "format": "date-time",
            "description": "When the task was submitted."
          },
          "startedAt": {
            "type": "string",
            "format": "date-time",
            "description": "When the task started running."
          },
          "completedAt": {
            "type": "string",
            "format": "date-time",
            "description": "When the task finished, whether it succeeded or failed."
          },
          "result": {
            "type": "string",
            "description": "A readable description of the task's outcome. For a `SUCCEEDED` task, it says what the\ntask did or created. For a `FAILED` task, it gives the reason. For a `RUNNING` task, it can\nshow progress.\n"
          }
        }
      },
      "ZoneUpdate": {
        "type": "object",
        "description": "The zone settings to change. Fields you omit stay unchanged. Updating a\nzone never changes its records.\n\nSome fields apply to one zone type only. Sending one for the other type\nreturns `422 Unprocessable Entity`:\n\n- `advancedConfig` and `primary` apply to `PRIMARY` zones.\n- `secondary` applies to `SECONDARY` zones.\n\nDNSSEC signing and SOA values aren't changed here. To sign a zone, use\n`POST /zones/{zoneName}:dnssec`, and to unsign it, use\n`DELETE /zones/{zoneName}:dnssec`. To change SOA values, update the\nzone's SOA record.\n",
        "properties": {
          "status": {
            "type": "string",
            "enum": [
              "ACTIVE",
              "DISABLED",
              "SUSPENDED"
            ],
            "description": "The zone's status. Set it to disable or re-enable the zone.\n\n- `ACTIVE`: DigiCert DNS serves the zone. Use it to re-enable a\n  disabled zone.\n- `DISABLED`: DigiCert DNS stops serving the zone but keeps it. Set\n  `ACTIVE` to serve it again. Setting `DISABLED` on a `SECONDARY`\n  zone returns `422 Unprocessable Entity`.\n- `SUSPENDED`: The zone is suspended, for example for billing or policy\n  reasons.\n"
          },
          "advancedConfig": {
            "description": "Integration settings for a `PRIMARY` zone. Sending them for a\n`SECONDARY` zone returns `422 Unprocessable Entity`.\n",
            "$ref": "#/components/schemas/ZoneAdvancedConfig"
          },
          "primary": {
            "description": "The Nameserver Set and up to 3 pairs of Outbound IP Set and TSIG key\nfor a `PRIMARY` zone. Sending them for a `SECONDARY` zone returns\n`422 Unprocessable Entity`.\n\nFields you omit stay unchanged. To remove every Outbound IP Set, set\n`outboundIps` to `[]`.\n",
            "$ref": "#/components/schemas/PrimaryZoneBinding"
          },
          "secondary": {
            "description": "The upstream configuration for a `SECONDARY` zone. It replaces the\nwhole existing configuration. Sending it for a `PRIMARY` zone returns\n`422 Unprocessable Entity`.\n",
            "$ref": "#/components/schemas/SecondaryZoneConfig"
          },
          "reason": {
            "type": "string",
            "maxLength": 512,
            "description": "A comment to record in the audit log with this change."
          }
        }
      },
      "ZoneConvertRequest": {
        "type": "object",
        "description": "Converts a `SECONDARY` zone to a `PRIMARY` zone. `PRIMARY` is the only\nsupported target type.\n",
        "required": [
          "targetType"
        ],
        "properties": {
          "targetType": {
            "type": "string",
            "enum": [
              "PRIMARY"
            ],
            "description": "The type to convert the zone to. Only `PRIMARY` is supported."
          },
          "reason": {
            "type": "string",
            "maxLength": 512,
            "description": "A comment to record in the audit log."
          }
        }
      },
      "DnsHealthZoneType": {
        "type": "string",
        "enum": [
          "primary",
          "secondary"
        ],
        "description": "The zone type a DNS Health check was run for: `primary` or\n`secondary`. These values are lower case, unlike the zone `type` values\nin the Zones operations (`PRIMARY`, `SECONDARY`).\n",
        "example": "primary"
      },
      "DnsHealthStatus": {
        "type": "string",
        "enum": [
          "Healthy",
          "Warning",
          "Unhealthy",
          "Unknown"
        ],
        "description": "The overall health of the zone, derived from its 3 checks\n(`serialHealthCheck`, `nameServerDelegationCheck`, and\n`zoneTransferCheck`). Each check is `Healthy` or `Unhealthy`:\n\n- `Healthy`: all 3 checks are `Healthy`.\n- `Warning`: 1 or 2 of the checks are `Healthy`.\n- `Unhealthy`: no check is `Healthy`.\n\n`Unknown` isn't currently returned.\n",
        "example": "Healthy"
      },
      "DnsHealthNameserverSerial": {
        "type": "object",
        "description": "The SOA serial number reported by one delegated nameserver.\n",
        "required": [
          "nameserver",
          "serialNumber"
        ],
        "properties": {
          "nameserver": {
            "type": "string",
            "minLength": 1,
            "description": "The delegated nameserver's fully qualified hostname, without a\ntrailing dot.\n",
            "examples": [
              "ns10.digicertdns.com"
            ]
          },
          "serialNumber": {
            "type": "string",
            "minLength": 1,
            "description": "The SOA serial number this nameserver reports, as a string so that\nthe value is kept exactly as reported. `N/A` if the nameserver didn't\nanswer the SOA query.\n",
            "examples": [
              "2009010108"
            ]
          }
        }
      },
      "DnsHealthCheckStatus": {
        "type": "string",
        "enum": [
          "Healthy",
          "Warning",
          "Unhealthy",
          "Unknown"
        ],
        "description": "The result of a single DNS Health check, or of a single peer or host in\na detail operation:\n\n- `Healthy`: the check passed.\n- `Unhealthy`: the check failed.\n\nThe 3 zone health checks return only these 2 values. A field that can\nalso be `Warning` or `Unknown` says so in its description.\n",
        "example": "Healthy"
      },
      "DnsHealthSerialCheck": {
        "type": "object",
        "description": "The SOA serial number check: whether every delegated nameserver serves\nthe zone with the same SOA serial number as DigiCert DNS.\n\nThe check finds the zone's delegated nameservers with an NS lookup of\nthe zone name, queries each one for the zone's SOA record, and compares\neach serial number with the zone's serial in DigiCert DNS.\n",
        "required": [
          "delegatedNsRecords",
          "status"
        ],
        "properties": {
          "delegatedNsRecords": {
            "type": "array",
            "description": "The SOA serial number reported by each delegated nameserver. The\norder isn't guaranteed.\n",
            "items": {
              "$ref": "#/components/schemas/DnsHealthNameserverSerial"
            }
          },
          "status": {
            "$ref": "#/components/schemas/DnsHealthCheckStatus",
            "description": "`Healthy` if there's at least 1 delegated nameserver and each one\nreports the same serial number as DigiCert DNS. `Unhealthy`\notherwise, including when a nameserver doesn't answer or the zone's\nserial in DigiCert DNS can't be read.\n"
          }
        }
      },
      "DnsHealthNameserver": {
        "type": "object",
        "description": "One authoritative nameserver in a DNS Health check.\n",
        "required": [
          "nameserver"
        ],
        "properties": {
          "nameserver": {
            "type": "string",
            "minLength": 1,
            "description": "The nameserver's fully qualified hostname. Names in `digicertDNS`\nkeep their trailing dot, and names in `delegatedNsRecords` don't have\none.\n",
            "examples": [
              "ns10.digicertdns.com.",
              "ns10.digicertdns.com"
            ]
          },
          "ipv4Addresses": {
            "type": "array",
            "items": {
              "type": "string",
              "format": "ipv4"
            },
            "description": "Not currently returned."
          },
          "ipv6Addresses": {
            "type": "array",
            "items": {
              "type": "string",
              "format": "ipv6"
            },
            "description": "Not currently returned."
          }
        }
      },
      "DnsHealthDelegationCheck": {
        "type": "object",
        "description": "The nameserver delegation check: whether the zone's delegated\nnameservers match the nameservers DigiCert DNS holds for the zone.\n\nThe check finds the delegated nameservers with an NS lookup of the zone\nname and compares them with the zone's NS records in DigiCert DNS. The\ncomparison ignores case, order, and trailing dots.\n",
        "required": [
          "digicertDNS",
          "delegatedNsRecords",
          "status"
        ],
        "properties": {
          "digicertDNS": {
            "type": "array",
            "description": "The nameservers in the zone's NS records in DigiCert DNS.",
            "items": {
              "$ref": "#/components/schemas/DnsHealthNameserver"
            }
          },
          "delegatedNsRecords": {
            "type": "array",
            "description": "The nameservers that the NS lookup of the zone name returned.",
            "items": {
              "$ref": "#/components/schemas/DnsHealthNameserver"
            }
          },
          "status": {
            "$ref": "#/components/schemas/DnsHealthCheckStatus",
            "description": "`Healthy` if DigiCert DNS holds at least 1 nameserver for the zone\nand the 2 sets match. `Unhealthy` otherwise, which usually means the\nzone isn't delegated to DigiCert DNS.\n"
          }
        }
      },
      "DnsHealthTransferCheck": {
        "type": "object",
        "description": "The zone transfer check: the outcome of the zone's most recent zone\ntransfer.\n\n- For `primary` zones, it's the most recent outbound zone transfer to a\n  downstream secondary server in the last 30 days.\n- For `secondary` zones, it's the most recent inbound zone transfer\n  from the zone's upstream primary server. This is the same transfer\n  that the zone's `transferDetails` describes in the Zones operations.\n\n`lastTransferStatus` here uses `SUCCESSFUL` where\n`transferDetails.lastTransferStatus` uses `SUCCEEDED`, and\n`lastTransferTimestamp` isn't converted to RFC 3339 for `secondary`\nzones.\n",
        "required": [
          "lastTransferStatus",
          "status"
        ],
        "properties": {
          "lastTransferStatus": {
            "type": "string",
            "enum": [
              "PENDING",
              "IN_PROGRESS",
              "SUCCESSFUL",
              "FAILED",
              "REFUSED",
              "CONNECTION_ERROR",
              "NOT_REQUESTED"
            ],
            "description": "The status of the most recent zone transfer:\n\n- `SUCCESSFUL`: the transfer completed.\n- `REFUSED`: for `primary` zones, the downstream server refused the\n  transfer.\n- `FAILED`: the transfer failed. A `primary` zone with no outbound\n  zone transfer in the last 30 days is also `FAILED`, and so is a\n  `secondary` zone whose transfer is queued but hasn't started. For\n  `secondary` zones, a transfer that the upstream server refused is\n  `FAILED` here. `GET /zones/{zoneName}/health/zone-transfers` shows\n  it as `REFUSED` for that peer.\n- `IN_PROGRESS`: for `secondary` zones, the transfer is running.\n- `NOT_REQUESTED`: for `secondary` zones, DigiCert DNS has no\n  transfer details for the zone.\n\n`PENDING` and `CONNECTION_ERROR` aren't currently returned.\n"
          },
          "lastTransferTimestamp": {
            "type": [
              "string",
              "null"
            ],
            "description": "When the most recent zone transfer was attempted. The format depends\non the zone type:\n\n- `primary`: RFC 3339 with milliseconds, for example\n  `2026-08-31T07:44:52.000Z`.\n- `secondary`: `MM/DD/YY hh:mm:ss AM/PM TZ`, for example\n  `08/31/26 07:44:52 AM GMT`.\n\nOmitted when there's no transfer to report.\n",
            "examples": [
              "2026-08-31T07:44:52.000Z",
              "08/31/26 07:44:52 AM GMT"
            ]
          },
          "status": {
            "$ref": "#/components/schemas/DnsHealthCheckStatus",
            "description": "`Healthy` if `lastTransferStatus` is `SUCCESSFUL`, `Unhealthy`\notherwise, including while a `secondary` zone's transfer is still\nrunning (`IN_PROGRESS`). A `primary` zone with no outbound zone\ntransfer in the last 30 days is `Unhealthy`, so its `healthStatus` is\n`Warning` at best.\n"
          }
        }
      },
      "HealthResponse": {
        "type": "object",
        "description": "The overall health of a zone and the result of each check behind it: SOA\nserial agreement with DigiCert DNS, NS delegation, and the most recent\nzone transfer.\n",
        "required": [
          "domain",
          "type",
          "healthStatus",
          "serialHealthCheck",
          "nameServerDelegationCheck",
          "zoneTransferCheck"
        ],
        "properties": {
          "domain": {
            "$ref": "#/components/schemas/DomainName",
            "description": "The name of the zone that was checked.",
            "examples": [
              "example.com."
            ]
          },
          "type": {
            "$ref": "#/components/schemas/DnsHealthZoneType",
            "description": "The zone type the zone was checked as (`primary` or `secondary`).\nMatches the `type` query parameter.\n"
          },
          "healthStatus": {
            "$ref": "#/components/schemas/DnsHealthStatus"
          },
          "serialHealthCheck": {
            "$ref": "#/components/schemas/DnsHealthSerialCheck"
          },
          "nameServerDelegationCheck": {
            "$ref": "#/components/schemas/DnsHealthDelegationCheck"
          },
          "zoneTransferCheck": {
            "$ref": "#/components/schemas/DnsHealthTransferCheck"
          }
        }
      },
      "DnsHealthNameserverSoa": {
        "type": "object",
        "description": "The SOA values reported by a delegated nameserver.\n",
        "required": [
          "serial",
          "refresh",
          "retry",
          "expire"
        ],
        "properties": {
          "serial": {
            "type": "string",
            "minLength": 1,
            "description": "The SOA serial number, as a string so that the value is kept\nexactly as reported. `N/A` if the nameserver didn't answer the SOA\nquery, in which case `refresh`, `retry`, and `expire` are `0`.\n",
            "examples": [
              "2009010109"
            ]
          },
          "refresh": {
            "type": "integer",
            "format": "int64",
            "minimum": 0,
            "description": "SOA `refresh` interval, in seconds.",
            "examples": [
              43200
            ]
          },
          "retry": {
            "type": "integer",
            "format": "int64",
            "minimum": 0,
            "description": "SOA `retry` interval, in seconds.",
            "examples": [
              3600
            ]
          },
          "expire": {
            "type": "integer",
            "format": "int64",
            "minimum": 0,
            "description": "SOA `expire` interval, in seconds.",
            "examples": [
              1209600
            ]
          }
        }
      },
      "DnsHealthNameserverDetail": {
        "type": "object",
        "description": "The SOA values reported by one delegated nameserver.\n",
        "required": [
          "nameserver",
          "type",
          "soa"
        ],
        "properties": {
          "nameserver": {
            "type": "string",
            "minLength": 1,
            "description": "The delegated nameserver's fully qualified hostname, without a\ntrailing dot.\n",
            "examples": [
              "ns10.digicertdns.com"
            ]
          },
          "type": {
            "$ref": "#/components/schemas/DnsHealthZoneType",
            "description": "The role this nameserver has for the zone (`primary` or\n`secondary`). It can differ from the `type` at the top of the\nresponse. A delegated nameserver that is one of DigiCert DNS's\nnameservers for the zone has the zone's type. Any other delegated\nnameserver, such as the customer's own primary server for a\nsecondary zone, is `primary`.\n",
            "examples": [
              "primary"
            ]
          },
          "ipv4Addresses": {
            "type": "array",
            "items": {
              "type": "string",
              "format": "ipv4"
            },
            "description": "Not currently returned."
          },
          "ipv6Addresses": {
            "type": "array",
            "items": {
              "type": "string",
              "format": "ipv6"
            },
            "description": "Not currently returned."
          },
          "soa": {
            "$ref": "#/components/schemas/DnsHealthNameserverSoa"
          }
        }
      },
      "NameserverHealthResponse": {
        "type": "object",
        "description": "SOA values from each delegated nameserver of a zone, for the requested\nzone type.\n",
        "required": [
          "type",
          "data"
        ],
        "properties": {
          "type": {
            "$ref": "#/components/schemas/DnsHealthZoneType",
            "description": "The zone type the zone was checked as (`primary` or `secondary`).\nMatches the `type` query parameter.\n"
          },
          "data": {
            "type": "array",
            "maxItems": 64,
            "description": "The SOA values reported by each delegated nameserver. The order isn't\nguaranteed. Not paginated: a zone has only a few delegated\nnameservers.\n",
            "items": {
              "$ref": "#/components/schemas/DnsHealthNameserverDetail"
            }
          }
        }
      },
      "ZoneNameserverEntry": {
        "type": "object",
        "description": "A DigiCert nameserver assigned to the zone, from the zone's NS record\nset, with its current IPv4 and IPv6 addresses and whether the zone is\ndelegated to it.\n",
        "required": [
          "nameserver",
          "status"
        ],
        "properties": {
          "nameserver": {
            "type": "string",
            "minLength": 1,
            "description": "The nameserver's fully qualified hostname.",
            "examples": [
              "ns10.digicertdns.com."
            ]
          },
          "ipv4Address": {
            "type": "string",
            "format": "ipv4",
            "nullable": true,
            "description": "The IPv4 address that the nameserver's hostname resolves to, from its\n`A` record, when you make the request. `N/A` if the hostname has no\n`A` record or the lookup fails.\n",
            "examples": [
              "192.0.2.10"
            ]
          },
          "ipv6Address": {
            "type": "string",
            "format": "ipv6",
            "nullable": true,
            "description": "The IPv6 address that the nameserver's hostname resolves to, from its\n`AAAA` record, when you make the request. `N/A` if the hostname has\nno `AAAA` record or the lookup fails.\n",
            "examples": [
              "2001:db8:0:0:0:0:0:10"
            ]
          },
          "status": {
            "type": "string",
            "enum": [
              "DELEGATED",
              "NOT_DELEGATED"
            ],
            "description": "Whether the zone is delegated to the nameserver, as found by a live NS\nlookup of the zone.\n\n- `DELEGATED`: The nameserver is in the zone's live NS records.\n- `NOT_DELEGATED`: The nameserver isn't in the zone's live NS\n  records. For example, the zone isn't delegated to DigiCert yet, or\n  its delegation still points to another DNS provider.\n",
            "example": "DELEGATED"
          }
        }
      },
      "RegistrarNameserverEntry": {
        "type": "object",
        "description": "A nameserver that the zone is delegated to, as found by a live NS lookup\nof the zone, with its current IPv4 and IPv6 addresses. It can belong to\nanother DNS provider. To check the zone's delegation, compare\n`registrarNameservers` with `nameservers` in the same response.\n",
        "required": [
          "nameserver"
        ],
        "properties": {
          "nameserver": {
            "type": "string",
            "minLength": 1,
            "description": "The nameserver's fully qualified hostname, as returned by the live NS\nlookup. It isn't necessarily one of the DigiCert nameservers assigned\nto the zone.\n",
            "examples": [
              "ns11.digicertdns.com"
            ]
          },
          "ipv4Address": {
            "type": "string",
            "format": "ipv4",
            "nullable": true,
            "description": "The IPv4 address that the nameserver's hostname resolves to, from its\n`A` record, when you make the request. `N/A` if the hostname has no\n`A` record or the lookup fails.\n",
            "examples": [
              "198.51.100.11"
            ]
          },
          "ipv6Address": {
            "type": "string",
            "format": "ipv6",
            "nullable": true,
            "description": "The IPv6 address that the nameserver's hostname resolves to, from its\n`AAAA` record, when you make the request. `N/A` if the hostname has\nno `AAAA` record or the lookup fails.\n",
            "examples": [
              "2001:db8:1:0:0:0:0:11"
            ]
          }
        }
      },
      "ZoneNameserversResponse": {
        "type": "object",
        "description": "The DigiCert nameservers assigned to a zone, compared with the\nnameservers that the zone is delegated to. The API finds the delegation\nwith a live NS lookup of the zone. Each nameserver includes its current\nIPv4 and IPv6 addresses.\n",
        "required": [
          "zone",
          "nameservers",
          "registrarNameservers"
        ],
        "properties": {
          "zone": {
            "type": "string",
            "minLength": 1,
            "description": "The fully qualified name of the zone.",
            "examples": [
              "example.com."
            ]
          },
          "nameservers": {
            "type": "array",
            "maxItems": 64,
            "description": "The DigiCert nameservers assigned to the zone, from the zone's NS\nrecord set, in the order of that record set. Each entry includes the\nnameserver's current addresses and whether the zone is delegated to\nit. Empty if the API can't read the zone's NS record set. The list\nisn't paginated, because a zone has only a few nameservers.\n",
            "items": {
              "$ref": "#/components/schemas/ZoneNameserverEntry"
            }
          },
          "registrarNameservers": {
            "type": "array",
            "maxItems": 64,
            "description": "The nameservers that the zone is delegated to, as found by a live NS\nlookup of the zone. They can include nameservers from another DNS\nprovider. Each nameserver appears once, in the order the lookup\nreturned it. Empty if the lookup finds no nameservers or fails, for\nexample because the zone isn't delegated yet. The list isn't\npaginated.\n",
            "items": {
              "$ref": "#/components/schemas/RegistrarNameserverEntry"
            }
          }
        }
      },
      "DnsHealthFailureReason": {
        "type": [
          "string",
          "null"
        ],
        "enum": [
          "REFUSED",
          "CONNECTION_ERROR",
          "TIMEOUT",
          "UNREACHABLE",
          null
        ],
        "description": "The reason that a peer's status is `Unhealthy`:\n\n- `REFUSED`: the peer refused the request, for example because of an\n  access control or TSIG mismatch.\n- `CONNECTION_ERROR`: the network connection failed, for example\n  because it was reset or a TLS or TSIG handshake failed.\n- `TIMEOUT`: the peer didn't respond in time.\n- `UNREACHABLE`: the peer couldn't be reached, for example because\n  there's no network route to it or its hostname doesn't resolve.\n- `null`: no failure. The status is `Healthy`, `Warning`, or\n  `Unknown`.\n",
        "example": null
      },
      "DnsHealthZoneTransferEntry": {
        "type": "object",
        "description": "The most recent zone transfer with one peer. To change which servers can\ntransfer the zone, use `/dns-settings/outbound/nameserver-sets`\n(Outbound IP Sets) and `/dns-settings/inbound/nameserver-sets` (Inbound\nIP Sets).\n",
        "required": [
          "ipSetName",
          "remoteIp",
          "reachability"
        ],
        "properties": {
          "ipSetName": {
            "type": "string",
            "minLength": 1,
            "description": "The name of the zone's IP set: the first Outbound IP Set bound to the\nzone for `primary` zones, or its Inbound IP Set\n(`secondary.inboundIpSetName`) for `secondary` zones. It's the same\nfor every entry, and `N/A` if the zone has none.\n",
            "examples": [
              "secondary-peers"
            ]
          },
          "remoteIp": {
            "type": "string",
            "minLength": 1,
            "description": "The peer's IP address. For `primary` zones, it's a downstream server\nthat transferred the zone **from** DigiCert DNS. For `secondary`\nzones, it's the upstream server that DigiCert DNS transferred the\nzone **from**. `N/A` in the single entry returned when there was no\nrecent transfer.\n",
            "examples": [
              "192.0.2.10"
            ]
          },
          "serial": {
            "type": [
              "string",
              "null"
            ],
            "minLength": 1,
            "description": "The SOA serial number of the transfer, as a string so that the value\nis kept exactly as reported. If the transfer record has none, it's\nthe zone's current serial in DigiCert DNS.\n",
            "examples": [
              "2026021303"
            ]
          },
          "lastTransferAt": {
            "type": [
              "string",
              "null"
            ],
            "format": "date-time",
            "description": "When the transfer happened. If the recorded time can't be read, it's\nthe time of the request. Omitted in the `N/A` entry when the zone has\nno transfer time to report.\n",
            "examples": [
              "2026-02-12T08:27:59Z"
            ]
          },
          "reachability": {
            "$ref": "#/components/schemas/DnsHealthCheckStatus",
            "description": "`Healthy` if the transfer succeeded, `Unhealthy` otherwise. In the\n`N/A` entry, it reflects the zone's own transfer status because there\nis no recent peer transfer to report. This is different from\n`zoneTransferCheck.status` on `GET /zones/{zoneName}/health`, which\nreports only the zone's most recent transfer.\n"
          },
          "reasonCode": {
            "$ref": "#/components/schemas/DnsHealthFailureReason",
            "description": "`REFUSED` if the peer refused the transfer. Omitted otherwise,\nincluding for other kinds of failure.\n"
          }
        }
      },
      "DnsHealthZoneTransferList": {
        "type": "object",
        "description": "The most recent zone transfer with each peer of a zone, for the\nrequested zone type.\n",
        "required": [
          "type",
          "data"
        ],
        "properties": {
          "type": {
            "$ref": "#/components/schemas/DnsHealthZoneType",
            "description": "The zone type the zone was checked as (`primary` or `secondary`).\nMatches the `type` query parameter.\n"
          },
          "data": {
            "type": "array",
            "maxItems": 64,
            "description": "The most recent zone transfer with each peer, most recent first. It's\nbuilt from up to the 10 most recent zone transfers in the last 30\ndays, so a peer that hasn't transferred the zone in that time isn't\nlisted. If there was none, there's 1 entry with `remoteIp` set to\n`N/A`. Not paginated.\n",
            "items": {
              "$ref": "#/components/schemas/DnsHealthZoneTransferEntry"
            }
          }
        }
      },
      "DnsHealthAxfrHostEntry": {
        "type": "object",
        "description": "One DigiCert DNS transfer host address for the zone.\n",
        "required": [
          "fqdn",
          "hostIp",
          "status"
        ],
        "properties": {
          "fqdn": {
            "type": "string",
            "minLength": 1,
            "description": "The transfer host's fully qualified hostname. `N/A` when the\nhostname is unavailable.\n",
            "examples": [
              "axfr1.example.com"
            ]
          },
          "hostIp": {
            "type": "string",
            "minLength": 1,
            "description": "The DigiCert DNS transfer host's public (NAT) IP address. For\n`secondary` zones, allow it on the zone's primary server. For\n`primary` zones, allow it on downstream secondary servers so they can\naccept transfers and `NOTIFY` messages. `N/A` if no address is known.\n",
            "examples": [
              "198.51.100.53"
            ]
          },
          "serial": {
            "type": [
              "string",
              "null"
            ],
            "minLength": 1,
            "description": "The zone's current SOA serial number in DigiCert DNS, as a string. It's\nthe same for every entry.\n",
            "examples": [
              "2026021303"
            ]
          },
          "lastTransferAt": {
            "type": [
              "string",
              "null"
            ],
            "format": "date-time",
            "description": "The most recent recorded transfer time for the zone. For `secondary`\nzones, this is the time of the most recent inbound zone transfer. For\n`primary` zones, this is the newest outbound transfer to any downstream\nsecondary server, and it's the same in every host entry; it isn't a\nper-host timestamp. When no outbound transfer time is available, the\nzone's most recent transfer time is returned instead. Omitted when no\ntimestamp is available.\n",
            "examples": [
              "2025-10-20T09:32:00Z"
            ]
          },
          "status": {
            "$ref": "#/components/schemas/DnsHealthCheckStatus",
            "description": "For `secondary` zones, the result of the zone's most recent inbound\nzone transfer: `Healthy` if it succeeded, `Unhealthy` if it failed,\nor `Unknown` if it hasn't finished. `zoneTransferCheck.status` on\n`GET /zones/{zoneName}/health` reports a transfer that hasn't\nfinished as `Unhealthy`. For `primary` zones, `status` is a zone-wide\nresult, not a per-host one. It is `Healthy` only\nafter a recorded successful transfer; otherwise it is `Unhealthy`.\nIt isn't a live host-availability probe.\n"
          }
        }
      },
      "DnsHealthAxfrHostList": {
        "type": "object",
        "description": "The DigiCert DNS host that transfers a zone, for the requested zone\ntype.\n",
        "required": [
          "type",
          "data"
        ],
        "properties": {
          "type": {
            "$ref": "#/components/schemas/DnsHealthZoneType",
            "description": "The zone type the zone was checked as (`primary` or `secondary`).\nMatches the `type` query parameter.\n"
          },
          "data": {
            "type": "array",
            "maxItems": 64,
            "description": "For `primary` zones, returns the DigiCert DNS transfer hosts that may\nsend transfers to downstream secondary servers, whether or not an\nOutbound IP Set is bound or a recent transfer has been recorded. If no\nhost address is known, the list contains one entry with `hostIp` set to\n`N/A`. It's empty for a `secondary` zone that DigiCert DNS has no\ntransfer details for. Not sorted. Not paginated.\n",
            "items": {
              "$ref": "#/components/schemas/DnsHealthAxfrHostEntry"
            }
          }
        }
      },
      "DnsHealthOutboundNotificationEntry": {
        "type": "object",
        "description": "The latest recorded `NOTIFY` details for one address: a DigiCert DNS\ntransfer host for `primary` zones, or the DigiCert DNS address that\nreceived the `NOTIFY` for `secondary` zones. For `primary` zones with no\nrecorded `NOTIFY`, this represents a configured transfer host with\n`status` `Unknown`.\n",
        "required": [
          "fqdn",
          "ip",
          "status"
        ],
        "properties": {
          "fqdn": {
            "type": "string",
            "minLength": 1,
            "description": "For `primary` zones, the fully qualified hostname of the DigiCert DNS\ntransfer host, found by matching the recorded IP address against the\nconfigured transfer hosts. Equivalent IPv6 addresses match regardless\nof their textual representation. If no configured transfer host\nmatches the address, the value is `N/A`. If no `NOTIFY` has been\nrecorded for the `primary` zone, the value is the transfer host's\nconfigured hostname. Always `N/A` for `secondary` zones.\n",
            "examples": [
              "axfr1.example.net"
            ]
          },
          "ip": {
            "type": "string",
            "minLength": 1,
            "description": "The IP address recorded for the `NOTIFY`, preserved in its recorded\nform. For `primary` zones, this is the DigiCert DNS transfer host\naddress that sent the `NOTIFY`. For `secondary` zones, this is the\nDigiCert DNS address that received it. If no `NOTIFY` has been\nrecorded for a `primary` zone, the value is the transfer host's\nconfigured IP address. `N/A` if no address is available.\n",
            "examples": [
              "192.0.2.20"
            ]
          },
          "serial": {
            "type": [
              "string",
              "null"
            ],
            "minLength": 1,
            "description": "The SOA serial number carried by the latest `NOTIFY` recorded for\nthis address, returned as a string to preserve the reported value.\n`null` if the record contains no serial number. If no `NOTIFY` has\nbeen recorded for a `primary` zone, the value is the zone's current\nSOA serial number, or `null` if it can't be read.\n",
            "examples": [
              "2008765783"
            ]
          },
          "lastNotifyAt": {
            "type": [
              "string",
              "null"
            ],
            "format": "date-time",
            "description": "The timestamp of the latest recorded `NOTIFY` for this address.\n`null` if the recorded timestamp can't be read or no `NOTIFY` has\nbeen recorded.\n",
            "examples": [
              "2026-01-07T09:50:40Z"
            ]
          },
          "status": {
            "$ref": "#/components/schemas/DnsHealthCheckStatus",
            "description": "`Healthy` if the latest `NOTIFY` recorded for this address\nsucceeded; `Unhealthy` if it failed. When the status is `Unhealthy`,\n`reasonCode` explains the failure. For `primary` zones, the status\nreflects the latest `NOTIFY` the transfer host sent to any\ndownstream secondary server; it doesn't identify which recipient\nfailed. If no `NOTIFY` has been recorded for a `primary` zone, the\nstatus is `Unknown` and `reasonCode` is `null` because no delivery\nresult is available.\n"
          },
          "reasonCode": {
            "$ref": "#/components/schemas/DnsHealthFailureReason",
            "description": "Why `status` is `Unhealthy`. `null` otherwise.\n"
          }
        }
      },
      "DnsHealthOutboundNotificationList": {
        "type": "object",
        "description": "`NOTIFY` details for the requested zone type, including configured\ntransfer host entries for `primary` zones with no recorded `NOTIFY`.\n",
        "required": [
          "type",
          "data"
        ],
        "properties": {
          "type": {
            "$ref": "#/components/schemas/DnsHealthZoneType",
            "description": "The zone type the zone was checked as (`primary` or `secondary`).\nMatches the `type` query parameter.\n"
          },
          "data": {
            "type": "array",
            "maxItems": 64,
            "description": "The latest recorded `NOTIFY` details for each address, ordered by\ntimestamp from newest to oldest. Entries with unreadable timestamps\nappear last. For `primary` zones, each address represents a DigiCert\nDNS transfer host. For `secondary` zones, each address is the\nDigiCert DNS address that received the `NOTIFY`. If no `NOTIFY` has\nbeen recorded for a `primary` zone, the array contains one entry\nwith `status` `Unknown` per configured transfer host. Once at least\none `NOTIFY` is recorded for the `primary` zone, only recorded\nentries are returned; no entries are added for other configured\ntransfer hosts. When no `NOTIFY` is recorded, `secondary` zones and\n`primary` zones with no configured transfer hosts return an empty\narray. Results aren't paginated.\n",
            "items": {
              "$ref": "#/components/schemas/DnsHealthOutboundNotificationEntry"
            }
          }
        }
      },
      "DnsHealthInboundNotificationEntry": {
        "type": "object",
        "description": "The most recent `NOTIFY` received from one peer.\n",
        "required": [
          "ip",
          "ipSetName"
        ],
        "properties": {
          "ip": {
            "type": "string",
            "minLength": 1,
            "description": "The IP address of the peer that sent the `NOTIFY`. For `secondary`\nzones, it's the upstream primary server. For `primary` zones, it's\na downstream secondary server acknowledging a zone change.\n",
            "examples": [
              "198.51.100.20"
            ]
          },
          "ipSetName": {
            "type": "string",
            "minLength": 1,
            "description": "The name of the IP set that the peer belongs to: the zone's\nInbound IP Set (`secondary.inboundIpSetName`) for `secondary`\nzones, or its Outbound IP Set\n(`primary.outboundIps[].outboundIpSetName`) for `primary` zones.\n",
            "examples": [
              "upstream-primaries"
            ]
          },
          "lastNotifyAt": {
            "type": [
              "string",
              "null"
            ],
            "format": "date-time",
            "description": "When the most recent `NOTIFY` was received from this peer. `null`\nif no `NOTIFY` has been received from this peer, for example\nbecause it was just added to the IP set.\n",
            "examples": [
              "2026-01-07T09:50:40Z"
            ]
          }
        }
      },
      "DnsHealthInboundNotificationList": {
        "type": "object",
        "description": "Inbound `NOTIFY` activity for each peer of a zone, for the requested\nzone type.\n",
        "required": [
          "type",
          "data"
        ],
        "properties": {
          "type": {
            "$ref": "#/components/schemas/DnsHealthZoneType",
            "description": "The zone type the zone was checked as (`primary` or `secondary`).\nMatches the `type` query parameter.\n"
          },
          "data": {
            "type": "array",
            "maxItems": 64,
            "description": "The most recent `NOTIFY` received from each peer, in the order\nthat the zone's IP set lists them. Not paginated: an IP set holds\nonly a few servers.\n",
            "items": {
              "$ref": "#/components/schemas/DnsHealthInboundNotificationEntry"
            }
          }
        }
      },
      "DnsHealthNotifyEventType": {
        "type": "string",
        "enum": [
          "NOTIFY_OUT",
          "NOTIFY_IN"
        ],
        "description": "The direction of a `NOTIFY` event:\n\n- `NOTIFY_OUT`: DigiCert DNS sent the `NOTIFY`, for example when a\n  `primary` zone notifies a downstream secondary server of a change.\n- `NOTIFY_IN`: DigiCert DNS received the `NOTIFY`, for example when a\n  `secondary` zone's upstream primary server notifies it of a change.\n",
        "example": "NOTIFY_OUT"
      },
      "DnsHealthNotifyEventEntry": {
        "type": "object",
        "description": "The most recent `NOTIFY` event with one peer. Earlier events with the\npeer aren't kept.\n",
        "required": [
          "eventId",
          "ip",
          "lastNotifyAt",
          "status",
          "eventType"
        ],
        "properties": {
          "eventId": {
            "type": "string",
            "format": "uuid",
            "description": "The ID of this `NOTIFY` event. It stays the same for as long as\nthe event is the peer's latest. Use it to refer to the event when\nyou contact support. You can't use it to retrieve the event after\na newer event replaces it.\n"
          },
          "ip": {
            "type": "string",
            "minLength": 1,
            "description": "The peer's IP address: the recipient of a `NOTIFY_OUT` event, or\nthe sender of a `NOTIFY_IN` event.\n",
            "examples": [
              "192.0.2.20"
            ]
          },
          "lastNotifyAt": {
            "type": "string",
            "format": "date-time",
            "description": "When the most recent `NOTIFY` event with this peer happened.",
            "examples": [
              "2026-01-07T09:50:40Z"
            ]
          },
          "status": {
            "$ref": "#/components/schemas/DnsHealthCheckStatus",
            "description": "`Healthy` if the most recent `NOTIFY` event with this peer\nsucceeded, or `Unhealthy` if it failed. `reasonCode` gives the\nreason.\n"
          },
          "reasonCode": {
            "$ref": "#/components/schemas/DnsHealthFailureReason",
            "description": "Why `status` is `Unhealthy`. `null` otherwise.\n"
          },
          "eventType": {
            "$ref": "#/components/schemas/DnsHealthNotifyEventType"
          }
        }
      },
      "DnsHealthNotifyEventList": {
        "type": "object",
        "description": "The latest `NOTIFY` event for each peer of a zone, for the requested\nzone type.\n",
        "required": [
          "type",
          "data"
        ],
        "properties": {
          "type": {
            "$ref": "#/components/schemas/DnsHealthZoneType",
            "description": "The zone type the zone was checked as (`primary` or `secondary`).\nMatches the `type` query parameter.\n"
          },
          "data": {
            "type": "array",
            "maxItems": 64,
            "description": "The most recent `NOTIFY` event for each peer, with its direction\nin `eventType`. There's at most 1 entry for each peer. This isn't\na history: each new event replaces the previous one. Sorted by\n`lastNotifyAt`, most recent first.\n",
            "items": {
              "$ref": "#/components/schemas/DnsHealthNotifyEventEntry"
            }
          }
        }
      },
      "DnsHealthDnsSecStatus": {
        "type": "string",
        "enum": [
          "UNSIGNED",
          "PENDING",
          "ACTIVE",
          "MISMATCH",
          "LOOKUP_FAILURE"
        ],
        "description": "The result of the DNSSEC check:\n\n- `UNSIGNED`: the zone has no active KSK, so there's no DS record to\n  compare.\n- `PENDING`: the zone is signed, but the parent zone has no DS record\n  for it yet (the lookup returned `NXDOMAIN` or no data). This is\n  expected until you add the DS record at your registrar.\n- `ACTIVE`: the published DS records match the expected ones.\n- `MISMATCH`: a DS record is published, but it doesn't match the\n  expected ones, for example because it's out of date. Unlike\n  `PENDING`, you need to replace the DS record at your registrar, not\n  add one.\n- `LOOKUP_FAILURE`: the DNS lookup didn't complete, for example\n  because of a network problem. It doesn't mean the DS record is\n  missing, so don't treat it as `PENDING` or `MISMATCH`.\n",
        "example": "ACTIVE"
      },
      "DnsHealthDnsSecCheck": {
        "type": "object",
        "description": "The DNSSEC check for a zone. It compares the DS records that DigiCert\nDNS expects, which come from the zone's active key signing keys (KSKs),\nwith the DS records published in the parent zone.\n",
        "required": [
          "status",
          "expectedDsRecords",
          "liveDsRecords"
        ],
        "properties": {
          "status": {
            "$ref": "#/components/schemas/DnsHealthDnsSecStatus"
          },
          "expectedDsRecords": {
            "type": "array",
            "description": "The DS records that DigiCert DNS expects to be published, from the\nzone's active KSKs. Empty if the zone isn't signed.\n",
            "items": {
              "type": "string",
              "pattern": "^[0-9]{1,5} [0-9]{1,3} [0-9]{1,3} [0-9A-Fa-f]+$"
            },
            "examples": [
              [
                "63745 13 2 F1E184C0E1D615D20EB3C223ACED3B03676BBB2DA1721A57F58F82F92B4AAB55"
              ]
            ]
          },
          "liveDsRecords": {
            "type": "array",
            "description": "The DS records published in the parent zone, from a DNS lookup at\ncheck time. Empty if none are published.\n",
            "items": {
              "type": "string",
              "pattern": "^[0-9]{1,5} [0-9]{1,3} [0-9]{1,3} [0-9A-Fa-f]+$"
            },
            "examples": [
              [
                "63745 13 2 F1E184C0E1D615D20EB3C223ACED3B03676BBB2DA1721A57F58F82F92B4AAB55"
              ]
            ]
          }
        }
      },
      "ZoneExportRequest": {
        "type": "object",
        "required": [
          "zoneNames"
        ],
        "description": "The zones to export as BIND zone files, up to 250 per request. The export\nruns in the background. Poll the resulting `AsyncTask` for the download\nURL.\n",
        "properties": {
          "zoneNames": {
            "type": "array",
            "minItems": 1,
            "maxItems": 250,
            "items": {
              "$ref": "#/components/schemas/DomainName"
            },
            "description": "The fully qualified domain names of the zones to export. A trailing\ndot is optional.\n",
            "examples": [
              [
                "example.com.",
                "another.example.net."
              ]
            ]
          }
        }
      },
      "RecordType": {
        "type": "string",
        "description": "DNS record type. The supported types are IANA-defined types that aren't\ndeprecated, plus `ALIAS`, a DigiCert DNS record type that points the zone\napex at another host name. Record types are uppercase. Send them in\nuppercase.\n",
        "enum": [
          "A",
          "AAAA",
          "ALIAS",
          "CAA",
          "CERT",
          "CNAME",
          "DNAME",
          "DS",
          "HINFO",
          "HTTPS",
          "LOC",
          "MX",
          "NAPTR",
          "NS",
          "PTR",
          "RP",
          "SOA",
          "SRV",
          "SSHFP",
          "SVCB",
          "TLSA",
          "TXT"
        ],
        "example": "A"
      },
      "RoutingPolicy": {
        "type": "string",
        "enum": [
          "NONE",
          "SIMPLE_FAILOVER"
        ],
        "default": "NONE",
        "description": "Routing policy of the record set. It selects which `routing` fields the\nrecord set uses.\n\n- `NONE`: A static record set. Its values are in `content` or `rdata`.\n  This is the default.\n- `SIMPLE_FAILOVER`: Failover between the addresses in `endpoints`, in\n  priority order. A `monitor` health check over `HTTP`, `HTTPS`, `TCP`,\n  `UDP`, or `ICMP` tests each endpoint. The endpoint with the lowest\n  `priority` number is preferred. It doesn't use `content`.\n\nRouting by region isn't a routing policy. To answer differently by\nregion, turn on regional views for the zone with\n`advancedConfig.isRegionalViewEnabled`, then create regional record sets.\n",
        "example": "NONE"
      },
      "TlsaRdata": {
        "type": "object",
        "description": "Structured record data for the `TLSA` record type, as defined in\nRFC 6698.\n",
        "required": [
          "certUsage",
          "selector",
          "matchingType",
          "certificateData"
        ],
        "properties": {
          "certUsage": {
            "type": "integer",
            "minimum": 0,
            "maximum": 3,
            "description": "How clients use the record to verify the server's certificate.\n\n- `0`: PKIX-TA. The data identifies a certificate authority (CA) that\n  must be in the certificate's validation chain.\n- `1`: PKIX-EE. The data identifies the server's certificate, which\n  must also pass standard certificate validation.\n- `2`: DANE-TA. The data identifies a trust anchor for the server's\n  certificate.\n- `3`: DANE-EE. The data identifies the server's certificate, with no\n  other validation required.\n",
            "example": 3
          },
          "selector": {
            "type": "integer",
            "minimum": 0,
            "maximum": 1,
            "description": "Which part of the certificate the data matches.\n\n- `0`: The data matches the full certificate.\n- `1`: The data matches the certificate's SubjectPublicKeyInfo\n  (SPKI), which holds the public key.\n",
            "example": 1
          },
          "matchingType": {
            "type": "integer",
            "minimum": 0,
            "maximum": 2,
            "description": "How the selected part of the certificate is presented in\n`certificateData`.\n\n- `0`: The data is an exact match, with no hash.\n- `1`: The data is a SHA-256 hash.\n- `2`: The data is a SHA-512 hash.\n\nThe API checks the length of `certificateData` against the matching\ntype. A SHA-256 hash is 64 hexadecimal characters, and a SHA-512 hash\nis 128. The API returns `400` if the length doesn't match.\n",
            "example": 1
          },
          "certificateData": {
            "type": "string",
            "pattern": "^([0-9a-fA-F]{2})+$",
            "description": "The certificate association data, hex-encoded. It must contain whole\nbytes, so an odd number of characters isn't valid. The required\nlength depends on `matchingType`. It's 64 characters for SHA-256 and\n128 for SHA-512.\n",
            "example": "d2abde240d7cd3ee6b4b28c54df034b97983a1d16e8a410e4561cb106618e971"
          }
        },
        "example": {
          "certUsage": 3,
          "selector": 1,
          "matchingType": 1,
          "certificateData": "d2abde240d7cd3ee6b4b28c54df034b97983a1d16e8a410e4561cb106618e971"
        }
      },
      "RdataType": {
        "type": "string",
        "enum": [
          "TLSA",
          "HTTPS",
          "SVCB"
        ],
        "description": "Record type of a structured record data item. It must match the record\nset's `rrtype`.\n",
        "example": "TLSA"
      },
      "TlsaRdataItem": {
        "description": "Structured record data for a `TLSA` record set, as defined in RFC 6698.",
        "allOf": [
          {
            "$ref": "#/components/schemas/TlsaRdata"
          },
          {
            "type": "object",
            "required": [
              "type"
            ],
            "properties": {
              "type": {
                "allOf": [
                  {
                    "$ref": "#/components/schemas/RdataType"
                  }
                ],
                "enum": [
                  "TLSA"
                ]
              }
            }
          }
        ],
        "example": {
          "type": "TLSA",
          "certUsage": 3,
          "selector": 1,
          "matchingType": 1,
          "certificateData": "d2abde240d7cd3ee6b4b28c54df034b97983a1d16e8a410e4561cb106618e971"
        }
      },
      "HttpsSvcbRdata": {
        "type": "object",
        "description": "Structured record data for the `HTTPS` and `SVCB` record types, which\nshare one format defined in RFC 9460. Only `priority` and `targetName`\nare required. Every service parameter is optional.\n\n`priority: 0` selects AliasMode, which doesn't allow service parameters.\nTo set a service parameter that has no field of its own, such as\n`no-default-alpn`, `ech`, `mandatory`, or `dohpath`, use\n`additionalSvcParams`.\n",
        "required": [
          "priority",
          "targetName"
        ],
        "properties": {
          "priority": {
            "type": "integer",
            "minimum": 0,
            "maximum": 65535,
            "description": "The service priority. The API returns `400` if you set a service\nparameter in AliasMode.\n\n- `0`: AliasMode. No service parameters are allowed.\n- `1` to `65535`: ServiceMode. A lower number is preferred.\n",
            "example": 1
          },
          "targetName": {
            "type": "string",
            "description": "The target name of the service. The API returns `400` if the name\ncontains whitespace, quotation marks, or backslashes.\n\nThe value `.` means something different in each mode:\n\n- In ServiceMode, where `priority` is 1 or more, `.` means the record\n  set's owner name.\n- In AliasMode, where `priority` is `0`, `.` means the service doesn't\n  exist.\n",
            "example": "."
          },
          "alpn": {
            "type": "array",
            "minItems": 1,
            "description": "The Application-Layer Protocol Negotiation (ALPN) protocol IDs that\nthe service supports, in order of preference.\n",
            "items": {
              "type": "string"
            },
            "example": [
              "h2",
              "h3"
            ]
          },
          "port": {
            "type": "integer",
            "minimum": 0,
            "maximum": 65535,
            "description": "The TCP or UDP port of the service.",
            "example": 443
          },
          "ipv4hint": {
            "type": "array",
            "minItems": 1,
            "description": "IPv4 addresses that clients can use to reach the service.",
            "items": {
              "type": "string",
              "format": "ipv4"
            },
            "example": [
              "192.0.2.10"
            ]
          },
          "ipv6hint": {
            "type": "array",
            "minItems": 1,
            "description": "IPv6 addresses that clients can use to reach the service.",
            "items": {
              "type": "string",
              "format": "ipv6"
            },
            "example": [
              "2001:db8::1"
            ]
          },
          "additionalSvcParams": {
            "type": "object",
            "description": "Service parameters that don't have a field of their own.\n\nEach key is a service parameter name, such as `no-default-alpn`,\n`ech`, `mandatory`, `dohpath`, or `ohttp`, or the generic `keyNNNNN`\nform, where the number is from 0 to 65535. The API checks the key's\nformat but not whether the name is registered. Each\nvalue is the parameter's value in zone file format. Use `\"\"` for a\nparameter without a value, such as `no-default-alpn`.\n\nDon't put `alpn`, `port`, `ipv4hint`, or `ipv6hint` in the map. Use\ntheir own fields instead. The API returns `400` if the map contains\none of them.\n\nThe API also returns `400` if a key doesn't match the key format, if\na `keyNNNNN` number is more than 65535, or if a value is longer than\n4,096 characters or contains characters other than printable ASCII.\n",
            "propertyNames": {
              "pattern": "^(key[0-9]{1,5}|[a-z][a-z0-9]*(-[a-z0-9]+)*)$"
            },
            "additionalProperties": {
              "type": "string",
              "maxLength": 4096,
              "pattern": "^[\\x20-\\x7E]*$"
            },
            "example": {
              "no-default-alpn": "",
              "dohpath": "/dns-query{?dns}"
            }
          }
        },
        "example": {
          "priority": 1,
          "targetName": ".",
          "alpn": [
            "h2",
            "h3"
          ],
          "ipv4hint": [
            "192.0.2.10"
          ]
        }
      },
      "HttpsRdataItem": {
        "description": "Structured record data for an `HTTPS` record set, as defined in RFC 9460.",
        "allOf": [
          {
            "$ref": "#/components/schemas/HttpsSvcbRdata"
          },
          {
            "type": "object",
            "required": [
              "type"
            ],
            "properties": {
              "type": {
                "allOf": [
                  {
                    "$ref": "#/components/schemas/RdataType"
                  }
                ],
                "enum": [
                  "HTTPS"
                ]
              }
            }
          },
          {
            "if": {
              "required": [
                "priority"
              ],
              "properties": {
                "priority": {
                  "const": 0
                }
              }
            },
            "then": {
              "not": {
                "anyOf": [
                  {
                    "required": [
                      "alpn"
                    ]
                  },
                  {
                    "required": [
                      "port"
                    ]
                  },
                  {
                    "required": [
                      "ipv4hint"
                    ]
                  },
                  {
                    "required": [
                      "ipv6hint"
                    ]
                  },
                  {
                    "required": [
                      "additionalSvcParams"
                    ]
                  }
                ]
              }
            }
          }
        ],
        "example": {
          "type": "HTTPS",
          "priority": 1,
          "targetName": ".",
          "alpn": [
            "h2",
            "h3"
          ],
          "ipv4hint": [
            "192.0.2.10"
          ]
        }
      },
      "SvcbRdataItem": {
        "description": "Structured record data for an `SVCB` record set, as defined in RFC 9460.",
        "allOf": [
          {
            "$ref": "#/components/schemas/HttpsSvcbRdata"
          },
          {
            "type": "object",
            "required": [
              "type"
            ],
            "properties": {
              "type": {
                "allOf": [
                  {
                    "$ref": "#/components/schemas/RdataType"
                  }
                ],
                "enum": [
                  "SVCB"
                ]
              }
            }
          },
          {
            "if": {
              "required": [
                "priority"
              ],
              "properties": {
                "priority": {
                  "const": 0
                }
              }
            },
            "then": {
              "not": {
                "anyOf": [
                  {
                    "required": [
                      "alpn"
                    ]
                  },
                  {
                    "required": [
                      "port"
                    ]
                  },
                  {
                    "required": [
                      "ipv4hint"
                    ]
                  },
                  {
                    "required": [
                      "ipv6hint"
                    ]
                  },
                  {
                    "required": [
                      "additionalSvcParams"
                    ]
                  }
                ]
              }
            }
          }
        ],
        "example": {
          "type": "SVCB",
          "priority": 1,
          "targetName": "svc.example.net.",
          "alpn": [
            "h2"
          ],
          "ipv4hint": [
            "192.0.2.10"
          ]
        }
      },
      "RRSetRdataItem": {
        "description": "One structured record data item. `type` selects the item's fields and\nmust match the record set's `rrtype`.\n",
        "type": "object",
        "required": [
          "type"
        ],
        "properties": {
          "type": {
            "$ref": "#/components/schemas/RdataType"
          }
        },
        "oneOf": [
          {
            "$ref": "#/components/schemas/TlsaRdataItem"
          },
          {
            "$ref": "#/components/schemas/HttpsRdataItem"
          },
          {
            "$ref": "#/components/schemas/SvcbRdataItem"
          }
        ],
        "discriminator": {
          "propertyName": "type",
          "mapping": {
            "TLSA": "#/components/schemas/TlsaRdataItem",
            "HTTPS": "#/components/schemas/HttpsRdataItem",
            "SVCB": "#/components/schemas/SvcbRdataItem"
          }
        },
        "example": {
          "type": "TLSA",
          "certUsage": 3,
          "selector": 1,
          "matchingType": 1,
          "certificateData": "d2abde240d7cd3ee6b4b28c54df034b97983a1d16e8a410e4561cb106618e971"
        }
      },
      "RecordSource": {
        "type": "string",
        "enum": [
          "USER_DEFINED",
          "NSSET",
          "SYSTEM"
        ],
        "description": "Who created a record value.\n\n- `USER_DEFINED`: A user created the value.\n- `NSSET`: DigiCert DNS created the `NS` record from a Nameserver Set\n  bound to the zone.\n- `SYSTEM`: DigiCert DNS created the record, such as a default DMARC or\n  SPF `TXT` record that it adds when it creates the zone.\n",
        "example": "USER_DEFINED"
      },
      "MonitorProtocol": {
        "type": "string",
        "enum": [
          "HTTP",
          "HTTPS",
          "TCP",
          "UDP",
          "ICMP"
        ],
        "description": "The protocol of the health check. It selects which other `monitor` fields\napply.\n\n- `HTTP`: The check sends an HTTP request.\n- `HTTPS`: The check sends an HTTPS request.\n- `TCP`: The check opens a TCP connection.\n- `UDP`: The check sends a UDP payload.\n- `ICMP`: The check sends an ICMP ping.\n",
        "example": "HTTPS"
      },
      "MonitorRegion": {
        "type": "string",
        "enum": [
          "GLOBAL",
          "NA_EAST",
          "NA_WEST",
          "SOUTH_AMERICA",
          "EUROPE",
          "ASIA_PAC",
          "OCEANIA",
          "AFRICA"
        ],
        "default": "GLOBAL",
        "description": "The region that the health check runs from. The default is `GLOBAL`.\n\n- `GLOBAL`: The check runs from several monitoring locations, for\n  redundancy.\n- `NA_EAST`: The check runs from eastern North America.\n- `NA_WEST`: The check runs from western North America.\n- `SOUTH_AMERICA`: The check runs from South America.\n- `EUROPE`: The check runs from Europe.\n- `ASIA_PAC`: The check runs from Asia-Pacific.\n- `OCEANIA`: The check runs from Oceania.\n- `AFRICA`: The check runs from Africa.\n\nThe values are the same as a record set's `region`, but the setting is\nseparate. A regional record set's `region` controls which locations get\nthat record set in DNS answers. The monitor's `region` only controls\nwhere the check runs, and it doesn't change DNS answers. A\n`SIMPLE_FAILOVER` record set and its `monitor` can use different regions.\n\nMonitor regions don't have to be unique. A record set can use the same\nmonitor region as any other record set at the same owner name and record\ntype, including the `GLOBAL` record set.\n",
        "example": "GLOBAL"
      },
      "MonitorHttpItem": {
        "title": "HTTP or HTTPS",
        "description": "An HTTP or HTTPS health check. The check requests `path` on `host`. You\nset `host` separately from each endpoint's `target`.\n",
        "type": "object",
        "required": [
          "protocol",
          "host",
          "port",
          "path"
        ],
        "properties": {
          "protocol": {
            "allOf": [
              {
                "$ref": "#/components/schemas/MonitorProtocol"
              }
            ],
            "enum": [
              "HTTP",
              "HTTPS"
            ]
          },
          "region": {
            "$ref": "#/components/schemas/MonitorRegion"
          },
          "host": {
            "type": "string",
            "pattern": "^[A-Za-z0-9_.-]+$",
            "description": "The hostname that the check requests, without a scheme, port, path,\nor trailing dot. Up to 253 characters. Each label must start and end\nwith a letter or digit. The API returns `400` if the hostname isn't\nvalid.\n",
            "example": "www.example.com"
          },
          "port": {
            "type": "integer",
            "minimum": 1,
            "maximum": 65535,
            "description": "The TCP port that the check connects to.",
            "example": 443
          },
          "path": {
            "type": "string",
            "description": "The URL path that the check requests, for example `/health`.",
            "example": "/health"
          },
          "searchString": {
            "type": "string",
            "description": "Text that a healthy response body contains. If a 2xx response doesn't\ncontain the text, the check reports the endpoint as unhealthy.\n",
            "example": "OK"
          }
        },
        "additionalProperties": false,
        "example": {
          "protocol": "HTTPS",
          "region": "GLOBAL",
          "host": "www.example.com",
          "port": 443,
          "path": "/health",
          "searchString": "OK"
        }
      },
      "MonitorTcpItem": {
        "title": "TCP",
        "description": "A TCP health check. The check opens a TCP connection to each endpoint's\n`target` on `port`.\n",
        "type": "object",
        "required": [
          "protocol",
          "port"
        ],
        "properties": {
          "protocol": {
            "allOf": [
              {
                "$ref": "#/components/schemas/MonitorProtocol"
              }
            ],
            "enum": [
              "TCP"
            ]
          },
          "region": {
            "$ref": "#/components/schemas/MonitorRegion"
          },
          "port": {
            "type": "integer",
            "minimum": 1,
            "maximum": 65535,
            "description": "The TCP port that the check connects to.",
            "example": 53
          },
          "timeout": {
            "type": "integer",
            "minimum": 1,
            "description": "How long the check waits, in seconds, from 1 to 20. The API returns\n`400` for a value more than 20.\n",
            "example": 10
          }
        },
        "additionalProperties": false,
        "example": {
          "protocol": "TCP",
          "region": "GLOBAL",
          "port": 53,
          "timeout": 10
        }
      },
      "MonitorUdpItem": {
        "title": "UDP",
        "description": "A UDP health check. The check sends `sendString` to each endpoint's\n`target` on `port`.\n",
        "type": "object",
        "required": [
          "protocol",
          "port"
        ],
        "properties": {
          "protocol": {
            "allOf": [
              {
                "$ref": "#/components/schemas/MonitorProtocol"
              }
            ],
            "enum": [
              "UDP"
            ]
          },
          "region": {
            "$ref": "#/components/schemas/MonitorRegion"
          },
          "port": {
            "type": "integer",
            "minimum": 1,
            "maximum": 65535,
            "description": "The UDP port that the check sends to.",
            "example": 53
          },
          "sendString": {
            "type": "string",
            "description": "The payload that the check sends, up to 255 characters. Unlike\n`searchString` in an HTTP or HTTPS check, it's the request that the\ncheck sends, not text that it expects in the response.\n",
            "example": "PING"
          },
          "timeout": {
            "type": "integer",
            "minimum": 1,
            "description": "How long the check waits, in seconds, from 1 to 20. The API returns\n`400` for a value more than 20.\n",
            "example": 10
          }
        },
        "additionalProperties": false,
        "example": {
          "protocol": "UDP",
          "region": "GLOBAL",
          "port": 53,
          "sendString": "PING",
          "timeout": 10
        }
      },
      "MonitorIcmpItem": {
        "title": "ICMP",
        "description": "An ICMP health check. The check pings each endpoint's `target` directly.\nAn ICMP ping has no port, path, or response body, so no other fields\napply.\n",
        "type": "object",
        "required": [
          "protocol"
        ],
        "properties": {
          "protocol": {
            "allOf": [
              {
                "$ref": "#/components/schemas/MonitorProtocol"
              }
            ],
            "enum": [
              "ICMP"
            ]
          },
          "region": {
            "$ref": "#/components/schemas/MonitorRegion"
          }
        },
        "additionalProperties": false,
        "example": {
          "protocol": "ICMP",
          "region": "GLOBAL"
        }
      },
      "Monitor": {
        "description": "The health check for a record set that uses `SIMPLE_FAILOVER` routing.\nYou set it in the `routing` object, and it checks every endpoint in the\nfailover list. `protocol` selects the kind of check and the other fields\nthat apply:\n\n- `HTTP` and `HTTPS`: `host`, `port`, and `path` are required.\n  `searchString` is optional.\n- `TCP`: `port` is required. `timeout` is optional.\n- `UDP`: `port` is required. `sendString` and `timeout` are optional.\n- `ICMP`: No other fields apply, because an ICMP ping has no port, path,\n  or response body.\n",
        "type": "object",
        "required": [
          "protocol"
        ],
        "properties": {
          "protocol": {
            "$ref": "#/components/schemas/MonitorProtocol"
          }
        },
        "oneOf": [
          {
            "$ref": "#/components/schemas/MonitorHttpItem"
          },
          {
            "$ref": "#/components/schemas/MonitorTcpItem"
          },
          {
            "$ref": "#/components/schemas/MonitorUdpItem"
          },
          {
            "$ref": "#/components/schemas/MonitorIcmpItem"
          }
        ],
        "discriminator": {
          "propertyName": "protocol",
          "mapping": {
            "HTTP": "#/components/schemas/MonitorHttpItem",
            "HTTPS": "#/components/schemas/MonitorHttpItem",
            "TCP": "#/components/schemas/MonitorTcpItem",
            "UDP": "#/components/schemas/MonitorUdpItem",
            "ICMP": "#/components/schemas/MonitorIcmpItem"
          }
        },
        "example": {
          "protocol": "HTTPS",
          "region": "GLOBAL",
          "host": "www.example.com",
          "port": 443,
          "path": "/health",
          "searchString": "OK"
        }
      },
      "FailoverEndpoint": {
        "type": "object",
        "description": "An endpoint in a record set that uses `SIMPLE_FAILOVER` routing. The\n`monitor` checks the health of each enabled endpoint. DNS answers use\nthe enabled endpoint with the lowest `priority` number that isn't\n`Unhealthy`. If every enabled endpoint is `Unhealthy`, DNS answers use\nthe enabled endpoint with the lowest `priority` number as a last resort.\n`SIMPLE_FAILOVER` routing works only with `A` and `AAAA` record sets.\n",
        "required": [
          "target",
          "priority"
        ],
        "properties": {
          "target": {
            "type": "string",
            "pattern": "^\\S+$",
            "description": "The endpoint's IPv4 or IPv6 address. Use an IPv4 address in an `A`\nrecord set and an IPv6 address in an `AAAA` record set. The API\nreturns `400` if the address isn't a valid IP address.\n",
            "example": "192.0.2.10"
          },
          "priority": {
            "type": "integer",
            "minimum": 1,
            "description": "The endpoint's failover priority. A lower number is preferred. Each\nendpoint in the list must have a different priority. The API returns\n`422` if 2 endpoints have the same priority.\n",
            "example": 1
          },
          "isEnabled": {
            "type": "boolean",
            "default": true,
            "description": "Whether the endpoint is in rotation. A disabled endpoint stays in the\nfailover list, but the monitor doesn't check it and it doesn't serve\ntraffic. To take an endpoint out of rotation without deleting it, set\n`isEnabled` to `false`.\n",
            "example": true
          },
          "health": {
            "type": "string",
            "readOnly": true,
            "enum": [
              "Healthy",
              "Degraded",
              "Unhealthy"
            ],
            "description": "The endpoint's current health, as reported by the monitor. Present\nonly in responses. Omitted when `isEnabled` is `false`, because the\nmonitor doesn't check a disabled endpoint.\n\n- `Healthy`: The endpoint passes its health checks.\n- `Degraded`: The monitor reports a problem with the endpoint, but the\n  endpoint can still serve traffic.\n- `Unhealthy`: The endpoint fails its health checks.\n\nA new endpoint reports `Healthy` until the monitor records its first\nresults. There's no separate pending value, so the health can change\nshortly after you create the endpoint.\n",
            "example": "Healthy"
          },
          "isServing": {
            "type": "boolean",
            "readOnly": true,
            "description": "Whether the endpoint is serving traffic. The enabled endpoint with the\nlowest `priority` number that isn't `Unhealthy` serves, and the others\nare on standby. If every enabled endpoint is `Unhealthy`, the enabled\nendpoint with the lowest `priority` number serves as a last resort.\nAlways `false` for a disabled endpoint. Present only in responses.\n",
            "example": true
          }
        },
        "example": {
          "target": "192.0.2.10",
          "priority": 1,
          "isEnabled": true,
          "health": "Healthy",
          "isServing": true
        }
      },
      "RRSet": {
        "type": "object",
        "description": "A DNS record set: the records in a zone that share an owner name and a\nrecord type. The zone name, record type, and owner name identify the\nrecord set. All values in a record set share one TTL.\n\nThe fields in `routing` depend on `routing.policy`:\n\n- `NONE`: `routing.content` holds the values. `routing.rdata` also holds\n  them, as structured data, when every value is a `TLSA`, `HTTPS`, or\n  `SVCB` record. That's true whether the values were written with\n  `content` or with `rdata`.\n- `SIMPLE_FAILOVER`: `routing.monitor`, `routing.endpoints`, and\n  `routing.failureSensitivity` hold the failover settings. Only `A` and\n  `AAAA` record sets support `SIMPLE_FAILOVER`.\n\n**Regions**\n\nWhen the zone has regional views turned on\n(`advancedConfig.isRegionalViewEnabled`), each record set has a\n`region`. `GLOBAL` is the zone's base view. Any other region, such as\n`EUROPE` or `NA_EAST`, marks a regional record set that overrides the\n`GLOBAL` record set in that region.\n\nWhen you list record sets for a `region` that has an exclusion for a\nrecord set, the API returns the record set the exclusion applies to,\nwith `isExcluded` set to `true`, rather than leaving it out. If the\nregion has a regional record set, that's the one returned, with its own\n`region`. Otherwise it's the `GLOBAL` record set. The region serves no\nrecords for that owner name and record type, not even the record set\nshown. With `overrideRecordOnly=true`, the API leaves out the `GLOBAL`\nrecord sets, but keeps a regional record set that has `isExcluded` set to\n`true`.\n\n`isExcluded` can be `true` on a regional record set. That happens when\nthe region has both a regional record set and an exclusion: the\nexclusion disables the regional record set. When you get a record set\nfor a region, the API returns this shape too. If the region has no\nregional record set, the API returns the `GLOBAL` record set, with\n`isExcluded` set to `true` when the region has an exclusion. When you\nget, create, replace, or update a record set without a region, the\nresponse doesn't include `isExcluded`.\n",
        "required": [
          "zoneName",
          "name",
          "rrtype",
          "ttl",
          "routing"
        ],
        "properties": {
          "zoneName": {
            "type": "string",
            "description": "Fully qualified name of the zone that contains the record set.",
            "example": "example.com."
          },
          "name": {
            "type": "string",
            "description": "Fully qualified owner name of the record set, also called the host name.",
            "example": "www.example.com."
          },
          "rrtype": {
            "$ref": "#/components/schemas/RecordType"
          },
          "ttl": {
            "type": "integer",
            "minimum": 0,
            "description": "Time to live of every record in the set, in seconds.",
            "example": 300
          },
          "routing": {
            "type": "object",
            "description": "Routing settings of the record set. `policy` decides which other\nfields are present.\n",
            "required": [
              "policy"
            ],
            "properties": {
              "policy": {
                "$ref": "#/components/schemas/RoutingPolicy"
              },
              "status": {
                "type": "string",
                "readOnly": true,
                "enum": [
                  "Healthy",
                  "Degraded",
                  "Unhealthy"
                ],
                "description": "Health of the failover endpoints, for `SIMPLE_FAILOVER` record\nsets. The top-priority endpoint is the one with the lowest\n`priority` number. The API returns `status` in responses only.\n\n- `Healthy`: The top-priority endpoint is healthy or degraded, and\n  it's still the answer.\n- `Degraded`: The top-priority endpoint is unhealthy, and a\n  lower-priority endpoint is the answer.\n- `Unhealthy`: Every endpoint is unhealthy. The top-priority\n  endpoint is the answer as a last resort.\n\n`status` depends only on the top-priority endpoint. It can differ\nfrom a health summary that also counts lower-priority endpoints,\nfor example when only a standby endpoint is down. Don't treat the\ntwo as the same.\n\n`Degraded` means something different here than in an endpoint's\n`health`. Here, it means a lower-priority endpoint is the answer.\nIn `health`, it means the endpoint has a problem but still serves\ntraffic.\n"
              },
              "content": {
                "type": "array",
                "description": "Record values in BIND presentation format. Present when `policy`\nis `NONE`.\n",
                "items": {
                  "type": "string"
                },
                "example": [
                  "192.0.2.1",
                  "192.0.2.2"
                ]
              },
              "rdata": {
                "type": "array",
                "description": "The record values as structured data. Present when every value in\n`content` is a `TLSA`, `HTTPS`, or `SVCB` record, whether the\nvalues were written with `content` or with `rdata`.\n\n`rdata` has the same length and order as `content`, so `rdata[i]`\nis the same record as `content[i]`. The API derives both arrays\nfrom the same stored records, so they always match.\n\nDigiCert DNS sets the order. DNS record sets are\nunordered, so the API doesn't keep the order you sent the values\nin. Only the match between the two arrays is guaranteed.\n\nIf any value can't be shown as structured data, the API leaves out\n`rdata` for the whole record set rather than returning `null`\nitems. `content` always holds every value.\n",
                "items": {
                  "$ref": "#/components/schemas/RRSetRdataItem"
                }
              },
              "systemGenerated": {
                "type": "array",
                "description": "Who created each value. For `NONE` record sets, it's present only\nwhen the request includes `systemGeneratedStatus=true`, and the API\nleaves it out otherwise rather than returning `null` or an empty\narray. For `SIMPLE_FAILOVER` record sets, it's always present.\n\nFor `NONE` record sets, `systemGenerated` has the same length and\norder as `content`, so `systemGenerated[i]` describes\n`content[i]`. For `SIMPLE_FAILOVER` record sets, it has one\n`USER_DEFINED` entry for each item in `endpoints`, in the same\norder, because DigiCert DNS never creates failover endpoints.\n",
                "items": {
                  "$ref": "#/components/schemas/RecordSource"
                },
                "example": [
                  "USER_DEFINED",
                  "USER_DEFINED",
                  "NSSET"
                ]
              },
              "failureSensitivity": {
                "type": "string",
                "enum": [
                  "HIGH",
                  "MEDIUM",
                  "LOW"
                ],
                "description": "How quickly the monitor reacts when an endpoint fails. It sets\nboth how often the monitor checks each endpoint and how soon it\nmarks an endpoint unhealthy. Used when `policy` is\n`SIMPLE_FAILOVER`.\n\n- `HIGH`: The monitor checks most often and reacts fastest.\n- `MEDIUM`: The monitor checks and reacts at a rate between\n  `HIGH` and `LOW`.\n- `LOW`: The monitor checks least often and reacts most\n  cautiously.\n",
                "example": "MEDIUM"
              },
              "monitor": {
                "$ref": "#/components/schemas/Monitor",
                "description": "Health check settings. Present when `policy` is\n`SIMPLE_FAILOVER`.\n"
              },
              "endpoints": {
                "type": "array",
                "maxItems": 5,
                "description": "Failover endpoints. Present when `policy` is\n`SIMPLE_FAILOVER`.\n",
                "items": {
                  "$ref": "#/components/schemas/FailoverEndpoint"
                }
              }
            }
          },
          "region": {
            "type": "string",
            "enum": [
              "GLOBAL",
              "NA_EAST",
              "NA_WEST",
              "SOUTH_AMERICA",
              "EUROPE",
              "ASIA_PAC",
              "OCEANIA",
              "AFRICA"
            ],
            "description": "Region of the record set. Present only when the zone has regional\nviews turned on (`advancedConfig.isRegionalViewEnabled`). `GLOBAL` is\nthe zone's base view. Any other value marks a regional record set\nthat overrides the `GLOBAL` record set in that region.\n",
            "example": "GLOBAL"
          },
          "isExcluded": {
            "type": "boolean",
            "readOnly": true,
            "description": "Whether the queried region has an exclusion for the record set. When\nit's `true`, the region serves no records for the record set's owner\nname and record type, not even the record set that has the flag.\n\nThe API returns `isExcluded` only when you list record sets with\n`region`, or get a record set for a region, and that region has an\nexclusion for the record set. It's on the regional record set when\nthe region has one, and on the `GLOBAL` record set otherwise.\nOtherwise, the API leaves `isExcluded` out.\n",
            "example": true
          },
          "createdAt": {
            "type": "string",
            "format": "date-time",
            "readOnly": true,
            "description": "When the record set was created, as an RFC 3339 timestamp.",
            "example": "2026-06-05T14:00:00Z"
          },
          "updatedAt": {
            "type": "string",
            "format": "date-time",
            "readOnly": true,
            "description": "When the record set was last changed, as an RFC 3339 timestamp.",
            "example": "2026-06-05T14:00:00Z"
          }
        },
        "example": {
          "zoneName": "example.com.",
          "name": "www.example.com.",
          "rrtype": "A",
          "ttl": 300,
          "routing": {
            "policy": "NONE",
            "content": [
              "192.0.2.1",
              "192.0.2.2"
            ]
          },
          "createdAt": "2026-07-30T10:00:00Z",
          "updatedAt": "2026-07-30T10:00:00Z"
        }
      },
      "RRSetList": {
        "type": "object",
        "description": "A page of record sets that match the request, with pagination details.\n",
        "required": [
          "data",
          "pagination",
          "totalCount"
        ],
        "properties": {
          "data": {
            "type": "array",
            "description": "The record sets on the page.",
            "items": {
              "$ref": "#/components/schemas/RRSet"
            }
          },
          "pagination": {
            "$ref": "#/components/schemas/Pagination"
          },
          "totalCount": {
            "type": [
              "integer",
              "null"
            ],
            "format": "int64",
            "minimum": 0,
            "description": "Total number of record sets that match the request, across all pages.\nIt's `null` when the API doesn't compute an exact count for the query.\n"
          }
        }
      },
      "RRSetUpdateRequest": {
        "description": "The full replacement for the record set at the owner name and record\ntype in the path. The API removes every existing value and stores the\nvalues you send.\n\n`routing.policy` selects the fields to send:\n\n- `NONE`: Send exactly one of `routing.content` or `routing.rdata`.\n  `content` takes values in BIND presentation format, for any record\n  type. `rdata` takes structured data, for `TLSA`, `HTTPS`, and `SVCB`\n  record sets only. `NONE` is the default.\n- `SIMPLE_FAILOVER`: Send `routing.monitor` and `routing.endpoints`, and\n  don't send `content`. Only `A` and `AAAA` record sets support\n  `SIMPLE_FAILOVER`.\n\nPUT replaces the whole record set, so the API removes any routing field\nyou omit. To change only some fields, use PATCH.\n\n`ttl` is optional. If you omit it, `SOA` records get the TTL from your\naccount settings, and other record types get 900 seconds.\n",
        "type": "object",
        "required": [
          "routing"
        ],
        "properties": {
          "ttl": {
            "type": "integer",
            "minimum": 0,
            "description": "Time to live of every record in the set, in seconds. If you omit it,\n`SOA` records get the TTL from your account settings, and other\nrecord types get 900 seconds.\n",
            "example": 300
          },
          "routing": {
            "type": "object",
            "required": [
              "policy"
            ],
            "description": "Routing settings of the record set. `policy` decides which other\nfields are required.\n",
            "properties": {
              "policy": {
                "$ref": "#/components/schemas/RoutingPolicy"
              },
              "content": {
                "type": "array",
                "minItems": 1,
                "description": "Record values in BIND presentation format. Used when `policy` is\n`NONE`. Send exactly one of `content` or `rdata`.\n",
                "items": {
                  "type": "string"
                },
                "example": [
                  "192.0.2.1"
                ]
              },
              "rdata": {
                "type": "array",
                "minItems": 1,
                "description": "Record values as structured data, for `TLSA`, `HTTPS`, and `SVCB`\nrecord sets only. Used when `policy` is `NONE`. Send exactly one\nof `content` or `rdata`.\n",
                "items": {
                  "$ref": "#/components/schemas/RRSetRdataItem"
                }
              },
              "failureSensitivity": {
                "type": "string",
                "enum": [
                  "HIGH",
                  "MEDIUM",
                  "LOW"
                ],
                "default": "MEDIUM",
                "description": "How quickly the monitor reacts when an endpoint fails. It sets\nboth how often the monitor checks each endpoint and how soon it\nmarks an endpoint unhealthy. Used when `policy` is\n`SIMPLE_FAILOVER`.\n\n- `HIGH`: The monitor checks most often and reacts fastest.\n- `MEDIUM`: The monitor checks and reacts at a rate between\n  `HIGH` and `LOW`. This is the default.\n- `LOW`: The monitor checks least often and reacts most\n  cautiously.\n",
                "example": "MEDIUM"
              },
              "monitor": {
                "$ref": "#/components/schemas/Monitor"
              },
              "endpoints": {
                "type": "array",
                "minItems": 1,
                "maxItems": 5,
                "description": "Failover endpoints. Required when `policy` is\n`SIMPLE_FAILOVER`.\n",
                "items": {
                  "$ref": "#/components/schemas/FailoverEndpoint"
                }
              }
            }
          }
        },
        "if": {
          "properties": {
            "routing": {
              "properties": {
                "policy": {
                  "const": "NONE"
                }
              }
            }
          },
          "required": [
            "routing"
          ]
        },
        "then": {
          "properties": {
            "routing": {
              "required": [
                "policy"
              ],
              "anyOf": [
                {
                  "required": [
                    "content"
                  ]
                },
                {
                  "required": [
                    "rdata"
                  ]
                }
              ],
              "not": {
                "required": [
                  "content",
                  "rdata"
                ]
              }
            }
          }
        },
        "else": {
          "properties": {
            "routing": {
              "required": [
                "policy",
                "monitor",
                "endpoints"
              ]
            }
          }
        },
        "example": {
          "ttl": 300,
          "routing": {
            "policy": "NONE",
            "content": [
              "192.0.2.10"
            ]
          }
        }
      },
      "RRSetCreateRequest": {
        "description": "The record set to create. The path gives the owner name and record type,\nso don't repeat them in the body.\n\n`routing.policy` selects the fields to send:\n\n- `NONE`: Send exactly one of `routing.content` or `routing.rdata`.\n  `content` takes values in BIND presentation format, for any record\n  type. `rdata` takes structured data, for `TLSA`, `HTTPS`, and `SVCB`\n  record sets only. `NONE` is the default.\n- `SIMPLE_FAILOVER`: Send `routing.monitor` and `routing.endpoints`, and\n  don't send `content`. Only `A` and `AAAA` record sets support\n  `SIMPLE_FAILOVER`.\n\n`ttl` is optional. If you omit it, `SOA` records get the TTL from your\naccount settings, and other record types get 900 seconds.\n",
        "type": "object",
        "required": [
          "routing"
        ],
        "properties": {
          "ttl": {
            "type": "integer",
            "minimum": 0,
            "description": "Time to live of every record in the set, in seconds. If you omit it,\n`SOA` records get the TTL from your account settings, and other\nrecord types get 900 seconds.\n",
            "example": 300
          },
          "routing": {
            "type": "object",
            "required": [
              "policy"
            ],
            "description": "Routing settings of the record set. `policy` decides which other\nfields are required.\n",
            "properties": {
              "policy": {
                "$ref": "#/components/schemas/RoutingPolicy"
              },
              "content": {
                "type": "array",
                "minItems": 1,
                "description": "Record values in BIND presentation format. Used when `policy` is\n`NONE`. Send exactly one of `content` or `rdata`.\n",
                "items": {
                  "type": "string"
                },
                "example": [
                  "192.0.2.1"
                ]
              },
              "rdata": {
                "type": "array",
                "minItems": 1,
                "description": "Record values as structured data, for `TLSA`, `HTTPS`, and `SVCB`\nrecord sets only. Used when `policy` is `NONE`. Send exactly one\nof `content` or `rdata`.\n",
                "items": {
                  "$ref": "#/components/schemas/RRSetRdataItem"
                }
              },
              "failureSensitivity": {
                "type": "string",
                "enum": [
                  "HIGH",
                  "MEDIUM",
                  "LOW"
                ],
                "default": "MEDIUM",
                "description": "How quickly the monitor reacts when an endpoint fails. It sets\nboth how often the monitor checks each endpoint and how soon it\nmarks an endpoint unhealthy. Used when `policy` is\n`SIMPLE_FAILOVER`.\n\n- `HIGH`: The monitor checks most often and reacts fastest.\n- `MEDIUM`: The monitor checks and reacts at a rate between\n  `HIGH` and `LOW`. This is the default.\n- `LOW`: The monitor checks least often and reacts most\n  cautiously.\n",
                "example": "MEDIUM"
              },
              "monitor": {
                "$ref": "#/components/schemas/Monitor",
                "description": "Health check settings. Required when `policy` is\n`SIMPLE_FAILOVER`.\n"
              },
              "endpoints": {
                "type": "array",
                "minItems": 1,
                "maxItems": 5,
                "description": "Failover endpoints. Required when `policy` is\n`SIMPLE_FAILOVER`.\n",
                "items": {
                  "$ref": "#/components/schemas/FailoverEndpoint"
                }
              }
            }
          }
        },
        "if": {
          "properties": {
            "routing": {
              "properties": {
                "policy": {
                  "const": "NONE"
                }
              }
            }
          },
          "required": [
            "routing"
          ]
        },
        "then": {
          "properties": {
            "routing": {
              "required": [
                "policy"
              ],
              "anyOf": [
                {
                  "required": [
                    "content"
                  ]
                },
                {
                  "required": [
                    "rdata"
                  ]
                }
              ],
              "not": {
                "required": [
                  "content",
                  "rdata"
                ]
              }
            }
          }
        },
        "else": {
          "properties": {
            "routing": {
              "required": [
                "policy",
                "monitor",
                "endpoints"
              ]
            }
          }
        },
        "example": {
          "ttl": 300,
          "routing": {
            "policy": "NONE",
            "content": [
              "192.0.2.1"
            ]
          }
        }
      },
      "RRSetPatchRequest": {
        "type": "object",
        "description": "The changes to make to the record set. Send only the fields to change,\nas a JSON merge patch with the `application/json` content type. The API\nkeeps the fields you omit. It doesn't accept JSON Patch\n(`application/json-patch+json`).\n\nIf you send `routing`, it replaces the whole `routing` object. Include\n`policy` and every field that the policy needs. To change\n`routing.policy`, send all the fields for the new policy. The API clears\nthe fields that belong to the old policy.\n",
        "minProperties": 1,
        "properties": {
          "ttl": {
            "type": "integer",
            "minimum": 0,
            "description": "Time to live of every record in the set, in seconds. If you omit it,\nthe API keeps the current TTL.\n",
            "example": 600
          },
          "routing": {
            "type": "object",
            "description": "The new routing settings. If you send `routing`, it replaces the\nwhole `routing` object, so include `policy` and every field that the\npolicy needs.\n",
            "required": [
              "policy"
            ],
            "properties": {
              "policy": {
                "$ref": "#/components/schemas/RoutingPolicy"
              },
              "content": {
                "type": "array",
                "minItems": 1,
                "description": "The new record values in BIND presentation format. Used when\n`policy` is `NONE`. Send exactly one of `content` or `rdata`.\n",
                "items": {
                  "type": "string"
                },
                "example": [
                  "192.0.2.1",
                  "192.0.2.2"
                ]
              },
              "rdata": {
                "type": "array",
                "minItems": 1,
                "description": "The new record values as structured data, for `TLSA`, `HTTPS`, and\n`SVCB` record sets only. Used when `policy` is `NONE`. Send\nexactly one of `content` or `rdata`.\n",
                "items": {
                  "$ref": "#/components/schemas/RRSetRdataItem"
                }
              },
              "failureSensitivity": {
                "type": "string",
                "enum": [
                  "HIGH",
                  "MEDIUM",
                  "LOW"
                ],
                "description": "How quickly the monitor reacts when an endpoint fails. It sets\nboth how often the monitor checks each endpoint and how soon it\nmarks an endpoint unhealthy. Used when `policy` is\n`SIMPLE_FAILOVER`.\n\n- `HIGH`: The monitor checks most often and reacts fastest.\n- `MEDIUM`: The monitor checks and reacts at a rate between\n  `HIGH` and `LOW`.\n- `LOW`: The monitor checks least often and reacts most\n  cautiously.\n",
                "example": "MEDIUM"
              },
              "monitor": {
                "$ref": "#/components/schemas/Monitor"
              },
              "endpoints": {
                "type": "array",
                "minItems": 1,
                "maxItems": 5,
                "items": {
                  "$ref": "#/components/schemas/FailoverEndpoint"
                },
                "description": "Failover endpoints, up to 5. Used when `policy` is\n`SIMPLE_FAILOVER`.\n"
              }
            }
          }
        },
        "if": {
          "properties": {
            "routing": {
              "properties": {
                "policy": {
                  "const": "NONE"
                }
              }
            }
          },
          "required": [
            "routing"
          ]
        },
        "then": {
          "properties": {
            "routing": {
              "required": [
                "policy"
              ],
              "anyOf": [
                {
                  "required": [
                    "content"
                  ]
                },
                {
                  "required": [
                    "rdata"
                  ]
                }
              ],
              "not": {
                "required": [
                  "content",
                  "rdata"
                ]
              }
            }
          }
        },
        "else": {
          "if": {
            "required": [
              "routing"
            ]
          },
          "then": {
            "properties": {
              "routing": {
                "required": [
                  "policy",
                  "monitor",
                  "endpoints"
                ]
              }
            }
          }
        },
        "example": {
          "ttl": 600
        }
      },
      "ZoneRegionList": {
        "type": "object",
        "description": "The regions that have at least one record set in the zone. `regions`\nincludes `GLOBAL` when the zone has any `GLOBAL` record sets. The list\nis meaningful only for zones with `advancedConfig.isRegionalViewEnabled`\nset to `true`.\n",
        "required": [
          "regions"
        ],
        "properties": {
          "regions": {
            "type": "array",
            "items": {
              "type": "string",
              "enum": [
                "GLOBAL",
                "NA_EAST",
                "NA_WEST",
                "SOUTH_AMERICA",
                "EUROPE",
                "ASIA_PAC",
                "OCEANIA",
                "AFRICA"
              ]
            },
            "description": "Regions with at least one record set in the zone. Each region other\nthan `GLOBAL` has at least one regional record set.\n",
            "example": [
              "GLOBAL",
              "EUROPE",
              "ASIA_PAC"
            ]
          }
        },
        "example": {
          "regions": [
            "GLOBAL",
            "EUROPE",
            "ASIA_PAC"
          ]
        }
      },
      "RRSetRegionList": {
        "type": "object",
        "description": "The regions that have a record set or an exclusion for an owner name and\nrecord type. `regions` includes `GLOBAL` when the `GLOBAL` record set\nexists.\n",
        "required": [
          "regions"
        ],
        "properties": {
          "regions": {
            "type": "array",
            "items": {
              "type": "string",
              "enum": [
                "GLOBAL",
                "NA_EAST",
                "NA_WEST",
                "SOUTH_AMERICA",
                "EUROPE",
                "ASIA_PAC",
                "OCEANIA",
                "AFRICA"
              ]
            },
            "description": "Regions with a record set for the owner name and record type.\n`GLOBAL` stands for the `GLOBAL` record set. Each other region has a\nregional record set.\n",
            "example": [
              "GLOBAL",
              "EUROPE"
            ]
          },
          "excludedRegions": {
            "type": "array",
            "items": {
              "type": "string",
              "enum": [
                "NA_EAST",
                "NA_WEST",
                "SOUTH_AMERICA",
                "EUROPE",
                "ASIA_PAC",
                "OCEANIA",
                "AFRICA"
              ]
            },
            "description": "Regions with an exclusion for the owner name and record type. These\nregions serve no records for it, not even the `GLOBAL` record set.\n`excludedRegions` never includes `GLOBAL`, because the base view\ncan't be excluded. A region can be in both `excludedRegions` and\n`regions`: it has a regional record set, and an exclusion that\ndisables it.\n",
            "example": []
          }
        },
        "example": {
          "regions": [
            "GLOBAL",
            "EUROPE"
          ],
          "excludedRegions": []
        }
      },
      "RegionalRRSetUpdateRequest": {
        "description": "The full replacement for the regional record set at the owner name,\nrecord type, and region in the path. The API removes every existing\nvalue and stores the values you send. Regional record sets need a zone\nwith `advancedConfig.isRegionalViewEnabled` set to `true`.\n\n`routing.policy` selects the fields to send:\n\n- `NONE`: Send exactly one of `routing.content` or `routing.rdata`.\n  `content` takes values in BIND presentation format, for any record\n  type. `rdata` takes structured data, for `TLSA`, `HTTPS`, and `SVCB`\n  record sets only. `NONE` is the default.\n- `SIMPLE_FAILOVER`: Send `routing.monitor` and `routing.endpoints`, and\n  don't send `content`. Only `A` and `AAAA` record sets support\n  `SIMPLE_FAILOVER`.\n\nPUT replaces the whole regional record set, so the API removes any\nrouting field you omit. To change only some fields, use PATCH.\n\n`ttl` is optional. If you omit it, `SOA` records get the TTL from your\naccount settings, and other record types get 900 seconds.\n\nIf the region has an exclusion for the owner name and record type, the\nAPI returns `409`. Delete the exclusion first.\n",
        "type": "object",
        "required": [
          "routing"
        ],
        "properties": {
          "ttl": {
            "type": "integer",
            "minimum": 0,
            "description": "Time to live of every record in the set, in seconds. If you omit it,\n`SOA` records get the TTL from your account settings, and other\nrecord types get 900 seconds.\n",
            "example": 120
          },
          "routing": {
            "type": "object",
            "required": [
              "policy"
            ],
            "description": "Routing settings of the regional record set. `policy` decides which\nother fields are required.\n",
            "properties": {
              "policy": {
                "$ref": "#/components/schemas/RoutingPolicy"
              },
              "content": {
                "type": "array",
                "minItems": 1,
                "description": "Record values in BIND presentation format. Used when `policy` is\n`NONE`. Send exactly one of `content` or `rdata`.\n",
                "items": {
                  "type": "string"
                },
                "example": [
                  "192.0.2.24"
                ]
              },
              "rdata": {
                "type": "array",
                "minItems": 1,
                "description": "Record values as structured data, for `TLSA`, `HTTPS`, and `SVCB`\nrecord sets only. Used when `policy` is `NONE`. Send exactly one\nof `content` or `rdata`.\n",
                "items": {
                  "$ref": "#/components/schemas/RRSetRdataItem"
                }
              },
              "failureSensitivity": {
                "type": "string",
                "enum": [
                  "HIGH",
                  "MEDIUM",
                  "LOW"
                ],
                "default": "MEDIUM",
                "description": "How quickly the monitor reacts when an endpoint fails. It sets\nboth how often the monitor checks each endpoint and how soon it\nmarks an endpoint unhealthy. Used when `policy` is\n`SIMPLE_FAILOVER`.\n\n- `HIGH`: The monitor checks most often and reacts fastest.\n- `MEDIUM`: The monitor checks and reacts at a rate between\n  `HIGH` and `LOW`. This is the default.\n- `LOW`: The monitor checks least often and reacts most\n  cautiously.\n",
                "example": "HIGH"
              },
              "monitor": {
                "$ref": "#/components/schemas/Monitor"
              },
              "endpoints": {
                "type": "array",
                "minItems": 1,
                "maxItems": 5,
                "description": "Failover endpoints. Required when `policy` is\n`SIMPLE_FAILOVER`.\n",
                "items": {
                  "$ref": "#/components/schemas/FailoverEndpoint"
                }
              }
            }
          }
        },
        "if": {
          "properties": {
            "routing": {
              "properties": {
                "policy": {
                  "const": "NONE"
                }
              }
            }
          },
          "required": [
            "routing"
          ]
        },
        "then": {
          "properties": {
            "routing": {
              "required": [
                "policy"
              ],
              "anyOf": [
                {
                  "required": [
                    "content"
                  ]
                },
                {
                  "required": [
                    "rdata"
                  ]
                }
              ],
              "not": {
                "required": [
                  "content",
                  "rdata"
                ]
              }
            }
          }
        },
        "else": {
          "properties": {
            "routing": {
              "required": [
                "policy",
                "monitor",
                "endpoints"
              ]
            }
          }
        },
        "example": {
          "ttl": 120,
          "routing": {
            "policy": "NONE",
            "content": [
              "192.0.2.24"
            ]
          }
        }
      },
      "RegionalRRSet": {
        "type": "object",
        "description": "A regional record set: a record set that overrides the `GLOBAL` record\nset in one region. The zone name, record type, owner name, and region\nidentify it. The API returns it when you create, replace, or update a\nregional record set. Regional record sets need a zone with\n`advancedConfig.isRegionalViewEnabled` set to `true`.\n\nWhen you get a record set for a region, the response uses the general\nrecord set format, which can also hold the `GLOBAL` record set:\n\n- If the region has a regional record set, the API returns it, with\n  `region` set to the requested region. `isExcluded` is `true` when the\n  region has an exclusion, which disables this regional record set.\n- If it doesn't, but the `GLOBAL` record set exists, the API returns the\n  `GLOBAL` record set. `isExcluded` is `true` when the region has an\n  exclusion.\n- If neither exists, the API returns `404`.\n\nA regional record set uses the same `routing.policy` values as other\nrecord sets:\n\n- `NONE`: `routing.content` holds the values. `routing.rdata` also holds\n  them, as structured data, when every value is a `TLSA`, `HTTPS`, or\n  `SVCB` record.\n- `SIMPLE_FAILOVER`: `routing.monitor`, `routing.endpoints`,\n  `routing.failureSensitivity`, `routing.status`, and\n  `routing.systemGenerated` hold the failover settings and state.\n\nThe `GLOBAL` record set for the same owner name and record type is a\nseparate resource. Get and change it at the path without a region.\n\nA region can also have an exclusion. The region then serves no records\nfor the owner name and record type. If the region has a regional record\nset, the exclusion disables it. Otherwise it suppresses the `GLOBAL`\nrecord set. Deleting the `GLOBAL` record set doesn't delete the regional\nrecord set. The API returns `409` if you create or change a regional\nrecord set in a region with an exclusion. Remove the exclusion first.\n",
        "required": [
          "zoneName",
          "name",
          "rrtype",
          "ttl",
          "routing",
          "region"
        ],
        "properties": {
          "zoneName": {
            "type": "string",
            "description": "Fully qualified name of the zone that contains the record set.",
            "example": "example.com."
          },
          "name": {
            "type": "string",
            "description": "Fully qualified owner name of the record set, also called the host name.",
            "example": "www.example.com."
          },
          "rrtype": {
            "$ref": "#/components/schemas/RecordType"
          },
          "ttl": {
            "type": "integer",
            "minimum": 0,
            "description": "Time to live of every record in the set, in seconds.",
            "example": 120
          },
          "routing": {
            "type": "object",
            "description": "Routing settings of the regional record set. `policy` decides which\nother fields are present.\n",
            "required": [
              "policy"
            ],
            "properties": {
              "policy": {
                "$ref": "#/components/schemas/RoutingPolicy"
              },
              "status": {
                "type": "string",
                "readOnly": true,
                "enum": [
                  "Healthy",
                  "Degraded",
                  "Unhealthy"
                ],
                "description": "Health of the failover endpoints, for `SIMPLE_FAILOVER` record\nsets. The top-priority endpoint is the one with the lowest\n`priority` number. The API returns `status` in responses only.\n\n- `Healthy`: The top-priority endpoint is healthy or degraded, and\n  it's still the answer.\n- `Degraded`: The top-priority endpoint is unhealthy, and a\n  lower-priority endpoint is the answer.\n- `Unhealthy`: Every endpoint is unhealthy. The top-priority\n  endpoint is the answer as a last resort.\n\n`status` depends only on the top-priority endpoint. It can differ\nfrom a health summary that also counts lower-priority endpoints,\nfor example when only a standby endpoint is down. Don't treat the\ntwo as the same.\n\n`Degraded` means something different here than in an endpoint's\n`health`. Here, it means a lower-priority endpoint is the answer.\nIn `health`, it means the endpoint has a problem but still serves\ntraffic.\n"
              },
              "content": {
                "type": "array",
                "description": "Record values in BIND presentation format. Present when `policy`\nis `NONE`.\n",
                "items": {
                  "type": "string"
                },
                "example": [
                  "192.0.2.23"
                ]
              },
              "rdata": {
                "type": "array",
                "description": "The record values as structured data. Present when every value in\n`content` is a `TLSA`, `HTTPS`, or `SVCB` record, whether the\nvalues were written with `content` or with `rdata`.\n\n`rdata` has the same length and order as `content`, so `rdata[i]`\nis the same record as `content[i]`. The API derives both arrays\nfrom the same stored records, so they always match.\n\nDigiCert DNS sets the order. DNS record sets are\nunordered, so the API doesn't keep the order you sent the values\nin. Only the match between the two arrays is guaranteed.\n\nIf any value can't be shown as structured data, the API leaves out\n`rdata` for the whole record set rather than returning `null`\nitems. `content` always holds every value.\n",
                "items": {
                  "$ref": "#/components/schemas/RRSetRdataItem"
                }
              },
              "systemGenerated": {
                "type": "array",
                "description": "Who created each value. For `NONE` record sets, the API leaves\n`systemGenerated` out, because the requests that return a\nregional record set don't accept `systemGeneratedStatus`. For\n`SIMPLE_FAILOVER` record sets, it's always present, with one\n`USER_DEFINED` entry for each item in `endpoints`, in the same\norder, because DigiCert DNS never creates failover endpoints.\n",
                "items": {
                  "$ref": "#/components/schemas/RecordSource"
                },
                "example": [
                  "USER_DEFINED",
                  "USER_DEFINED"
                ]
              },
              "failureSensitivity": {
                "type": "string",
                "enum": [
                  "HIGH",
                  "MEDIUM",
                  "LOW"
                ],
                "description": "How quickly the monitor reacts when an endpoint fails. It sets\nboth how often the monitor checks each endpoint and how soon it\nmarks an endpoint unhealthy. Used when `policy` is\n`SIMPLE_FAILOVER`.\n\n- `HIGH`: The monitor checks most often and reacts fastest.\n- `MEDIUM`: The monitor checks and reacts at a rate between\n  `HIGH` and `LOW`.\n- `LOW`: The monitor checks least often and reacts most\n  cautiously.\n",
                "example": "HIGH"
              },
              "monitor": {
                "$ref": "#/components/schemas/Monitor",
                "description": "Health check settings. Present when `policy` is\n`SIMPLE_FAILOVER`.\n"
              },
              "endpoints": {
                "type": "array",
                "maxItems": 5,
                "description": "Failover endpoints. Present when `policy` is\n`SIMPLE_FAILOVER`.\n",
                "items": {
                  "$ref": "#/components/schemas/FailoverEndpoint"
                }
              }
            }
          },
          "region": {
            "type": "string",
            "enum": [
              "NA_EAST",
              "NA_WEST",
              "SOUTH_AMERICA",
              "EUROPE",
              "ASIA_PAC",
              "OCEANIA",
              "AFRICA"
            ],
            "description": "Region of the regional record set. It's never `GLOBAL`, because the\n`GLOBAL` record set is a separate resource at the path without a\nregion.\n",
            "example": "EUROPE"
          },
          "createdAt": {
            "type": "string",
            "format": "date-time",
            "readOnly": true,
            "description": "When the record set was created, as an RFC 3339 timestamp.",
            "example": "2026-07-30T10:00:00Z"
          },
          "updatedAt": {
            "type": "string",
            "format": "date-time",
            "readOnly": true,
            "description": "When the record set was last changed, as an RFC 3339 timestamp.",
            "example": "2026-07-30T10:00:00Z"
          }
        },
        "example": {
          "zoneName": "example.com.",
          "name": "www.example.com.",
          "rrtype": "A",
          "ttl": 120,
          "routing": {
            "policy": "NONE",
            "content": [
              "192.0.2.23"
            ]
          },
          "region": "EUROPE",
          "createdAt": "2026-07-30T10:00:00Z",
          "updatedAt": "2026-07-30T10:00:00Z"
        }
      },
      "RegionalRRSetCreateRequest": {
        "description": "The regional record set to create. The path gives the owner name, record\ntype, and region, so don't repeat them in the body. Regional record sets\nneed a zone with `advancedConfig.isRegionalViewEnabled` set to `true`.\n\n`routing.policy` selects the fields to send:\n\n- `NONE`: Send exactly one of `routing.content` or `routing.rdata`.\n  `content` takes values in BIND presentation format, for any record\n  type. `rdata` takes structured data, for `TLSA`, `HTTPS`, and `SVCB`\n  record sets only. `NONE` is the default.\n- `SIMPLE_FAILOVER`: Send `routing.monitor` and `routing.endpoints`, and\n  don't send `content`. Only `A` and `AAAA` record sets support\n  `SIMPLE_FAILOVER`.\n\nTo create the `GLOBAL` record set for the same owner name and record\ntype, use the path without a region.\n\n`ttl` is optional. If you omit it, `SOA` records get the TTL from your\naccount settings, and other record types get 900 seconds.\n\nIf the region has an exclusion for the owner name and record type, the\nAPI returns `409`. Delete the exclusion first.\n",
        "type": "object",
        "required": [
          "routing"
        ],
        "properties": {
          "ttl": {
            "type": "integer",
            "minimum": 0,
            "description": "Time to live of every record in the set, in seconds. If you omit it,\n`SOA` records get the TTL from your account settings, and other\nrecord types get 900 seconds.\n",
            "example": 120
          },
          "routing": {
            "type": "object",
            "required": [
              "policy"
            ],
            "description": "Routing settings of the regional record set. `policy` decides which\nother fields are required.\n",
            "properties": {
              "policy": {
                "$ref": "#/components/schemas/RoutingPolicy"
              },
              "content": {
                "type": "array",
                "minItems": 1,
                "description": "Record values in BIND presentation format. Used when `policy` is\n`NONE`. Send exactly one of `content` or `rdata`.\n",
                "items": {
                  "type": "string"
                },
                "example": [
                  "192.0.2.23"
                ]
              },
              "rdata": {
                "type": "array",
                "minItems": 1,
                "description": "Record values as structured data, for `TLSA`, `HTTPS`, and `SVCB`\nrecord sets only. Used when `policy` is `NONE`. Send exactly one\nof `content` or `rdata`.\n",
                "items": {
                  "$ref": "#/components/schemas/RRSetRdataItem"
                }
              },
              "failureSensitivity": {
                "type": "string",
                "enum": [
                  "HIGH",
                  "MEDIUM",
                  "LOW"
                ],
                "default": "MEDIUM",
                "description": "How quickly the monitor reacts when an endpoint fails. It sets\nboth how often the monitor checks each endpoint and how soon it\nmarks an endpoint unhealthy. Used when `policy` is\n`SIMPLE_FAILOVER`.\n\n- `HIGH`: The monitor checks most often and reacts fastest.\n- `MEDIUM`: The monitor checks and reacts at a rate between\n  `HIGH` and `LOW`. This is the default.\n- `LOW`: The monitor checks least often and reacts most\n  cautiously.\n",
                "example": "HIGH"
              },
              "monitor": {
                "$ref": "#/components/schemas/Monitor",
                "description": "Health check settings. Required when `policy` is\n`SIMPLE_FAILOVER`.\n"
              },
              "endpoints": {
                "type": "array",
                "minItems": 1,
                "maxItems": 5,
                "description": "Failover endpoints. Required when `policy` is\n`SIMPLE_FAILOVER`.\n",
                "items": {
                  "$ref": "#/components/schemas/FailoverEndpoint"
                }
              }
            }
          }
        },
        "if": {
          "properties": {
            "routing": {
              "properties": {
                "policy": {
                  "const": "NONE"
                }
              }
            }
          },
          "required": [
            "routing"
          ]
        },
        "then": {
          "properties": {
            "routing": {
              "required": [
                "policy"
              ],
              "anyOf": [
                {
                  "required": [
                    "content"
                  ]
                },
                {
                  "required": [
                    "rdata"
                  ]
                }
              ],
              "not": {
                "required": [
                  "content",
                  "rdata"
                ]
              }
            }
          }
        },
        "else": {
          "properties": {
            "routing": {
              "required": [
                "policy",
                "monitor",
                "endpoints"
              ]
            }
          }
        },
        "example": {
          "ttl": 120,
          "routing": {
            "policy": "NONE",
            "content": [
              "192.0.2.23"
            ]
          }
        }
      },
      "RegionalRRSetPatchRequest": {
        "type": "object",
        "description": "The changes to make to the regional record set. Send only the fields to\nchange, as a JSON merge patch with the `application/json` content type.\nThe API keeps the fields you omit. It doesn't accept JSON Patch\n(`application/json-patch+json`). Regional record sets need a zone with\n`advancedConfig.isRegionalViewEnabled` set to `true`.\n\nIf you send `routing`, it replaces the whole `routing` object. Include\n`policy` and every field that the policy needs.\n\nIf the region has an exclusion for the owner name and record type, the\nAPI returns `409`. Delete the exclusion first.\n",
        "minProperties": 1,
        "properties": {
          "ttl": {
            "type": "integer",
            "minimum": 0,
            "description": "Time to live of every record in the set, in seconds. If you omit it,\nthe API keeps the current TTL.\n",
            "example": 60
          },
          "routing": {
            "type": "object",
            "description": "The new routing settings. If you send `routing`, it replaces the\nwhole `routing` object, so include `policy` and every field that the\npolicy needs.\n",
            "required": [
              "policy"
            ],
            "properties": {
              "policy": {
                "$ref": "#/components/schemas/RoutingPolicy"
              },
              "content": {
                "type": "array",
                "minItems": 1,
                "description": "The new record values in BIND presentation format. Used when\n`policy` is `NONE`. Send exactly one of `content` or `rdata`.\n",
                "items": {
                  "type": "string"
                },
                "example": [
                  "192.0.2.23"
                ]
              },
              "rdata": {
                "type": "array",
                "minItems": 1,
                "description": "The new record values as structured data, for `TLSA`, `HTTPS`, and\n`SVCB` record sets only. Used when `policy` is `NONE`. Send\nexactly one of `content` or `rdata`.\n",
                "items": {
                  "$ref": "#/components/schemas/RRSetRdataItem"
                }
              },
              "failureSensitivity": {
                "type": "string",
                "enum": [
                  "HIGH",
                  "MEDIUM",
                  "LOW"
                ],
                "description": "How quickly the monitor reacts when an endpoint fails. It sets\nboth how often the monitor checks each endpoint and how soon it\nmarks an endpoint unhealthy. Used when `policy` is\n`SIMPLE_FAILOVER`.\n\n- `HIGH`: The monitor checks most often and reacts fastest.\n- `MEDIUM`: The monitor checks and reacts at a rate between\n  `HIGH` and `LOW`.\n- `LOW`: The monitor checks least often and reacts most\n  cautiously.\n",
                "example": "HIGH"
              },
              "monitor": {
                "$ref": "#/components/schemas/Monitor"
              },
              "endpoints": {
                "type": "array",
                "minItems": 1,
                "maxItems": 5,
                "items": {
                  "$ref": "#/components/schemas/FailoverEndpoint"
                },
                "description": "Failover endpoints, up to 5. Used when `policy` is\n`SIMPLE_FAILOVER`.\n"
              }
            }
          }
        },
        "if": {
          "properties": {
            "routing": {
              "properties": {
                "policy": {
                  "const": "NONE"
                }
              }
            }
          },
          "required": [
            "routing"
          ]
        },
        "then": {
          "properties": {
            "routing": {
              "required": [
                "policy"
              ],
              "anyOf": [
                {
                  "required": [
                    "content"
                  ]
                },
                {
                  "required": [
                    "rdata"
                  ]
                }
              ],
              "not": {
                "required": [
                  "content",
                  "rdata"
                ]
              }
            }
          }
        },
        "else": {
          "if": {
            "required": [
              "routing"
            ]
          },
          "then": {
            "properties": {
              "routing": {
                "required": [
                  "policy",
                  "monitor",
                  "endpoints"
                ]
              }
            }
          }
        },
        "example": {
          "ttl": 60
        }
      },
      "RRSetRegionExclusionRequest": {
        "type": "object",
        "description": "The empty request body for adding an exclusion. The path identifies the\nrecord set and the region, so the body has no fields. Send an empty\nobject, `{}`, or omit the body.\n",
        "additionalProperties": false
      },
      "AsyncTaskWithResource": {
        "allOf": [
          {
            "$ref": "#/components/schemas/AsyncTask"
          },
          {
            "type": "object",
            "properties": {
              "resourceUrl": {
                "type": "string",
                "format": "uri",
                "description": "The URL of the main resource that the task created or changed. It's present when the\nstatus is `SUCCEEDED` and there's a resource to retrieve. For a zone task such as an\nimport, it's the zone's URL. For an export, it's the URL to download the file from.\n",
                "examples": [
                  "https://api.dns.digicert.com/v1/zones/example.com.",
                  "https://storage.dns.digicert.com/exports/550e8400-e29b-41d4-a716-446655440000/zone-export.txt"
                ]
              }
            }
          }
        ]
      },
      "UsageMetrics": {
        "type": "object",
        "description": "Usage counts for a period, which is a month or a day.\n",
        "required": [
          "zones",
          "records",
          "queryResponses",
          "primaryZoneQueryResponses",
          "secondaryZoneQueryResponses",
          "failoverRecords",
          "regionalViewRecords",
          "users"
        ],
        "properties": {
          "zones": {
            "type": "integer",
            "format": "int64",
            "minimum": 0,
            "description": "The number of zones in your account for the period."
          },
          "records": {
            "type": "integer",
            "format": "int64",
            "minimum": 0,
            "description": "The total number of DNS records in your account for the period."
          },
          "queryResponses": {
            "type": "integer",
            "format": "int64",
            "minimum": 0,
            "description": "The total number of DNS query responses for your account in the period."
          },
          "primaryZoneQueryResponses": {
            "type": "integer",
            "format": "int64",
            "minimum": 0,
            "description": "The number of query responses that `PRIMARY` zones served in the period. A period\nwithout a breakdown by zone type reports `0` for both `primaryZoneQueryResponses` and\n`secondaryZoneQueryResponses`. Otherwise, the two add up to `queryResponses`.\n",
            "example": 1800000
          },
          "secondaryZoneQueryResponses": {
            "type": "integer",
            "format": "int64",
            "minimum": 0,
            "description": "The number of query responses that `SECONDARY` zones served in the period. A period\nwithout a breakdown by zone type reports `0` for both `primaryZoneQueryResponses` and\n`secondaryZoneQueryResponses`. Otherwise, the two add up to `queryResponses`.\n",
            "example": 125000
          },
          "failoverRecords": {
            "type": "integer",
            "format": "int64",
            "minimum": 0,
            "description": "The number of records with simple failover configured."
          },
          "regionalViewRecords": {
            "type": "integer",
            "format": "int64",
            "minimum": 0,
            "description": "The number of records with a regional view configured, which gives the record a\nregion-specific override.\n"
          },
          "users": {
            "type": "integer",
            "format": "int64",
            "minimum": 0,
            "description": "The number of users on your account for the period."
          }
        }
      },
      "UsagePeriodMetrics": {
        "type": "object",
        "description": "Usage for one month.\n",
        "required": [
          "month",
          "zones",
          "records",
          "queryResponses",
          "primaryZoneQueryResponses",
          "secondaryZoneQueryResponses",
          "failoverRecords",
          "regionalViewRecords",
          "users"
        ],
        "allOf": [
          {
            "$ref": "#/components/schemas/UsageMetrics"
          }
        ],
        "properties": {
          "month": {
            "type": "string",
            "pattern": "^[0-9]{4}-(0[1-9]|1[0-2])$",
            "description": "The calendar month, in `YYYY-MM` format.",
            "example": "2026-06"
          }
        }
      },
      "UsageMonthlySummaryResponse": {
        "type": "object",
        "description": "Monthly usage for your account, most recent month first.\n",
        "required": [
          "data"
        ],
        "properties": {
          "data": {
            "type": "array",
            "minItems": 0,
            "maxItems": 13,
            "description": "One entry for each month, for the current month and up to 12 prior months.\n",
            "items": {
              "$ref": "#/components/schemas/UsagePeriodMetrics"
            }
          }
        }
      },
      "UsageDailyMetrics": {
        "type": "object",
        "description": "Usage for one day.\n",
        "required": [
          "date",
          "zones",
          "records",
          "queryResponses",
          "primaryZoneQueryResponses",
          "secondaryZoneQueryResponses",
          "failoverRecords",
          "regionalViewRecords",
          "users"
        ],
        "allOf": [
          {
            "$ref": "#/components/schemas/UsageMetrics"
          }
        ],
        "properties": {
          "date": {
            "type": "string",
            "format": "date",
            "description": "The calendar date, in `YYYY-MM-DD` format.",
            "example": "2026-06-01"
          }
        }
      },
      "UsageDailyByMonthResponse": {
        "type": "object",
        "description": "Daily usage for one calendar month.\n",
        "required": [
          "month",
          "data"
        ],
        "properties": {
          "month": {
            "type": "string",
            "pattern": "^[0-9]{4}-(0[1-9]|1[0-2])$",
            "description": "The calendar month, in `YYYY-MM` format.",
            "example": "2026-06"
          },
          "data": {
            "type": "array",
            "minItems": 0,
            "description": "One entry for each day of the month, oldest first. A day without usage data,\nincluding a day that hasn't happened yet, has every count set to `0`.\n",
            "items": {
              "$ref": "#/components/schemas/UsageDailyMetrics"
            }
          }
        }
      },
      "ZoneMonthlyQueryVolumeRequest": {
        "type": "object",
        "description": "The filters, sort order, and page to use for a monthly query volume report. They're in\nthe request body rather than in query parameters because each page comes from its own\ntask. To get another page, submit the request again with `pageToken` set.\n",
        "additionalProperties": false,
        "properties": {
          "zoneName": {
            "type": "string",
            "minLength": 1,
            "maxLength": 255,
            "description": "Text to search for in zone names. The report includes zones whose fully qualified\nname contains the text. The match is case-insensitive, and a trailing dot is\noptional. For example, `example.com` matches `example.com.` and `my-example.com.`.\n",
            "example": "example.com"
          },
          "zoneType": {
            "type": "string",
            "enum": [
              "PRIMARY",
              "SECONDARY"
            ],
            "description": "The zone type to include in the report. When omitted, the report includes both\n`PRIMARY` and `SECONDARY` zones.\n",
            "example": "PRIMARY"
          },
          "month": {
            "type": "string",
            "pattern": "^[0-9]{4}-(0[1-9]|1[0-2])$",
            "description": "The calendar month, in `YYYY-MM` format, that the `queryCount` filter and\n`sortBy=queryCount` use.\n\n`month` is required when you send `queryCount` or set `sortBy` to `queryCount`. The\nAPI returns `400` if it's missing. The month must be the current month or one of the\n12 prior months. The API returns `400` for any other month.\n\n`month` affects filtering and sorting only. Each zone in the report still has its\nfull `months` list.\n",
            "example": "2026-05"
          },
          "queryCount": {
            "type": "object",
            "additionalProperties": false,
            "properties": {
              "gte": {
                "type": "integer",
                "format": "int64",
                "minimum": 0,
                "description": "Minimum query count, inclusive."
              },
              "lte": {
                "type": "integer",
                "format": "int64",
                "minimum": 0,
                "description": "Maximum query count, inclusive."
              },
              "gt": {
                "type": "integer",
                "format": "int64",
                "minimum": 0,
                "description": "Minimum query count, exclusive. The query count must be greater than the number.\n"
              },
              "lt": {
                "type": "integer",
                "format": "int64",
                "minimum": 0,
                "description": "Maximum query count, exclusive. The query count must be less than the number.\n"
              },
              "eq": {
                "type": "integer",
                "format": "int64",
                "minimum": 0,
                "description": "Exact query count."
              }
            },
            "description": "Range of query counts to match, for the month in `month`. Send one or more of the\noperators `gte`, `lte`, `gt`, `lt`, and `eq`. A zone matches when its query count\nmeets every operator you send. For example, `{\"gte\": 1000, \"lt\": 5000}` matches\nquery counts from 1000 up to but not including 5000.\n\n`month` is **required** when you send `queryCount`. The API returns `400` if it's\nmissing. The API also returns `400` if the operators can't all match at once, such as\nan inverted range or an `eq` value outside the range, and for invalid values.\n"
          },
          "sortBy": {
            "type": "string",
            "enum": [
              "zoneName",
              "zoneType",
              "queryCount"
            ],
            "default": "zoneName",
            "description": "Field to sort the report by.\n\n- `zoneName`: The fully qualified zone name, alphabetically. This is the default.\n- `zoneType`: The zone type. With `sortOrder=asc`, `PRIMARY` zones come before\n  `SECONDARY` zones. Zones of the same type are sorted by `zoneName`.\n- `queryCount`: The zone's query count for the month in `month`. `month` is\n  **required** with this key. The API returns `400` if it's missing.\n",
            "example": "queryCount"
          },
          "sortOrder": {
            "type": "string",
            "enum": [
              "asc",
              "desc"
            ],
            "default": "asc",
            "description": "Sort direction, `asc` or `desc`. The default is `asc`, which sorts `zoneName` and\n`zoneType` from A to Z, and `queryCount` from lowest to highest.\n",
            "example": "desc"
          },
          "pageToken": {
            "type": "string",
            "maxLength": 1024,
            "description": "An opaque cursor from a previous report's `pagination.nextPageToken`. Send it to get\nthat page. Omit it to get the first page.\n"
          },
          "pageSize": {
            "type": "integer",
            "minimum": 1,
            "maximum": 100,
            "default": 25,
            "description": "The maximum number of zones to return in a page, from 1 to 100. The default is 25."
          }
        }
      },
      "ZoneMonthlyQueryCount": {
        "type": "object",
        "description": "A zone's query count for one month.\n",
        "required": [
          "month",
          "queryCount"
        ],
        "properties": {
          "month": {
            "type": "string",
            "pattern": "^[0-9]{4}-(0[1-9]|1[0-2])$",
            "description": "The calendar month, in `YYYY-MM` format.",
            "example": "2026-05"
          },
          "queryCount": {
            "type": "integer",
            "format": "int64",
            "minimum": 0,
            "description": "The total number of query responses for the zone in the month.",
            "example": 36394938
          }
        }
      },
      "ZoneQueryVolumeEntry": {
        "type": "object",
        "description": "A zone's query volume, by month.\n",
        "required": [
          "zoneName",
          "zoneType",
          "months"
        ],
        "properties": {
          "zoneName": {
            "type": "string",
            "description": "The zone name, fully qualified.",
            "example": "example.com"
          },
          "zoneType": {
            "$ref": "#/components/schemas/ZoneType"
          },
          "months": {
            "type": "array",
            "minItems": 0,
            "maxItems": 13,
            "description": "The zone's query counts by month, most recent month first. They cover the current\nmonth and up to 12 prior months.\n",
            "items": {
              "$ref": "#/components/schemas/ZoneMonthlyQueryCount"
            }
          }
        },
        "example": {
          "zoneName": "example.com",
          "zoneType": "PRIMARY",
          "months": [
            {
              "month": "2026-06",
              "queryCount": 41582301
            },
            {
              "month": "2026-05",
              "queryCount": 36394938
            },
            {
              "month": "2026-04",
              "queryCount": 33810774
            }
          ]
        }
      },
      "ReportZoneMonthlyQueryVolumeResult": {
        "type": "object",
        "description": "One page of a monthly query volume report, grouped by zone.\n\nEach entry has the zone name, the zone type, and the zone's query counts by month, most\nrecent month first. The report covers the current month and up to 12 prior months.\n",
        "required": [
          "data",
          "pagination"
        ],
        "properties": {
          "data": {
            "type": "array",
            "minItems": 0,
            "description": "The zones in the page, ordered by the request's `sortBy` and `sortOrder`.",
            "items": {
              "$ref": "#/components/schemas/ZoneQueryVolumeEntry"
            }
          },
          "pagination": {
            "$ref": "#/components/schemas/Pagination"
          }
        },
        "example": {
          "data": [
            {
              "zoneName": "example.com",
              "zoneType": "PRIMARY",
              "months": [
                {
                  "month": "2026-06",
                  "queryCount": 41582301
                },
                {
                  "month": "2026-05",
                  "queryCount": 36394938
                },
                {
                  "month": "2026-04",
                  "queryCount": 33810774
                }
              ]
            },
            {
              "zoneName": "backup.example.com",
              "zoneType": "SECONDARY",
              "months": [
                {
                  "month": "2026-06",
                  "queryCount": 1204773
                },
                {
                  "month": "2026-05",
                  "queryCount": 998210
                },
                {
                  "month": "2026-04",
                  "queryCount": 874002
                }
              ]
            }
          ],
          "pagination": {
            "nextPageToken": "eyJvIjoyNX0",
            "prevPageToken": null,
            "firstPageToken": null,
            "lastPageToken": null,
            "hasMore": true
          }
        }
      },
      "EntitlementType": {
        "type": "string",
        "description": "The resource that the entitlement allocates.\n\n- `QPM`: The number of DNS queries per minute.\n- `ZONES`: The number of zones.\n- `RECORDS`: The total number of DNS records.\n- `USERS`: The number of user seats.\n- `FAILOVER_RECORDS`: The number of records that can have simple failover\n  configured.\n- `REGIONAL_VIEW_RECORDS`: The number of records that can have a regional\n  view configured.\n",
        "enum": [
          "QPM",
          "ZONES",
          "RECORDS",
          "USERS",
          "FAILOVER_RECORDS",
          "REGIONAL_VIEW_RECORDS"
        ]
      },
      "Entitlement": {
        "type": "object",
        "description": "An entitlement, which is a quota of one resource that's allocated to your account.",
        "required": [
          "type",
          "quantity",
          "product",
          "subscriptionRefId",
          "startAt",
          "createdAt",
          "updatedAt"
        ],
        "properties": {
          "type": {
            "$ref": "#/components/schemas/EntitlementType"
          },
          "quantity": {
            "type": "integer",
            "format": "int64",
            "minimum": 0,
            "description": "The allocated quantity. Its unit depends on `type`, for example the number of zones\nfor `ZONES`.\n",
            "example": 5000
          },
          "product": {
            "type": "string",
            "description": "The name of the product that the entitlement belongs to.",
            "example": "DNS Platform"
          },
          "subscriptionRefId": {
            "type": "string",
            "description": "The reference ID of the subscription that grants the entitlement.",
            "example": "SUB-QPM-001"
          },
          "startAt": {
            "type": "string",
            "format": "date-time",
            "description": "When the entitlement becomes active, as an RFC 3339 timestamp.",
            "example": "2026-01-01T00:00:00Z"
          },
          "endAt": {
            "type": [
              "string",
              "null"
            ],
            "format": "date-time",
            "description": "When the entitlement expires, as an RFC 3339 timestamp. It's `null` when the\nentitlement doesn't expire.\n",
            "example": null
          },
          "createdAt": {
            "type": "string",
            "format": "date-time",
            "description": "When the entitlement was created, as an RFC 3339 timestamp.",
            "example": "2026-01-01T00:00:00Z"
          },
          "updatedAt": {
            "type": "string",
            "format": "date-time",
            "description": "When the entitlement was last changed, as an RFC 3339 timestamp.",
            "example": "2026-06-01T12:00:00Z"
          }
        }
      },
      "EntitlementListResponse": {
        "type": "object",
        "description": "Your account's entitlements, with the subscription that grants each one.\n",
        "required": [
          "accountId",
          "data"
        ],
        "properties": {
          "accountId": {
            "type": "string",
            "format": "uuid",
            "description": "The ID of your account.",
            "example": "6d9f3df5-0e9e-4a2c-8d4f-c9ce2f9478c7"
          },
          "data": {
            "type": "array",
            "description": "The entitlements that are active for your account.",
            "items": {
              "$ref": "#/components/schemas/Entitlement"
            },
            "example": [
              {
                "type": "QPM",
                "quantity": 5000,
                "product": "DNS Platform",
                "subscriptionRefId": "SUB-QPM-001",
                "startAt": "2026-01-01T00:00:00Z",
                "endAt": null,
                "createdAt": "2026-01-01T00:00:00Z",
                "updatedAt": "2026-06-01T12:00:00Z"
              },
              {
                "type": "ZONES",
                "quantity": 200,
                "product": "DNS Platform",
                "subscriptionRefId": "SUB-ZONE-001",
                "startAt": "2026-01-01T00:00:00Z",
                "endAt": null,
                "createdAt": "2026-01-01T00:00:00Z",
                "updatedAt": "2026-06-01T12:00:00Z"
              },
              {
                "type": "RECORDS",
                "quantity": 10000,
                "product": "DNS Platform",
                "subscriptionRefId": "SUB-REC-001",
                "startAt": "2026-01-01T00:00:00Z",
                "endAt": null,
                "createdAt": "2026-01-01T00:00:00Z",
                "updatedAt": "2026-06-01T12:00:00Z"
              },
              {
                "type": "USERS",
                "quantity": 50,
                "product": "DNS Platform",
                "subscriptionRefId": "SUB-USR-001",
                "startAt": "2026-01-01T00:00:00Z",
                "endAt": null,
                "createdAt": "2026-01-01T00:00:00Z",
                "updatedAt": "2026-06-01T12:00:00Z"
              },
              {
                "type": "FAILOVER_RECORDS",
                "quantity": 500,
                "product": "DNS Platform",
                "subscriptionRefId": "SUB-QPM-001",
                "startAt": "2026-01-01T00:00:00Z",
                "endAt": null,
                "createdAt": "2026-01-01T00:00:00Z",
                "updatedAt": "2026-06-01T12:00:00Z"
              },
              {
                "type": "REGIONAL_VIEW_RECORDS",
                "quantity": 250,
                "product": "DNS Platform",
                "subscriptionRefId": "SUB-QPM-001",
                "startAt": "2026-01-01T00:00:00Z",
                "endAt": null,
                "createdAt": "2026-01-01T00:00:00Z",
                "updatedAt": "2026-06-01T12:00:00Z"
              }
            ]
          }
        }
      },
      "UsageSummaryDailyEntry": {
        "type": "object",
        "description": "The number of DNS query responses for one day.",
        "required": [
          "date",
          "responseCount",
          "primaryZoneQueryResponses",
          "secondaryZoneQueryResponses"
        ],
        "properties": {
          "date": {
            "type": "string",
            "format": "date",
            "description": "The calendar date, in `YYYY-MM-DD` format.",
            "example": "2026-07-01"
          },
          "responseCount": {
            "type": "integer",
            "format": "int64",
            "minimum": 0,
            "description": "The total number of DNS query responses served on the date.",
            "example": 142500
          },
          "primaryZoneQueryResponses": {
            "type": "integer",
            "format": "int64",
            "minimum": 0,
            "description": "The number of query responses that `PRIMARY` zones served on the date. It's `0` when\nusage data has no breakdown by zone type.\n",
            "example": 0
          },
          "secondaryZoneQueryResponses": {
            "type": "integer",
            "format": "int64",
            "minimum": 0,
            "description": "The number of query responses that `SECONDARY` zones served on the date. It's `0` when\nusage data has no breakdown by zone type.\n",
            "example": 0
          }
        }
      },
      "UsageSummaryResponse": {
        "type": "object",
        "description": "A summary of your account's usage: its resource counts and the DNS query responses\nserved so far in the current month.\n\nThe resource counts (`zones`, `records`, `users`, `failoverRecords`, and\n`regionalViewRecords`) are as of the most recent day in `data`. If there's no\nusage data for the current month yet, every count is `0` and `data` is empty.\n",
        "required": [
          "zones",
          "records",
          "failoverRecords",
          "regionalViewRecords",
          "users",
          "month",
          "totalResponseCount",
          "primaryZoneQueryResponses",
          "secondaryZoneQueryResponses",
          "data"
        ],
        "properties": {
          "zones": {
            "type": "integer",
            "format": "int64",
            "minimum": 0,
            "description": "The number of zones in your account.",
            "example": 42
          },
          "records": {
            "type": "integer",
            "format": "int64",
            "minimum": 0,
            "description": "The total number of DNS records across all zones in your account.",
            "example": 8750
          },
          "users": {
            "type": "integer",
            "format": "int64",
            "minimum": 0,
            "description": "The number of users on your account.",
            "example": 12
          },
          "failoverRecords": {
            "type": "integer",
            "format": "int64",
            "minimum": 0,
            "description": "The number of records in your account with simple failover configured.",
            "example": 120
          },
          "regionalViewRecords": {
            "type": "integer",
            "format": "int64",
            "minimum": 0,
            "description": "The number of records in your account with a regional view configured, which gives\nthe record a region-specific override.\n",
            "example": 55
          },
          "month": {
            "type": "string",
            "pattern": "^[0-9]{4}-(0[1-9]|1[0-2])$",
            "description": "The current calendar month, in `YYYY-MM` format.",
            "example": "2026-07"
          },
          "totalResponseCount": {
            "type": "integer",
            "format": "int64",
            "minimum": 0,
            "description": "The total number of DNS query responses served so far in the current month. It's the\nsum of `responseCount` across `data`.\n",
            "example": 1925000
          },
          "primaryZoneQueryResponses": {
            "type": "integer",
            "format": "int64",
            "minimum": 0,
            "description": "The number of query responses that `PRIMARY` zones served on the most recent day in\n`data`. Unlike `totalResponseCount`, it isn't a total for the month. It's `0` when usage\ndata has no breakdown by zone type.\n",
            "example": 0
          },
          "secondaryZoneQueryResponses": {
            "type": "integer",
            "format": "int64",
            "minimum": 0,
            "description": "The number of query responses that `SECONDARY` zones served on the most recent day in\n`data`. Unlike `totalResponseCount`, it isn't a total for the month. It's `0` when usage\ndata has no breakdown by zone type.\n",
            "example": 0
          },
          "data": {
            "type": "array",
            "minItems": 0,
            "description": "One entry for each day from the first day of the current month through the most\nrecent day with usage data, oldest first. A day in that range without usage data has every\ncount set to `0`.\n",
            "items": {
              "$ref": "#/components/schemas/UsageSummaryDailyEntry"
            }
          }
        },
        "example": {
          "zones": 42,
          "records": 8750,
          "users": 12,
          "failoverRecords": 120,
          "regionalViewRecords": 55,
          "month": "2026-07",
          "totalResponseCount": 1925000,
          "primaryZoneQueryResponses": 0,
          "secondaryZoneQueryResponses": 0,
          "data": [
            {
              "date": "2026-07-01",
              "responseCount": 142500,
              "primaryZoneQueryResponses": 0,
              "secondaryZoneQueryResponses": 0
            },
            {
              "date": "2026-07-02",
              "responseCount": 138000,
              "primaryZoneQueryResponses": 0,
              "secondaryZoneQueryResponses": 0
            },
            {
              "date": "2026-07-03",
              "responseCount": 155000,
              "primaryZoneQueryResponses": 0,
              "secondaryZoneQueryResponses": 0
            }
          ]
        }
      },
      "TaskList": {
        "type": "object",
        "description": "A page of the tasks in your account, with pagination details.\n",
        "required": [
          "data",
          "pagination"
        ],
        "properties": {
          "data": {
            "type": "array",
            "description": "The tasks on the page.",
            "items": {
              "$ref": "#/components/schemas/AsyncTask"
            }
          },
          "pagination": {
            "$ref": "#/components/schemas/Pagination"
          }
        }
      },
      "SoaTtl": {
        "type": "object",
        "description": "The default SOA record values for your account. Times are in seconds.\n",
        "required": [
          "refresh",
          "retry",
          "expire",
          "minimumCache",
          "ttl",
          "soaContactEmail",
          "primaryNameServer"
        ],
        "properties": {
          "refresh": {
            "type": "integer",
            "format": "int32",
            "minimum": 3600,
            "maximum": 21600,
            "description": "How often a secondary server checks the primary server for changes,\nin seconds.\n",
            "example": 3600
          },
          "retry": {
            "type": "integer",
            "format": "int32",
            "minimum": 600,
            "maximum": 1800,
            "description": "How long a secondary server waits before it retries a failed refresh,\nin seconds.\n",
            "example": 900
          },
          "expire": {
            "type": "integer",
            "format": "int32",
            "minimum": 86400,
            "maximum": 2419200,
            "description": "How long a secondary server keeps answering for the zone when it\ncan't reach the primary server, in seconds.\n",
            "example": 604800
          },
          "minimumCache": {
            "type": "integer",
            "format": "int32",
            "minimum": 60,
            "maximum": 86400,
            "description": "How long resolvers cache a negative answer, such as an NXDOMAIN\nresponse, in seconds.\n",
            "example": 300
          },
          "ttl": {
            "type": "integer",
            "format": "int32",
            "minimum": 3600,
            "maximum": 2419200,
            "description": "The TTL of the SOA record itself, in seconds.",
            "example": 86400
          },
          "soaContactEmail": {
            "type": "string",
            "format": "email",
            "description": "The email address of the person responsible for the zone. It's the\nRNAME field of the SOA record. Once it's set, you can't clear it. In\nthe defaults of some older accounts, it isn't set and is left out.\n",
            "example": "admin@example.com"
          },
          "primaryNameServer": {
            "type": "string",
            "description": "The primary authoritative nameserver for the zone. It's the MNAME\nfield of the SOA record. Once it's set, you can't clear it. In the\ndefaults of some older accounts, it isn't set and is left out.\n",
            "example": "ns1.example.com."
          }
        }
      },
      "SoaTtlUpdate": {
        "type": "object",
        "description": "A partial update to your account's SOA defaults. Send only the fields\nyou want to change. The API leaves the other fields unchanged. The API\nreturns `400` if the body has no fields.\n",
        "minProperties": 1,
        "properties": {
          "refresh": {
            "type": "integer",
            "format": "int32",
            "minimum": 3600,
            "maximum": 21600,
            "description": "The new refresh interval, in seconds."
          },
          "retry": {
            "type": "integer",
            "format": "int32",
            "minimum": 600,
            "maximum": 1800,
            "description": "The new retry interval, in seconds."
          },
          "expire": {
            "type": "integer",
            "format": "int32",
            "minimum": 86400,
            "maximum": 2419200,
            "description": "The new expire interval, in seconds."
          },
          "minimumCache": {
            "type": "integer",
            "format": "int32",
            "minimum": 60,
            "maximum": 86400,
            "description": "The new negative caching time, in seconds."
          },
          "ttl": {
            "type": "integer",
            "format": "int32",
            "minimum": 3600,
            "maximum": 2419200,
            "description": "The new TTL of the SOA record, in seconds."
          },
          "soaContactEmail": {
            "type": "string",
            "format": "email",
            "minLength": 1,
            "description": "The new contact email address for the zone. You can't clear the\nemail address. The API returns `400` if you send `null` or an empty\nstring.\n"
          },
          "primaryNameServer": {
            "type": "string",
            "minLength": 1,
            "description": "The new primary authoritative nameserver for the zone. You can't\nclear the nameserver. The API returns `400` if you send `null` or an\nempty string.\n"
          }
        }
      },
      "DnsSecKeyPolicy": {
        "type": "object",
        "description": "The DNSSEC key policy for one key type.\n",
        "required": [
          "type"
        ],
        "properties": {
          "type": {
            "type": "string",
            "enum": [
              "ZSK",
              "KSK"
            ],
            "description": "The key type that the policy applies to.\n\n- `ZSK`: The policy applies to the zone signing key (ZSK).\n- `KSK`: The policy applies to the key signing key (KSK).\n"
          },
          "bitLength": {
            "type": "integer",
            "format": "int32",
            "description": "The key length, in bits.",
            "examples": [
              256
            ]
          },
          "keyRolloverFrequency": {
            "type": "integer",
            "format": "int32",
            "description": "How often the key is rolled over, in days.",
            "examples": [
              64
            ]
          }
        }
      },
      "DnsSecPolicy": {
        "type": "object",
        "description": "The DNSSEC signing policy applied to the zone. It's your account's\ndefault DNSSEC policy.\n",
        "properties": {
          "algorithm": {
            "type": "string",
            "description": "The signing algorithm, for example `ECDSAP256SHA256`.",
            "examples": [
              "ECDSAP256SHA256",
              "RSASHA256"
            ]
          },
          "securityType": {
            "type": "string",
            "description": "How the zone proves that a name doesn't exist, for example `NSEC3` or\n`NSEC_ON_THE_FLY`.\n",
            "examples": [
              "NSEC_ON_THE_FLY",
              "NSEC3"
            ]
          },
          "rrsigSignatureDuration": {
            "type": "integer",
            "format": "int32",
            "description": "How long each record signature (RRSIG) is valid, in hours.",
            "examples": [
              24
            ]
          },
          "dnskeyTtl": {
            "type": "integer",
            "format": "int32",
            "description": "The TTL of the zone's DNSKEY records, in seconds.",
            "examples": [
              86400
            ]
          },
          "keyPolicy": {
            "type": "array",
            "description": "The key policies for the ZSK and the KSK.",
            "items": {
              "$ref": "#/components/schemas/DnsSecKeyPolicy"
            }
          }
        }
      },
      "DnsSecKey": {
        "type": "object",
        "description": "An active DNSSEC key for the zone. A key signing key (KSK) also includes\nthe DS records to publish in the parent zone.\n",
        "required": [
          "type"
        ],
        "properties": {
          "type": {
            "type": "string",
            "enum": [
              "ZSK",
              "KSK"
            ],
            "description": "The key type.\n\n- `ZSK`: A zone signing key (ZSK), which signs the zone's records.\n- `KSK`: A key signing key (KSK), which signs the zone's DNSKEY\n  records.\n"
          },
          "bitLength": {
            "type": "integer",
            "format": "int32",
            "description": "The key length, in bits."
          },
          "keyRolloverFrequency": {
            "type": "integer",
            "format": "int32",
            "description": "How often the key is rolled over, in days."
          },
          "status": {
            "type": "string",
            "description": "The key's lifecycle status, such as `CURRENT`.",
            "examples": [
              "CURRENT"
            ]
          },
          "createdAt": {
            "type": "string",
            "format": "date-time",
            "description": "When the key was created, as an RFC 3339 timestamp."
          },
          "nextRollAt": {
            "type": "string",
            "format": "date-time",
            "description": "When the key is next scheduled to roll over, as an RFC 3339\ntimestamp.\n"
          },
          "keyTag": {
            "type": "integer",
            "format": "int32",
            "description": "The key tag, a number that identifies the key in the zone. A DS\nrecord for the key contains the same key tag.\n",
            "examples": [
              63745
            ]
          },
          "publicKey": {
            "type": "string",
            "description": "The key's public key, Base64-encoded."
          },
          "dnsKeyRecord": {
            "type": "string",
            "description": "The key's full DNSKEY record, in zone file format."
          },
          "dsRecords": {
            "type": "array",
            "description": "The Delegation Signer (DS) records to publish in the parent zone,\nusually through your domain registrar. Present only for `KSK` keys.\n",
            "items": {
              "type": "string"
            }
          }
        }
      },
      "DnsSecStatus": {
        "type": "object",
        "description": "A zone's DNSSEC status, signing policy, and keys.\n",
        "required": [
          "status"
        ],
        "properties": {
          "status": {
            "type": "string",
            "enum": [
              "SIGNED",
              "UNSIGNED"
            ],
            "description": "Whether the zone is signed with DNSSEC.\n\n- `SIGNED`: The zone is signed.\n- `UNSIGNED`: The zone isn't signed.\n"
          },
          "policy": {
            "$ref": "#/components/schemas/DnsSecPolicy",
            "description": "The signing policy applied to the zone."
          },
          "keys": {
            "type": "array",
            "description": "The zone's active DNSSEC keys. Each `KSK` key includes the DS records\nto publish in the parent zone in `dsRecords`.\n",
            "items": {
              "$ref": "#/components/schemas/DnsSecKey"
            }
          },
          "lastModifiedAt": {
            "type": "string",
            "format": "date-time",
            "description": "When the zone's DNSSEC configuration last changed, as an RFC 3339\ntimestamp.\n"
          }
        }
      },
      "DnsSecChangeRequest": {
        "type": "object",
        "description": "An optional note about signing or unsigning a zone with DNSSEC.\n",
        "properties": {
          "reason": {
            "type": "string",
            "description": "A short note that explains why you're making the change.",
            "examples": [
              "Enabling DNSSEC for compliance"
            ]
          }
        }
      },
      "NameserverSet": {
        "type": "object",
        "description": "An Inbound IP Set: a named, reusable list of the upstream primary\nservers that `SECONDARY` zones transfer from, and of the addresses that\nare allowed to send `NOTIFY` messages for those zones. A `SECONDARY`\nzone uses a set through `secondary.inboundIpSetName`. `PRIMARY` zones\ndon't use Inbound IP Sets.\n\nThe set's `id` identifies it in the path and never changes. Its `name`\nis unique in your account, and you can change it.\n",
        "required": [
          "id",
          "name",
          "primaryNameservers",
          "zoneCount",
          "createdAt",
          "updatedAt"
        ],
        "properties": {
          "id": {
            "type": "string",
            "format": "uuid",
            "readOnly": true,
            "description": "The set's unique ID, assigned by DigiCert DNS. It's the\n`nameserverSetId` in `/dns-settings/inbound/nameserver-sets/{nameserverSetId}`,\nand it never changes.\n"
          },
          "name": {
            "type": "string",
            "minLength": 1,
            "maxLength": 255,
            "description": "The set's display name, unique in your account. You can change it\nwith `PATCH`. A `SECONDARY` zone refers to the set by this name in\n`secondary.inboundIpSetName`.\n"
          },
          "description": {
            "type": "string",
            "maxLength": 1024,
            "description": "An optional description of the set."
          },
          "primaryNameservers": {
            "type": "array",
            "minItems": 1,
            "maxItems": 3,
            "description": "The IPv4 or IPv6 addresses of the upstream primary servers that\nzones using the set transfer from, 1 to 3 entries. The order sets\nthe priority: the first address has the highest priority.\n",
            "items": {
              "anyOf": [
                {
                  "type": "string",
                  "format": "ipv4"
                },
                {
                  "type": "string",
                  "format": "ipv6"
                }
              ],
              "minLength": 1,
              "description": "The IPv4 or IPv6 address of an upstream primary server.",
              "examples": [
                "192.0.2.53",
                "2001:db8::53"
              ]
            }
          },
          "notifyAllowedIPs": {
            "type": "array",
            "minItems": 1,
            "maxItems": 3,
            "uniqueItems": true,
            "description": "The IP addresses that are allowed to send DNS `NOTIFY` messages for\nthe zones that use the set, 1 to 3 entries. An upstream primary\nserver sends a `NOTIFY` when the zone changes, so that the\n`SECONDARY` zone can transfer the change without waiting for the SOA\nrefresh interval.\n",
            "items": {
              "type": "string",
              "minLength": 1,
              "description": "The IPv4 or IPv6 address of a server that's allowed to send `NOTIFY` messages.",
              "examples": [
                "192.0.2.53",
                "2001:db8::53"
              ]
            }
          },
          "zoneCount": {
            "type": "integer",
            "format": "int64",
            "minimum": 0,
            "readOnly": true,
            "description": "The number of `SECONDARY` zones that use the set. If you delete a\nset that zones still use, the API returns `409 Conflict`.\n"
          },
          "createdAt": {
            "type": "string",
            "format": "date-time",
            "readOnly": true
          },
          "updatedAt": {
            "type": "string",
            "format": "date-time",
            "readOnly": true
          }
        }
      },
      "NameserverSetList": {
        "type": "object",
        "description": "A page of the Inbound IP Sets in your account, with pagination details.",
        "required": [
          "data",
          "pagination"
        ],
        "properties": {
          "data": {
            "type": "array",
            "items": {
              "$ref": "#/components/schemas/NameserverSet"
            }
          },
          "pagination": {
            "$ref": "#/components/schemas/Pagination"
          }
        }
      },
      "NameserverSetCreate": {
        "type": "object",
        "additionalProperties": false,
        "description": "The Inbound IP Set to create. The `name` must be unique in your\naccount. If a set with the same name exists, the API returns\n`409 Conflict`.\n",
        "required": [
          "name",
          "primaryNameservers",
          "notifyAllowedIPs"
        ],
        "properties": {
          "name": {
            "type": "string",
            "minLength": 1,
            "maxLength": 255
          },
          "description": {
            "type": "string",
            "maxLength": 1024
          },
          "primaryNameservers": {
            "type": "array",
            "minItems": 1,
            "maxItems": 3,
            "description": "The IPv4 or IPv6 addresses of the upstream primary servers that\nzones using the set transfer from, 1 to 3 entries. The order sets\nthe priority: the first address has the highest priority.\n",
            "items": {
              "anyOf": [
                {
                  "type": "string",
                  "format": "ipv4"
                },
                {
                  "type": "string",
                  "format": "ipv6"
                }
              ],
              "minLength": 1,
              "description": "The IPv4 or IPv6 address of an upstream primary server.",
              "examples": [
                "192.0.2.53",
                "2001:db8::53"
              ]
            }
          },
          "notifyAllowedIPs": {
            "type": "array",
            "minItems": 1,
            "maxItems": 3,
            "uniqueItems": true,
            "description": "The IP addresses that are allowed to send DNS `NOTIFY` messages for\nthe zones that use the set, 1 to 3 entries.\n",
            "items": {
              "type": "string",
              "minLength": 1,
              "description": "The IPv4 or IPv6 address of a server that's allowed to send `NOTIFY` messages."
            }
          }
        }
      },
      "NameserverSetUpdate": {
        "type": "object",
        "additionalProperties": false,
        "description": "The changes to make to the Inbound IP Set. Send only the fields to\nchange, with the `application/json` content type. The API keeps the\nfields you omit. It doesn't accept JSON Patch\n(`application/json-patch+json`).\n\nIf you send `primaryNameservers` or `notifyAllowedIPs`, it replaces the\nwhole list. Entries aren't merged.\n\nYou can rename the set. The new `name` must be unique in your account,\nor the API returns `409 Conflict`. Zones that use the set show the new\nname in `secondary.inboundIpSetName`, so you don't need to update them.\nThe set's `id` doesn't change.\n",
        "properties": {
          "name": {
            "type": "string",
            "minLength": 1,
            "maxLength": 255,
            "description": "The set's new display name, unique in your account. If another set\nhas the name, the API returns `409 Conflict`.\n"
          },
          "description": {
            "type": "string",
            "maxLength": 1024,
            "description": "The set's new description."
          },
          "primaryNameservers": {
            "type": "array",
            "minItems": 1,
            "maxItems": 3,
            "description": "The new list of upstream primary servers: 1 to 3 IPv4 or IPv6\naddresses, in priority order. It replaces the whole list.\n",
            "items": {
              "anyOf": [
                {
                  "type": "string",
                  "format": "ipv4"
                },
                {
                  "type": "string",
                  "format": "ipv6"
                }
              ],
              "minLength": 1,
              "description": "The IPv4 or IPv6 address of an upstream primary server."
            }
          },
          "notifyAllowedIPs": {
            "type": "array",
            "minItems": 1,
            "maxItems": 3,
            "uniqueItems": true,
            "description": "The new list of IP addresses that are allowed to send DNS `NOTIFY`\nmessages, 1 to 3 entries. It replaces the whole list. You can't\nsend an empty list.\n",
            "items": {
              "type": "string",
              "minLength": 1,
              "description": "The IPv4 or IPv6 address of a server that's allowed to send `NOTIFY` messages."
            }
          }
        }
      },
      "OutboundNameserverSet": {
        "type": "object",
        "description": "An Outbound IP Set: a named, reusable pair of address lists for\ntransferring `PRIMARY` zones out to your secondary DNS providers.\n\n- `transferAllowedIPs`: The addresses that can request a zone transfer.\n- `notifyDestinations`: The addresses that receive a DNS `NOTIFY`\n  message when a zone that uses the set changes.\n\nA `PRIMARY` zone uses up to 3 Outbound IP Sets through\n`primary.outboundIps`. A set doesn't include a TSIG key. Each zone pairs\na set with an optional TSIG key in `primary.outboundIps[].tsigKeyName`.\n\nThe set's `id` identifies it in the path and never changes. Its `name`\nis unique in your account, and you can change it.\n",
        "required": [
          "id",
          "name",
          "transferAllowedIPs",
          "notifyDestinations",
          "zoneCount",
          "createdAt",
          "updatedAt"
        ],
        "properties": {
          "id": {
            "type": "string",
            "format": "uuid",
            "readOnly": true,
            "description": "The set's unique ID, assigned by DigiCert DNS. It's the\n`nameserverSetId` in `/dns-settings/outbound/nameserver-sets/{nameserverSetId}`,\nand it never changes.\n"
          },
          "name": {
            "type": "string",
            "minLength": 1,
            "maxLength": 255,
            "description": "The set's display name, unique in your account. You can change it\nwith `PATCH`. A `PRIMARY` zone refers to the set by this name in\n`primary.outboundIps[].outboundIpSetName`.\n"
          },
          "description": {
            "type": "string",
            "maxLength": 1024,
            "description": "An optional description of the set."
          },
          "transferAllowedIPs": {
            "type": "array",
            "minItems": 1,
            "maxItems": 5,
            "uniqueItems": true,
            "description": "The addresses that can request a zone transfer (AXFR or IXFR) of\nthe zones that use the set, up to 5 entries. Each entry is an IPv4\nor IPv6 address, a CIDR block such as `192.0.2.0/24`, or an\ninclusive range such as `192.0.2.1-192.0.2.9`.\n",
            "items": {
              "type": "string",
              "minLength": 1,
              "description": "An IPv4 or IPv6 address, CIDR block, or inclusive range that can\nrequest a zone transfer.\n",
              "examples": [
                "203.0.113.163",
                "2001:db8:1000:c47::/64",
                "203.0.113.1-203.0.113.9"
              ]
            }
          },
          "notifyDestinations": {
            "type": "array",
            "minItems": 1,
            "maxItems": 5,
            "uniqueItems": true,
            "description": "The IPv4 or IPv6 addresses that receive a DNS `NOTIFY` message when\na zone that uses the set changes, up to 5 entries. A `NOTIFY` lets\nyour secondary servers transfer the change without waiting for the\nSOA refresh interval. Each entry must be a single address. Unlike\n`transferAllowedIPs`, CIDR blocks and ranges aren't accepted.\n",
            "items": {
              "type": "string",
              "minLength": 1,
              "description": "The IPv4 or IPv6 address of a server that receives `NOTIFY`\nmessages. CIDR blocks and ranges aren't accepted.\n",
              "examples": [
                "198.51.100.82",
                "2001:db8:60::5774"
              ]
            }
          },
          "zoneCount": {
            "type": "integer",
            "format": "int64",
            "minimum": 0,
            "readOnly": true,
            "description": "The number of `PRIMARY` zones that use the set. If you delete a set\nthat zones still use, the API returns `409 Conflict`.\n"
          },
          "createdAt": {
            "type": "string",
            "format": "date-time",
            "readOnly": true
          },
          "updatedAt": {
            "type": "string",
            "format": "date-time",
            "readOnly": true
          }
        }
      },
      "OutboundNameserverSetList": {
        "type": "object",
        "description": "A page of the Outbound IP Sets in your account, with pagination details.",
        "required": [
          "data",
          "pagination"
        ],
        "properties": {
          "data": {
            "type": "array",
            "items": {
              "$ref": "#/components/schemas/OutboundNameserverSet"
            }
          },
          "pagination": {
            "$ref": "#/components/schemas/Pagination"
          }
        }
      },
      "OutboundNameserverSetCreate": {
        "type": "object",
        "additionalProperties": false,
        "description": "The Outbound IP Set to create. The `name` must be unique in your\naccount. If a set with the same name exists, the API returns\n`409 Conflict`.\n",
        "required": [
          "name",
          "transferAllowedIPs",
          "notifyDestinations"
        ],
        "properties": {
          "name": {
            "type": "string",
            "minLength": 1,
            "maxLength": 255
          },
          "description": {
            "type": "string",
            "maxLength": 1024,
            "description": "An optional description of the set."
          },
          "transferAllowedIPs": {
            "type": "array",
            "minItems": 1,
            "maxItems": 5,
            "uniqueItems": true,
            "description": "The addresses that can request a zone transfer (AXFR or IXFR) of\nthe zones that use the set, up to 5 entries. Each entry is an IPv4\nor IPv6 address, a CIDR block such as `192.0.2.0/24`, or an\ninclusive range such as `192.0.2.1-192.0.2.9`.\n",
            "items": {
              "type": "string",
              "minLength": 1,
              "description": "An IPv4 or IPv6 address, CIDR block, or inclusive range that can\nrequest a zone transfer.\n"
            }
          },
          "notifyDestinations": {
            "type": "array",
            "minItems": 1,
            "maxItems": 5,
            "uniqueItems": true,
            "description": "The IPv4 or IPv6 addresses that receive a DNS `NOTIFY` message when\na zone that uses the set changes, up to 5 entries. Each entry must\nbe a single address. Unlike `transferAllowedIPs`, CIDR blocks and\nranges aren't accepted.\n",
            "items": {
              "type": "string",
              "minLength": 1,
              "description": "The IPv4 or IPv6 address of a server that receives `NOTIFY`\nmessages. CIDR blocks and ranges aren't accepted.\n"
            }
          }
        }
      },
      "OutboundNameserverSetUpdate": {
        "type": "object",
        "additionalProperties": false,
        "description": "The changes to make to the Outbound IP Set. Send only the fields to\nchange, with the `application/json` content type. The API keeps the\nfields you omit. It doesn't accept JSON Patch\n(`application/json-patch+json`).\n\nIf you send `transferAllowedIPs` or `notifyDestinations`, it replaces\nthe whole list. Entries aren't merged, and each list needs at least 1\nentry. You can rename the set. The set's `id` doesn't change.\n",
        "properties": {
          "name": {
            "type": "string",
            "minLength": 1,
            "maxLength": 255,
            "description": "The set's new display name, unique in your account. If another set\nhas the name, the API returns `409 Conflict`.\n"
          },
          "description": {
            "type": "string",
            "maxLength": 1024,
            "description": "The set's new description."
          },
          "transferAllowedIPs": {
            "type": "array",
            "minItems": 1,
            "maxItems": 5,
            "uniqueItems": true,
            "description": "The new list of addresses that can request a zone transfer (AXFR or\nIXFR), up to 5 entries. It replaces the whole list. Each entry is an\nIPv4 or IPv6 address, a CIDR block such as `192.0.2.0/24`, or an\ninclusive range such as `192.0.2.1-192.0.2.9`.\n",
            "items": {
              "type": "string",
              "minLength": 1,
              "description": "An IPv4 or IPv6 address, CIDR block, or inclusive range."
            }
          },
          "notifyDestinations": {
            "type": "array",
            "minItems": 1,
            "maxItems": 5,
            "uniqueItems": true,
            "description": "The new list of IPv4 or IPv6 addresses that receive a DNS `NOTIFY`\nmessage when a zone that uses the set changes, up to 5 entries. It\nreplaces the whole list. You can't send an empty list. Each entry\nmust be a single address. Unlike `transferAllowedIPs`, CIDR blocks\nand ranges aren't accepted.\n",
            "items": {
              "type": "string",
              "minLength": 1,
              "description": "The IPv4 or IPv6 address of a server that receives `NOTIFY`\nmessages. CIDR blocks and ranges aren't accepted.\n"
            }
          }
        }
      },
      "DnsNameserverSet": {
        "type": "object",
        "description": "A Nameserver Set: a named, reusable list of the authoritative\nnameservers for your zones. A `PRIMARY` zone uses a set through\n`primary.nameserverSetName`.\n\nOne set in your account can be the default. A `PRIMARY` zone that you\ncreate without a Nameserver Set uses the default set.\n",
        "required": [
          "id",
          "name",
          "nameservers",
          "type",
          "isDefault",
          "zoneCount",
          "createdAt",
          "updatedAt"
        ],
        "properties": {
          "id": {
            "type": "string",
            "format": "uuid",
            "readOnly": true,
            "description": "The set's unique ID, assigned by DigiCert DNS. It's the\n`nameserverSetId` in `/dns-settings/nameserver-sets/{nameserverSetId}`,\nand it never changes.\n"
          },
          "name": {
            "type": "string",
            "minLength": 1,
            "maxLength": 255,
            "description": "The set's display name, unique in your account. A `PRIMARY` zone\nrefers to the set by this name in `primary.nameserverSetName`.\n"
          },
          "description": {
            "type": "string",
            "maxLength": 1024,
            "description": "An optional description of the set."
          },
          "nameservers": {
            "type": "array",
            "minItems": 2,
            "description": "The fully qualified domain names of the set's authoritative\nnameservers, at least 2. Each name ends with a dot (`.`). The API\nkeeps the order you send.\n",
            "items": {
              "type": "string",
              "minLength": 1,
              "description": "The fully qualified domain name of a nameserver.",
              "examples": [
                "ns1.example.com.",
                "ns2.example.com."
              ]
            }
          },
          "type": {
            "type": "string",
            "enum": [
              "USER_DEFINED",
              "SYSTEM"
            ],
            "readOnly": true,
            "description": "How the set was created.\n\n- `USER_DEFINED`: You created the set.\n- `SYSTEM`: DigiCert DNS created the set and manages it.\n"
          },
          "isDefault": {
            "type": "boolean",
            "description": "Whether the set is your account's default Nameserver Set. A\n`PRIMARY` zone that you create without a Nameserver Set uses the\ndefault set. Only one set in your account can be the default, so\nmaking another set the default clears `isDefault` on this one.\nChanging the default doesn't change zones that already use a set.\n"
          },
          "zoneCount": {
            "type": "integer",
            "format": "int64",
            "minimum": 0,
            "readOnly": true,
            "description": "The number of zones that use the set."
          },
          "createdAt": {
            "type": "string",
            "format": "date-time",
            "readOnly": true
          },
          "updatedAt": {
            "type": "string",
            "format": "date-time",
            "readOnly": true
          }
        }
      },
      "DnsNameserverSetList": {
        "type": "object",
        "description": "A page of the Nameserver Sets in your account, with pagination details.",
        "required": [
          "data",
          "pagination"
        ],
        "properties": {
          "data": {
            "type": "array",
            "items": {
              "$ref": "#/components/schemas/DnsNameserverSet"
            }
          },
          "pagination": {
            "$ref": "#/components/schemas/Pagination"
          }
        }
      },
      "DnsNameserverSetCreate": {
        "type": "object",
        "additionalProperties": false,
        "description": "The Nameserver Set to create. The `name` must be unique in your\naccount. If a set with the same name exists, the API returns\n`409 Conflict`.\n",
        "required": [
          "name",
          "nameservers"
        ],
        "properties": {
          "name": {
            "type": "string",
            "minLength": 1,
            "maxLength": 255,
            "description": "The set's display name, unique in your account."
          },
          "description": {
            "type": "string",
            "maxLength": 1024,
            "description": "An optional description of the set."
          },
          "nameservers": {
            "type": "array",
            "minItems": 2,
            "description": "The fully qualified domain names of the set's authoritative\nnameservers, at least 2. Each name must end with a dot (`.`). The\nAPI keeps the order you send.\n",
            "items": {
              "type": "string",
              "minLength": 1,
              "description": "The fully qualified domain name of a nameserver.",
              "examples": [
                "ns1.example.com.",
                "ns2.example.com."
              ]
            }
          },
          "isDefault": {
            "type": "boolean",
            "default": false,
            "description": "Whether to make the set your account's default Nameserver Set. If\nanother set is the default, it stops being the default.\n"
          }
        }
      },
      "DnsNameserverSetUpdate": {
        "type": "object",
        "additionalProperties": false,
        "description": "The changes to make to the Nameserver Set. Send only the fields to\nchange, with the `application/json` content type. The API keeps the\nfields you omit. It doesn't accept JSON Patch\n(`application/json-patch+json`).\n\nIf you send `nameservers`, it replaces the whole list. Entries aren't\nmerged. You can't change the set's `id` or `type`.\n",
        "properties": {
          "name": {
            "type": "string",
            "minLength": 1,
            "maxLength": 255,
            "description": "The set's new display name, unique in your account. If another set\nhas the name, the API returns `409 Conflict`.\n"
          },
          "description": {
            "type": "string",
            "maxLength": 1024,
            "description": "The set's new description."
          },
          "nameservers": {
            "type": "array",
            "minItems": 2,
            "description": "The new list of the set's authoritative nameservers: at least 2 fully\nqualified domain names, each ending with a dot (`.`). It replaces the\nwhole list.\n",
            "items": {
              "type": "string",
              "minLength": 1,
              "description": "The fully qualified domain name of a nameserver.",
              "examples": [
                "ns1.example.com.",
                "ns2.example.com."
              ]
            }
          },
          "isDefault": {
            "type": "boolean",
            "description": "Set to `true` to make the set your account's default Nameserver Set.\nThe current default stops being the default. Zones that already use\na set don't change.\n"
          }
        }
      },
      "TsigKeyResource": {
        "type": "object",
        "description": "A Transaction Signature (TSIG) key in your account. A TSIG key signs\nzone transfers so that each server can check that the other is\nauthorized. Zones refer to a key by its `name`:\n\n- A `SECONDARY` zone sets a key for transfers from its upstream primary\n  servers in `secondary.tsigKeyName`.\n- A `PRIMARY` zone sets a key for each Outbound IP Set in\n  `primary.outboundIps[].tsigKeyName`.\n\nA one-time AXFR import into a new `PRIMARY` zone refers to a key by its\n`id`, in `primary.recordImport.axfr.tsigKeyId`.\n\nNo response returns the key's `secret`. Responses show a masked\n`secretPreview` so you can tell keys apart.\n",
        "required": [
          "id",
          "name",
          "algorithm",
          "secretPreview",
          "zoneCount",
          "createdAt",
          "updatedAt"
        ],
        "properties": {
          "id": {
            "type": "string",
            "format": "uuid",
            "readOnly": true,
            "description": "The key's unique ID, assigned by DigiCert DNS. It's the `tsigKeyId`\nin `/dns-settings/tsig-keys/{tsigKeyId}`, and it never changes.\nAn AXFR import refers to the key by this ID.\n"
          },
          "name": {
            "type": "string",
            "minLength": 1,
            "maxLength": 255,
            "description": "The key's display name, unique in your account. You can change it\nwith `PATCH`. Zones refer to the key by this name.\n"
          },
          "description": {
            "type": "string",
            "maxLength": 1024
          },
          "algorithm": {
            "type": "string",
            "enum": [
              "hmac-md5",
              "hmac-sha1",
              "hmac-sha224",
              "hmac-sha256",
              "hmac-sha384",
              "hmac-sha512"
            ],
            "default": "hmac-sha256",
            "description": "The HMAC algorithm that signs messages with the key. The default is\n`hmac-sha256`.\n\nRFC 8945 deprecates `hmac-md5` and `hmac-sha1`. Use them only with\nan older server that doesn't support a stronger algorithm, and don't\nuse them for new keys.\n",
            "x-enumDescriptions": {
              "hmac-md5": "Deprecated (RFC 8945). Retained for legacy interoperability only.",
              "hmac-sha1": "Deprecated (RFC 8945). Retained for legacy interoperability only.",
              "hmac-sha224": "Acceptable but uncommon; prefer hmac-sha256 or stronger.",
              "hmac-sha256": "Recommended default.",
              "hmac-sha384": "Stronger than hmac-sha256; use when required by policy.",
              "hmac-sha512": "Strongest available; use when required by policy."
            }
          },
          "secretPreview": {
            "type": "string",
            "readOnly": true,
            "pattern": "^.{4}\\*{8}$",
            "maxLength": 12,
            "minLength": 12,
            "example": "abcd********",
            "description": "A masked preview of the key's secret: its first 4 characters\nfollowed by 8 asterisks, for example `abcd********`. Use it to tell\nkeys apart. No response returns the full `secret`.\n"
          },
          "zoneCount": {
            "type": "integer",
            "format": "int64",
            "minimum": 0,
            "readOnly": true,
            "description": "The number of zones that use the key: `SECONDARY` zones that set it\nin `secondary.tsigKeyName`, and `PRIMARY` zones that set it in\n`primary.outboundIps[].tsigKeyName`. If you delete a key that zones\nstill use, the API returns `409 Conflict`.\n"
          },
          "createdAt": {
            "type": "string",
            "format": "date-time",
            "readOnly": true
          },
          "updatedAt": {
            "type": "string",
            "format": "date-time",
            "readOnly": true
          }
        }
      },
      "TsigKeyList": {
        "type": "object",
        "description": "A page of the TSIG keys in your account, with pagination details.",
        "required": [
          "data",
          "pagination"
        ],
        "properties": {
          "data": {
            "type": "array",
            "items": {
              "$ref": "#/components/schemas/TsigKeyResource"
            }
          },
          "pagination": {
            "$ref": "#/components/schemas/Pagination"
          }
        }
      },
      "TsigKeyCreate": {
        "type": "object",
        "additionalProperties": false,
        "description": "The Transaction Signature (TSIG) key to create. The `name` must be\nunique in your account. If a key with the same name exists, the API\nreturns `409 Conflict`.\n\nThe `secret` is write-only. No response returns it. Responses show a\nmasked `secretPreview` instead.\n",
        "required": [
          "name",
          "secret"
        ],
        "properties": {
          "name": {
            "type": "string",
            "minLength": 1,
            "maxLength": 255
          },
          "description": {
            "type": "string",
            "maxLength": 1024
          },
          "secret": {
            "type": "string",
            "format": "password",
            "writeOnly": true,
            "minLength": 1,
            "description": "The key's secret, base64-encoded. It's write-only, and no response returns it."
          },
          "algorithm": {
            "type": "string",
            "enum": [
              "hmac-md5",
              "hmac-sha1",
              "hmac-sha224",
              "hmac-sha256",
              "hmac-sha384",
              "hmac-sha512"
            ],
            "default": "hmac-sha256",
            "description": "The HMAC algorithm that signs messages with the key. If you omit\nit, the API uses `hmac-sha256`.\n"
          }
        }
      },
      "TsigKeyUpdate": {
        "type": "object",
        "additionalProperties": false,
        "description": "The changes to make to the TSIG key. Send only the fields to change,\nwith the `application/json` content type. The API keeps the fields you\nomit. It doesn't accept JSON Patch (`application/json-patch+json`).\n\nTo rotate the key, send a new `secret`, and a new `algorithm` if it\nchanges. The key's `id` doesn't change, and zones that use the key sign\ntheir next transfer with the new secret.\n\nYou can rename the key. The new `name` must be unique in your account,\nor the API returns `409 Conflict`. Zones that use the key show the new\nname in `tsigKeyName`, so you don't need to update them.\n",
        "properties": {
          "name": {
            "type": "string",
            "minLength": 1,
            "maxLength": 255,
            "description": "The key's new display name, unique in your account. If another key\nhas the name, the API returns `409 Conflict`.\n"
          },
          "description": {
            "type": "string",
            "maxLength": 1024
          },
          "secret": {
            "type": "string",
            "format": "password",
            "writeOnly": true,
            "minLength": 1,
            "description": "The new secret, base64-encoded. It replaces the current secret. It's\nwrite-only: no response returns it.\n"
          },
          "algorithm": {
            "type": "string",
            "enum": [
              "hmac-md5",
              "hmac-sha1",
              "hmac-sha224",
              "hmac-sha256",
              "hmac-sha384",
              "hmac-sha512"
            ]
          }
        }
      },
      "AuditDetail": {
        "type": "object",
        "description": "The details of an audit record: the fields that changed, and other details about the\nevent.\n",
        "properties": {
          "changes": {
            "type": "array",
            "description": "The fields that changed, each with its previous and new value.",
            "items": {
              "type": "object",
              "properties": {
                "name": {
                  "type": "string",
                  "description": "The name of the field that changed."
                },
                "from": {
                  "type": "string",
                  "description": "The field's previous value."
                },
                "to": {
                  "type": "string",
                  "description": "The field's new value."
                }
              }
            }
          },
          "others": {
            "type": "array",
            "description": "Other details about the event, such as a login, as name and value pairs.\n",
            "items": {
              "type": "object",
              "properties": {
                "name": {
                  "type": "string",
                  "description": "The name of the detail."
                },
                "value": {
                  "type": "string",
                  "description": "The value of the detail."
                }
              }
            }
          }
        }
      },
      "AuditRecord": {
        "type": "object",
        "description": "An audit record of one change to your DNS configuration.\n",
        "required": [
          "account",
          "user",
          "objectType",
          "changeType",
          "objectName",
          "changedAt"
        ],
        "properties": {
          "account": {
            "type": "string",
            "description": "The account that owns the changed object."
          },
          "user": {
            "type": "string",
            "description": "The user who made the change."
          },
          "ipAddress": {
            "type": "string",
            "description": "The IP address that the change was made from."
          },
          "objectType": {
            "type": "string",
            "description": "The type of object that changed, such as `ZONE`, `RRSET`, or `USER`."
          },
          "changeType": {
            "type": "string",
            "description": "The kind of change, such as `ADD`, `MODIFY`, or `DELETE`."
          },
          "objectName": {
            "type": "string",
            "description": "The name of the object that changed."
          },
          "parentName": {
            "type": [
              "string",
              "null"
            ],
            "description": "The name of the changed object's parent, for example the zone name when `objectType`\nis `RRSET`. It's `null` when the object has no parent.\n"
          },
          "reason": {
            "type": [
              "string",
              "null"
            ],
            "description": "The comment that the user recorded with the change, or `null` if there's none."
          },
          "detail": {
            "$ref": "#/components/schemas/AuditDetail",
            "description": "The fields that changed and other details about the change."
          },
          "changedAt": {
            "type": "string",
            "format": "date-time",
            "description": "When the change was made, as an RFC 3339 timestamp."
          }
        }
      },
      "AuditRecordList": {
        "type": "object",
        "description": "A page of audit records for your account, sorted by `changedAt`. The `sortOrder` query\nparameter sets the direction. The default is newest first.\n",
        "required": [
          "data",
          "pagination"
        ],
        "properties": {
          "data": {
            "type": "array",
            "description": "The audit records in the page.",
            "items": {
              "$ref": "#/components/schemas/AuditRecord"
            }
          },
          "pagination": {
            "$ref": "#/components/schemas/Pagination"
          }
        }
      },
      "AuditFilters": {
        "type": "object",
        "description": "The values in your audit log for each filter, over the requested date range.\n",
        "properties": {
          "accounts": {
            "type": "array",
            "description": "The accounts that appear in the date range.",
            "items": {
              "type": "string"
            }
          },
          "users": {
            "type": "array",
            "description": "The users that appear in the date range.",
            "items": {
              "type": "string"
            }
          },
          "objectTypes": {
            "type": "array",
            "description": "The object types that appear in the date range.",
            "items": {
              "type": "string"
            }
          },
          "changeTypes": {
            "type": "array",
            "description": "The change types that appear in the date range.",
            "items": {
              "type": "string"
            }
          }
        }
      },
      "ZoneSnapshotSummary": {
        "type": "object",
        "description": "A snapshot's details, without its record sets. To get the record sets, get the snapshot by its\n`id`.\n",
        "required": [
          "id",
          "zoneName",
          "isRegionalViewEnabled",
          "createdAt"
        ],
        "properties": {
          "id": {
            "type": "string",
            "format": "uuid",
            "description": "The snapshot's unique ID. Use it as the `snapshotId` path parameter."
          },
          "zoneName": {
            "$ref": "#/components/schemas/DomainName",
            "description": "The fully qualified name of the zone that the snapshot was taken of."
          },
          "isRegionalViewEnabled": {
            "type": "boolean",
            "description": "Whether regional views were enabled for the zone when the snapshot was taken."
          },
          "name": {
            "type": "string",
            "description": "The snapshot's name, if you gave it one when you created it."
          },
          "description": {
            "type": "string",
            "description": "The snapshot's description, if you gave it one when you created it."
          },
          "createdAt": {
            "type": "string",
            "format": "date-time",
            "description": "When the snapshot was taken."
          }
        }
      },
      "ZoneSnapshotList": {
        "type": "object",
        "description": "A page of a zone's snapshots, with pagination details.\n",
        "required": [
          "data",
          "pagination"
        ],
        "properties": {
          "data": {
            "type": "array",
            "description": "The snapshots on the page, without their record sets.",
            "items": {
              "$ref": "#/components/schemas/ZoneSnapshotSummary"
            }
          },
          "pagination": {
            "$ref": "#/components/schemas/Pagination"
          }
        }
      },
      "ZoneSnapshotCreateRequest": {
        "type": "object",
        "description": "Optional details for a new snapshot. Both fields are optional, and you can omit the body.\n",
        "properties": {
          "name": {
            "type": "string",
            "description": "A short name for the snapshot.",
            "examples": [
              "pre-migration"
            ]
          },
          "description": {
            "type": "string",
            "description": "A description of the snapshot, such as why you took it.",
            "examples": [
              "Pre-migration backup"
            ]
          }
        }
      },
      "ZoneSnapshot": {
        "type": "object",
        "description": "A point-in-time copy of a zone's record sets, with the snapshot's details.\n",
        "required": [
          "id",
          "zoneName",
          "isRegionalViewEnabled",
          "createdAt"
        ],
        "properties": {
          "id": {
            "type": "string",
            "format": "uuid",
            "description": "The snapshot's unique ID. Use it as the `snapshotId` path parameter."
          },
          "zoneName": {
            "$ref": "#/components/schemas/DomainName",
            "description": "The fully qualified name of the zone that the snapshot was taken of."
          },
          "isRegionalViewEnabled": {
            "type": "boolean",
            "description": "Whether regional views were enabled for the zone when the snapshot was taken."
          },
          "name": {
            "type": "string",
            "description": "The snapshot's name, if you gave it one when you created it."
          },
          "description": {
            "type": "string",
            "description": "The snapshot's description, if you gave it one when you created it."
          },
          "createdAt": {
            "type": "string",
            "format": "date-time",
            "description": "When the snapshot was taken."
          },
          "rrSets": {
            "type": "array",
            "description": "The record sets that the snapshot captured, in the same form as when you list a zone's\nrecord sets.\n",
            "items": {
              "$ref": "#/components/schemas/RRSet"
            }
          }
        }
      },
      "RestoreZoneRequest": {
        "type": "object",
        "description": "The request body for restoring a zone from a snapshot. It has no fields, because the restore\nalways uses the snapshot in the path. Send an empty object `{}`, or omit the body.\n",
        "additionalProperties": false
      },
      "BatchSubRequest": {
        "type": "object",
        "description": "One sub-request in a batch request.\n",
        "required": [
          "method",
          "uri"
        ],
        "properties": {
          "method": {
            "type": "string",
            "enum": [
              "POST",
              "PUT",
              "PATCH",
              "DELETE"
            ],
            "description": "The sub-request's HTTP method: `POST`, `PUT`, `PATCH`, or `DELETE`. `GET` isn't supported.\nTo read several resources in one call, use `POST /tasks/batch:get`.\n"
          },
          "uri": {
            "type": "string",
            "description": "The sub-request's path, relative to the API's base URL, for example\n`/zones/example.com.`. You can batch changes to zones, record sets, Inbound IP Sets,\nOutbound IP Sets, Nameserver Sets, TSIG keys, and your account's SOA defaults. Zone actions\nsuch as `/zones/{zoneName}:transfer` aren't supported. Call them directly.\n\nEach sub-request is authorized separately, with the same `X-API-Key` as the batch request,\nso it can't reach resources that you aren't entitled to. The API rejects absolute URLs and\nreferences to other accounts.\n",
            "examples": [
              "/zones/example.com."
            ]
          },
          "body": {
            "type": "object",
            "additionalProperties": true,
            "description": "The sub-request's body, for a `POST`, `PUT`, or `PATCH` sub-request. Omit it for `DELETE`,\nexcept to delete several record sets at once with a `records` list on\n`/zones/{zoneName}/records`.\n"
          }
        }
      },
      "BatchRequest": {
        "type": "object",
        "description": "A batch request: a list of sub-requests to run in one call. You can send up to 50 sub-requests\nwhen `async` is `false`, and up to 1,000 when `async` is `true`.\n",
        "required": [
          "requests"
        ],
        "properties": {
          "requests": {
            "type": "array",
            "minItems": 1,
            "maxItems": 1000,
            "description": "The sub-requests to run, in order: up to 50 when `async` is `false`, and up to 1,000 when\n`async` is `true`. Each sub-request is authorized separately, with the same `X-API-Key` as\nthe batch request.\n\nThe API checks every sub-request before it runs any of them. If a sub-request has an\nunsupported path or method, or a body the API can't read, the API returns `400` for the\nwhole batch request and runs none of the sub-requests.\n",
            "items": {
              "$ref": "#/components/schemas/BatchSubRequest"
            }
          }
        }
      },
      "BatchResultItem": {
        "type": "object",
        "description": "The result of one sub-request. Its position in the results matches the sub-request's position\nin `requests`.\n",
        "required": [
          "status"
        ],
        "properties": {
          "status": {
            "type": "integer",
            "description": "The HTTP status code that the sub-request returned. In a `POST /tasks/batch` response, it's\nalways a success status, because a failed sub-request fails the whole batch request.\n",
            "examples": [
              201,
              409
            ]
          },
          "response": {
            "description": "The sub-request's response body. Its shape depends on the sub-request. It's `null` when\nthe sub-request returns no content, such as `204 No Content`.\n\nIn a `POST /tasks/batch:get` response, a failed sub-request's body is an error in the\nProblem Details format that RFC 9457 defines.\n\nIn a `POST /tasks/batch` response, a sub-request that changes several record sets at once,\nwith a `records` list, has a summary: `requested` and `completed` counts and a `results`\nlist.\n"
          }
        }
      },
      "BatchExecuteResponse": {
        "type": "array",
        "description": "The results of a synchronous batch request. Each entry is the result of the sub-request at the\nsame position in `requests`. The API returns it only when every sub-request succeeded. If one\nfails, the whole batch request fails with that sub-request's error.\n",
        "items": {
          "$ref": "#/components/schemas/BatchResultItem"
        }
      },
      "BatchGetSubRequest": {
        "type": "object",
        "description": "One read sub-request in a batch read request.\n",
        "required": [
          "method",
          "uri"
        ],
        "properties": {
          "method": {
            "type": "string",
            "enum": [
              "GET"
            ],
            "description": "The sub-request's HTTP method. Only `GET` is supported. To batch changes, use\n`POST /tasks/batch`.\n"
          },
          "uri": {
            "type": "string",
            "maxLength": 2048,
            "pattern": "^/[^/\\\\]",
            "description": "The sub-request's path, relative to the API's base URL, with an optional query string. For\nexample, `/zones/example.com./records?pageSize=25`. You can read these resources:\n\n- A zone: `/zones/{zoneName}`.\n- A zone's record sets: `/zones/{zoneName}/records`.\n- A record set: `/zones/{zoneName}/records/{rrtype}/{name}`.\n- A record set in one region: `/zones/{zoneName}/records/{rrtype}/{name}/regions/{region}`.\n\nEach sub-request is authorized separately, with the same `X-API-Key` as the batch request,\nso it can't reach resources that you aren't entitled to. The API rejects absolute URLs and\nreferences to other accounts.\n\nEach sub-request is paginated on its own. A list sub-request returns 1 page, the same as the\nstandalone request. To get the next page, send another sub-request with `pageToken` set to\nthe `nextPageToken` from the previous page.\n",
            "examples": [
              "/zones/example.com.",
              "/zones/example.com./records?pageSize=25"
            ]
          }
        }
      },
      "BatchGetRequest": {
        "type": "object",
        "description": "A batch read request: up to 50 `GET` sub-requests to run in one call.\n\nThe API always runs a batch read request synchronously and returns the results in its response.\nThere's no task to poll and no `onFailure` setting. The API reports every sub-request, and a\nsub-request that fails doesn't stop the others.\n",
        "required": [
          "requests"
        ],
        "properties": {
          "requests": {
            "type": "array",
            "minItems": 1,
            "maxItems": 50,
            "description": "The read sub-requests to run, in order. Each sub-request is authorized separately, with the\nsame `X-API-Key` as the batch request.\n\nIf a sub-request's path is one the API can't read, such as an unknown path, region, or record\ntype, the API reports that sub-request as its own `400` entry and still runs the others. A\nmethod other than `GET` or an absolute URL isn't reported as an entry: the API returns `400`\nfor the whole call. A sub-request that runs and finds nothing is its own `404` entry.\nAn authorization failure isn't reported as an entry. It stops the batch request, and the API\nreturns `403` for the whole call.\n",
            "items": {
              "$ref": "#/components/schemas/BatchGetSubRequest"
            }
          }
        }
      },
      "BatchGetResponse": {
        "type": "array",
        "description": "The results of a batch read request. Each entry is the result of the sub-request at the same\nposition in `requests`. A sub-request that fails doesn't stop the others, so the API returns\n`200` even when some entries report an error.\n\nEach entry's `status` is one of these:\n\n- A `2xx` status: The sub-request succeeded.\n- `400`: The sub-request's path is one the API can't read, so it didn't run it.\n- `404`: The sub-request ran, and the resource it addresses doesn't exist.\n\nNo entry has a `403` status. An authorization failure stops the batch request, and the API\nreturns `403` for the whole call.\n\nThe API reports every sub-request, so no entry is `null`.\n",
        "items": {
          "$ref": "#/components/schemas/BatchResultItem"
        }
      },
      "Integration": {
        "type": "object",
        "description": "The status of an integration for your account.\n",
        "required": [
          "status"
        ],
        "properties": {
          "status": {
            "type": "string",
            "enum": [
              "PENDING",
              "ACTIVE",
              "NOT_LINKED",
              "ERROR"
            ],
            "description": "The integration's status:\n\n- `PENDING`: The integration is linked, and activation in CertCentral\n  isn't finished. Configure the `apiKey` and `apiSecret` from the\n  link response in CertCentral to finish it. `CERTCENTRAL` only.\n- `ACTIVE`: The integration is linked and working.\n- `NOT_LINKED`: The integration isn't linked to your account.\n- `ERROR`: The integration has an error. Contact DigiCert support.\n  `CERTCENTRAL` only.\n\n`VALIMAIL-MONITOR` is always `ACTIVE` or `NOT_LINKED`, because it\ndoesn't need activation.\n"
          },
          "createdAt": {
            "type": "string",
            "format": "date-time",
            "description": "When the integration was linked. In the response to a `CERTCENTRAL` link or update\nrequest, it's the time of that request. For `VALIMAIL-MONITOR`, it comes from your\nValimail account.\n"
          },
          "updatedAt": {
            "type": "string",
            "format": "date-time",
            "description": "When the integration last changed. In the response to a `CERTCENTRAL` link or update\nrequest, it's the time of that request. For `VALIMAIL-MONITOR`, it comes from your\nValimail account.\n"
          }
        }
      },
      "IntegrationLinkResponse": {
        "type": "object",
        "description": "The result of linking the `CERTCENTRAL` integration or issuing it new\ncredentials. To finish activation, configure the `apiKey` and\n`apiSecret` in CertCentral. Only this response returns them, so store\nthem securely.\n",
        "required": [
          "status",
          "apiKey",
          "apiSecret",
          "createdAt",
          "updatedAt"
        ],
        "properties": {
          "status": {
            "type": "string",
            "enum": [
              "PENDING"
            ],
            "description": "Always `PENDING`. The status changes when CertCentral finishes\nactivation.\n"
          },
          "apiKey": {
            "type": "string",
            "description": "The API key to configure in CertCentral, together with `apiSecret`,\nto finish activation.\n"
          },
          "apiSecret": {
            "type": "string",
            "format": "password",
            "description": "The API secret to configure in CertCentral, together with `apiKey`,\nto finish activation. Store it securely, and don't write it to logs.\n"
          },
          "createdAt": {
            "type": "string",
            "format": "date-time",
            "description": "When the integration was first linked."
          },
          "updatedAt": {
            "type": "string",
            "format": "date-time",
            "description": "When the integration's status last changed."
          }
        }
      },
      "ValimailIntegrationLinkResponse": {
        "type": "object",
        "description": "The result of linking the `VALIMAIL-MONITOR` integration. The\nintegration is active as soon as it's linked. You don't need to set\nanything up in Valimail.\n",
        "required": [
          "status",
          "createdAt",
          "updatedAt"
        ],
        "properties": {
          "status": {
            "type": "string",
            "enum": [
              "ACTIVE"
            ],
            "description": "Always `ACTIVE`, because the Valimail Monitor integration doesn't\nneed activation.\n"
          },
          "createdAt": {
            "type": "string",
            "format": "date-time",
            "description": "When the integration was first linked."
          },
          "updatedAt": {
            "type": "string",
            "format": "date-time",
            "description": "When the integration's status last changed."
          }
        }
      }
    },
    "headers": {
      "XRequestId": {
        "description": "The ID of the request, for example `req_2033dc03-f17d-47fe-a619-897ae3629d16`. It can differ from an `X-Request-Id` that you sent. Include it when you contact support.",
        "schema": {
          "type": "string",
          "pattern": "^[A-Za-z0-9._~-]{8,128}$",
          "example": "req_2033dc03-f17d-47fe-a619-897ae3629d16"
        }
      },
      "XRateLimitLimit": {
        "description": "Maximum number of requests permitted in the current rate-limit window.",
        "schema": {
          "type": "integer",
          "minimum": 0,
          "example": 1000
        }
      },
      "XRateLimitRemaining": {
        "description": "Number of requests remaining in the current rate-limit window.",
        "schema": {
          "type": "integer",
          "minimum": 0,
          "example": 950
        }
      },
      "XRateLimitReset": {
        "description": "Unix timestamp (seconds) at which the current rate-limit window resets.",
        "schema": {
          "type": "integer",
          "minimum": 0,
          "example": 1719014400
        }
      },
      "RetryAfter": {
        "description": "Number of seconds the client should wait before retrying the request.",
        "schema": {
          "type": "integer",
          "minimum": 1,
          "examples": [
            30
          ]
        }
      },
      "Location": {
        "description": "The URI of a resource related to the response. Most `201 Created` and `202 Accepted` responses\ninclude it.\n\n- On `201 Created`, it's the URI of the new resource, for example `/v1/zones/example.com.`.\n  Not every `201` response includes it.\n- On `202 Accepted`, it's the URI of the asynchronous task, for example\n  `/v1/tasks/async/{taskId}`. Poll it to get the final result. If a `202` response doesn't\n  include it, the task already finished, and the body shows its final status.\n\nTreat the URI as opaque and follow it as it is. The API doesn't put client state in its query\nstring.\n\nThe URI is a path that starts with `/v1`. Add it to the scheme and host that you sent the\nrequest to, for example `https://api.dns.digicert.com/v1/zones/example.com.`.\n",
        "schema": {
          "type": "string",
          "format": "uri-reference",
          "examples": [
            "/v1/zones/example.com.",
            "/v1/tasks/async/5b7d2c1a-3f8e-4a2c-9d1b-7f6e5a4c3b2a"
          ]
        }
      },
      "XIdempotentReplayed": {
        "description": "Set to `true` when the response is a stored copy of the response to an earlier request with the same `Idempotency-Key`, and the request didn't run again. The header isn't sent the first time a request runs.",
        "schema": {
          "type": "boolean",
          "enum": [
            true
          ],
          "example": true
        }
      }
    },
    "responses": {
      "BadRequest": {
        "description": "The request isn't valid. One or more fields failed validation.\n\nThe `code` depends on the operation. Zone and record operations return `VALIDATION_FAILED`.\nUser and role operations return `VALIDATION_ERROR`. The examples show both.\n",
        "headers": {
          "X-Request-Id": {
            "$ref": "#/components/headers/XRequestId"
          }
        },
        "content": {
          "application/problem+json": {
            "schema": {
              "$ref": "#/components/schemas/ProblemDetail"
            },
            "examples": {
              "validationErrorUnifiedApi": {
                "summary": "A request body field failed validation in a zone or record request",
                "value": {
                  "type": "https://errors.dns.digicert.com/bad-request",
                  "title": "Validation Error",
                  "status": 400,
                  "detail": "Request body contains invalid fields",
                  "code": "VALIDATION_FAILED",
                  "errors": [
                    {
                      "field": "name",
                      "message": "mustn't be empty",
                      "code": "REQUIRED"
                    }
                  ]
                }
              },
              "batchValidation": {
                "summary": "One or more sub-requests in a batch failed validation",
                "value": {
                  "type": "https://errors.dns.digicert.com/bad-request",
                  "title": "Validation Error",
                  "status": 400,
                  "detail": "One or more sub-requests failed validation",
                  "code": "VALIDATION_FAILED",
                  "errors": [
                    {
                      "index": 3,
                      "field": "ttl",
                      "message": "must be a positive integer",
                      "code": "OUT_OF_RANGE"
                    },
                    {
                      "index": 7,
                      "field": "content",
                      "message": "is not valid BIND presentation format",
                      "code": "INVALID_FORMAT"
                    }
                  ]
                }
              },
              "validationErrorRbac": {
                "summary": "A query parameter failed validation in a user or role request",
                "value": {
                  "type": "https://errors.dns.digicert.com/bad-request",
                  "title": "Validation Error",
                  "status": 400,
                  "detail": "Failed to convert 'roleIds': 'not-a-uuid' is not a valid UUID",
                  "code": "VALIDATION_ERROR"
                }
              }
            }
          }
        }
      },
      "Unauthorized": {
        "description": "The API key is missing or isn't valid.",
        "headers": {
          "X-Request-Id": {
            "$ref": "#/components/headers/XRequestId"
          }
        },
        "content": {
          "application/problem+json": {
            "schema": {
              "$ref": "#/components/schemas/ProblemDetail"
            },
            "example": {
              "type": "https://errors.dns.digicert.com/unauthorized",
              "title": "Unauthorized",
              "status": 401,
              "detail": "The X-API-Key header is missing or invalid",
              "code": "UNAUTHORIZED"
            }
          }
        }
      },
      "Forbidden": {
        "description": "The caller doesn't have the permission that the operation requires.",
        "headers": {
          "X-Request-Id": {
            "$ref": "#/components/headers/XRequestId"
          }
        },
        "content": {
          "application/problem+json": {
            "schema": {
              "$ref": "#/components/schemas/ProblemDetail"
            },
            "example": {
              "type": "https://errors.dns.digicert.com/forbidden",
              "title": "Forbidden",
              "status": 403,
              "detail": "You do not have permission to access this resource",
              "code": "FORBIDDEN"
            }
          }
        }
      },
      "TooManyRequests": {
        "description": "The request exceeded the rate limit. Retry after the time in the `Retry-After` header.",
        "headers": {
          "X-Request-Id": {
            "$ref": "#/components/headers/XRequestId"
          },
          "Retry-After": {
            "$ref": "#/components/headers/RetryAfter"
          },
          "X-RateLimit-Limit": {
            "$ref": "#/components/headers/XRateLimitLimit"
          },
          "X-RateLimit-Remaining": {
            "$ref": "#/components/headers/XRateLimitRemaining"
          },
          "X-RateLimit-Reset": {
            "$ref": "#/components/headers/XRateLimitReset"
          }
        },
        "content": {
          "application/problem+json": {
            "schema": {
              "$ref": "#/components/schemas/ProblemDetail"
            },
            "example": {
              "type": "https://errors.dns.digicert.com/rate-limited",
              "title": "Rate Limited",
              "status": 429,
              "detail": "You have exceeded the allowed request rate. Retry after the Retry-After period."
            }
          }
        }
      },
      "InternalServerError": {
        "description": "An unexpected error occurred.\n\nThe `code` depends on the operation. Zone and record operations return\n`INTERNAL_SERVER_ERROR`. User and role operations return `INTERNAL_ERROR`.\n",
        "headers": {
          "X-Request-Id": {
            "$ref": "#/components/headers/XRequestId"
          }
        },
        "content": {
          "application/problem+json": {
            "schema": {
              "$ref": "#/components/schemas/ProblemDetail"
            },
            "examples": {
              "internalErrorUnifiedApi": {
                "summary": "An unexpected error in a zone or record request",
                "value": {
                  "type": "https://errors.dns.digicert.com/internal-error",
                  "title": "Internal Server Error",
                  "status": 500,
                  "detail": "An unexpected server error occurred",
                  "code": "INTERNAL_SERVER_ERROR"
                }
              },
              "internalErrorRbac": {
                "summary": "An unexpected error in a user or role request",
                "value": {
                  "type": "https://errors.dns.digicert.com/internal-error",
                  "title": "Internal server error",
                  "status": 500,
                  "detail": "An unexpected server error occurred",
                  "code": "INTERNAL_ERROR"
                }
              }
            }
          }
        }
      },
      "BadGateway": {
        "description": "A service that the API depends on returned an error or a response that isn't valid.",
        "headers": {
          "X-Request-Id": {
            "$ref": "#/components/headers/XRequestId"
          }
        },
        "content": {
          "application/problem+json": {
            "schema": {
              "$ref": "#/components/schemas/ProblemDetail"
            },
            "example": {
              "type": "https://errors.dns.digicert.com/bad-gateway",
              "title": "Bad Gateway",
              "status": 502,
              "code": "BAD_GATEWAY",
              "detail": "[53001] Invalid zone type"
            }
          }
        }
      },
      "ServiceUnavailable": {
        "description": "The service is temporarily unavailable. If the response has a `Retry-After` header, wait that long before you retry.",
        "headers": {
          "X-Request-Id": {
            "$ref": "#/components/headers/XRequestId"
          },
          "Retry-After": {
            "$ref": "#/components/headers/RetryAfter"
          }
        },
        "content": {
          "application/problem+json": {
            "schema": {
              "$ref": "#/components/schemas/ProblemDetail"
            },
            "example": {
              "type": "https://errors.dns.digicert.com/service-unavailable",
              "title": "Service Unavailable",
              "status": 503,
              "detail": "The service is temporarily unavailable. Please try again later.",
              "code": "SERVICE_UNAVAILABLE"
            }
          }
        }
      },
      "GatewayTimeout": {
        "description": "A service that the API depends on didn't respond in time.",
        "headers": {
          "X-Request-Id": {
            "$ref": "#/components/headers/XRequestId"
          }
        },
        "content": {
          "application/problem+json": {
            "schema": {
              "$ref": "#/components/schemas/ProblemDetail"
            },
            "example": {
              "type": "https://errors.dns.digicert.com/gateway-timeout",
              "title": "Gateway Timeout",
              "status": 504,
              "code": "GATEWAY_TIMEOUT",
              "detail": "The upstream DNS provider did not respond within the request timeout."
            }
          }
        }
      },
      "NotFound": {
        "description": "The resource doesn't exist.\n\nThe `code` depends on the operation. Zone and record operations return `RESOURCE_NOT_FOUND`.\nUser and role operations return `NOT_FOUND`, or a more specific code such as\n`PRINCIPAL_NOT_FOUND` or `ROLE_NOT_FOUND`.\n",
        "headers": {
          "X-Request-Id": {
            "$ref": "#/components/headers/XRequestId"
          }
        },
        "content": {
          "application/problem+json": {
            "schema": {
              "$ref": "#/components/schemas/ProblemDetail"
            },
            "examples": {
              "notFoundUnifiedApi": {
                "summary": "The resource in a zone or record request was not found",
                "value": {
                  "type": "https://errors.dns.digicert.com/not-found",
                  "title": "Not Found",
                  "status": 404,
                  "detail": "The requested resource does not exist",
                  "code": "RESOURCE_NOT_FOUND"
                }
              },
              "notFoundRbac": {
                "summary": "The resource in a user or role request was not found",
                "value": {
                  "type": "https://errors.dns.digicert.com/not-found",
                  "title": "Not Found",
                  "status": 404,
                  "detail": "The requested resource does not exist",
                  "code": "NOT_FOUND"
                }
              }
            }
          }
        }
      },
      "Conflict": {
        "description": "The resource already exists, or an earlier request with the same `Idempotency-Key` is still running.",
        "headers": {
          "X-Request-Id": {
            "$ref": "#/components/headers/XRequestId"
          }
        },
        "content": {
          "application/problem+json": {
            "schema": {
              "$ref": "#/components/schemas/ProblemDetail"
            },
            "examples": {
              "resourceConflict": {
                "summary": "A resource with this identifier already exists",
                "value": {
                  "type": "https://errors.dns.digicert.com/conflict",
                  "title": "Conflict",
                  "status": 409,
                  "detail": "A resource with this identifier already exists.",
                  "code": "CONFLICT"
                }
              },
              "idempotencyInFlight": {
                "summary": "An earlier request with the same Idempotency-Key is still running",
                "value": {
                  "type": "https://errors.dns.digicert.com/idempotency-in-flight",
                  "title": "Idempotency In Flight",
                  "status": 409,
                  "detail": "A request with this Idempotency-Key is already in progress. Retry after the first request completes.",
                  "code": "IDEMPOTENCY_IN_FLIGHT"
                }
              }
            }
          }
        }
      },
      "PayloadTooLarge": {
        "description": "The request body is larger than the maximum allowed size.",
        "headers": {
          "X-Request-Id": {
            "$ref": "#/components/headers/XRequestId"
          }
        },
        "content": {
          "application/problem+json": {
            "schema": {
              "$ref": "#/components/schemas/ProblemDetail"
            },
            "example": {
              "type": "https://errors.dns.digicert.com/payload-too-large",
              "title": "Payload Too Large",
              "status": 413,
              "detail": "Request body exceeds the allowed size limit"
            }
          }
        }
      },
      "UnsupportedMediaType": {
        "description": "The operation doesn't support the request's `Content-Type`, or the required `Content-Type`\nheader is missing.\n",
        "headers": {
          "X-Request-Id": {
            "$ref": "#/components/headers/XRequestId"
          }
        },
        "content": {
          "application/problem+json": {
            "schema": {
              "$ref": "#/components/schemas/ProblemDetail"
            },
            "example": {
              "type": "https://errors.dns.digicert.com/unsupported-media-type",
              "title": "Unsupported Media Type",
              "status": 415,
              "detail": "Request Content-Type is not supported. Use 'application/json'.",
              "code": "UNSUPPORTED_MEDIA_TYPE"
            }
          }
        }
      },
      "UnprocessableEntity": {
        "description": "The request is well formed, but the API can't process it.\n\nThe `code` and `type` depend on the operation. User and role operations return a specific\ncode such as `INVALID_SCOPE` or `INVALID_ROLE_FOR_SCOPE`, or `UNPROCESSABLE_ENTITY` for a\ngeneral rejection, all with the `unprocessable-entity` type. Zone and record operations\nreturn `INTER_COMMUNICATION_ERROR` or `DNS_ZONE_ERROR`, each with its own type.\n",
        "headers": {
          "X-Request-Id": {
            "$ref": "#/components/headers/XRequestId"
          }
        },
        "content": {
          "application/problem+json": {
            "schema": {
              "$ref": "#/components/schemas/ProblemDetail"
            },
            "examples": {
              "unprocessableRbac": {
                "summary": "A user or role request that the API rejected",
                "value": {
                  "type": "https://errors.dns.digicert.com/unprocessable-entity",
                  "title": "Unprocessable Entity",
                  "status": 422,
                  "detail": "The request was well-formed but could not be processed due to semantic errors",
                  "code": "UNPROCESSABLE_ENTITY"
                }
              },
              "dnsZoneErrorUnifiedApi": {
                "summary": "A zone request that the API rejected for a DNS reason",
                "value": {
                  "type": "https://errors.dns.digicert.com/dns-zone-error",
                  "title": "DNS Zone Error",
                  "status": 422,
                  "detail": "[53001] Invalid zone type",
                  "code": "DNS_ZONE_ERROR"
                }
              }
            }
          }
        }
      },
      "BadRequestRRSet": {
        "description": "The request isn't valid. One or more fields or query parameters failed validation.",
        "headers": {
          "X-Request-Id": {
            "$ref": "#/components/headers/XRequestId"
          }
        },
        "content": {
          "application/problem+json": {
            "schema": {
              "$ref": "#/components/schemas/ProblemDetail"
            },
            "examples": {
              "validationError": {
                "summary": "A request body field failed validation",
                "value": {
                  "type": "https://errors.dns.digicert.com/bad-request",
                  "title": "Validation Error",
                  "status": 400,
                  "detail": "Request body contains invalid fields",
                  "code": "VALIDATION_FAILED",
                  "errors": [
                    {
                      "field": "ttl",
                      "message": "must be a positive integer",
                      "code": "OUT_OF_RANGE"
                    }
                  ]
                }
              },
              "globalSearchConflict": {
                "summary": "globalSearch sent with a parameter it can't be combined with",
                "value": {
                  "type": "https://errors.dns.digicert.com/bad-request",
                  "title": "Validation Error",
                  "status": 400,
                  "detail": "globalSearch cannot be combined with ttl[*], content, sortBy, or sortOrder",
                  "code": "VALIDATION_FAILED",
                  "errors": [
                    {
                      "field": "globalSearch",
                      "message": "cannot be combined with ttl[*], content, sortBy, or sortOrder",
                      "code": "INVALID_COMBINATION"
                    }
                  ]
                }
              },
              "rdataMutualExclusion": {
                "summary": "Both routing.content and routing.rdata sent",
                "value": {
                  "type": "https://errors.dns.digicert.com/bad-request",
                  "title": "Validation Error",
                  "status": 400,
                  "detail": "Provide either routing.content or routing.rdata, not both",
                  "code": "VALIDATION_FAILED",
                  "errors": [
                    {
                      "field": "routing",
                      "message": "Provide either routing.content or routing.rdata, not both",
                      "code": "MUTUALLY_EXCLUSIVE"
                    }
                  ]
                }
              },
              "rdataUnsupportedType": {
                "summary": "routing.rdata sent for a record type that accepts only routing.content",
                "value": {
                  "type": "https://errors.dns.digicert.com/bad-request",
                  "title": "Validation Error",
                  "status": 400,
                  "detail": "Use content in BIND format for record type A; rdata is not supported",
                  "code": "VALIDATION_FAILED",
                  "errors": [
                    {
                      "field": "routing.rdata",
                      "message": "Use content in BIND format for record type A; rdata is not supported",
                      "code": "UNSUPPORTED_TYPE"
                    }
                  ]
                }
              },
              "rdataTypeMismatch": {
                "summary": "The type of a routing.rdata item doesn't match the record type",
                "value": {
                  "type": "https://errors.dns.digicert.com/bad-request",
                  "title": "Validation Error",
                  "status": 400,
                  "detail": "Use rdata that matches record type TLSA; received HTTPS",
                  "code": "VALIDATION_FAILED",
                  "errors": [
                    {
                      "field": "routing.rdata[0].type",
                      "message": "Use rdata that matches record type TLSA; received HTTPS",
                      "code": "TYPE_MISMATCH"
                    }
                  ]
                }
              },
              "rdataAliasModeParams": {
                "summary": "Service parameters sent on an AliasMode item with priority 0",
                "value": {
                  "type": "https://errors.dns.digicert.com/bad-request",
                  "title": "Validation Error",
                  "status": 400,
                  "detail": "Remove all service parameters when using AliasMode (priority 0): alpn, port, ipv4hint, ipv6hint, and additionalSvcParams",
                  "code": "VALIDATION_FAILED",
                  "errors": [
                    {
                      "field": "routing.rdata[0]",
                      "message": "Remove all service parameters when using AliasMode (priority 0): alpn, port, ipv4hint, ipv6hint, and additionalSvcParams",
                      "code": "ALIAS_MODE_PARAMS"
                    }
                  ]
                }
              }
            }
          }
        }
      }
    }
  }
}
