manage_domain_nameservers
Plan and manage optional AWS hosted DNS for a workspace domain while keeping registrar delegation under the domain owner's control.
# MCP tool reference
1 callable tools.
Use tools/call at https://mcp.schedulerzero.com/mcp with the exact tool name and arguments below. The /tools/ paths in this view are documentation identifiers, not HTTP endpoints. Request execution is disabled for this reference.
Inputs are shown for personal API keys (bound) and for OAuth/delegated agents. Output schemas describe MCP structuredContent: native objects pass through; arrays, scalars and null use a data wrapper. Text content retains the native JSON result.
[Connect a client](/mcp/connect) · [Authentication and authorization](/authentication) · [Generated auth guide](/auth.md) · [Download tool catalog](/mcp-catalog.json) · [Agent documentation](/llms.txt)
## manage_domain_nameservers
Plan and manage optional AWS hosted DNS for a workspace domain while keeping registrar delegation under the domain owner's control.
Use to inspect nameserver hosting, prepare a plan from a complete DNS export, revise mistaken records or source nameservers before any AWS create attempt or environment assignment, verify DNS TXT ownership before creating the paid zone, provision an independent Route 53 public zone, import records before a person performs registrar handoff, update records only after import is INSYNC, and check recursive DNS observations. Replanning recomputes plan and record hashes/revisions and preserves the ownership challenge. Updates require expectedRecordsHash to match the current AWS hash before UPSERT and retain every existing record name and type; this release does not support deletion.
Do not infer a complete DNS zone from public DNS. This creates a separate identifiable AWS public zone per domain, with no reusable delegation sets; it never changes nameservers automatically. Recursive NS matching is not verified parent delegation. While pendingRecords is set, records and recordsHash remain the last confirmed state. Check resumes only the same already-confirmed pending UPSERT to recover its AWS change ID; it creates no new write intent or confirmation. Preserve the last confirmed records/hash, old zone, mail records, and ACM validation records.
Obtain the user's explicit authorization before invoking a write or destructive action. This is a client interaction requirement, not a server-issued approval token.
Scopes: domain:manage_dns
Risk: destructive; confirmation: explicit; idempotency: supported.
### Input schema (personal API key)
```json
{
"type": "object",
"properties": {
"workspaceId": {
"type": "string",
"pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|[fF]{8}-[fF]{4}-[fF]{4}-[fF]{4}-[fF]{12})$",
"format": "uuid"
},
"action": {
"anyOf": [
{
"type": "object",
"properties": {
"kind": {
"type": "string",
"enum": [
"list"
]
}
},
"required": [
"kind"
],
"patternProperties": {
"^(?!(?:kind)$)[\\s\\S]*$": false
},
"additionalProperties": true,
"propertyNames": {
"anyOf": [
{
"type": "string",
"enum": [
"kind"
]
}
]
}
},
{
"type": "object",
"properties": {
"kind": {
"type": "string",
"enum": [
"get"
]
},
"zoneId": {
"type": "string",
"pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|[fF]{8}-[fF]{4}-[fF]{4}-[fF]{4}-[fF]{12})$",
"format": "uuid"
}
},
"required": [
"kind",
"zoneId"
],
"patternProperties": {
"^(?!(?:kind|zoneId)$)[\\s\\S]*$": false
},
"additionalProperties": true,
"propertyNames": {
"type": "string",
"enum": [
"kind",
"zoneId"
]
}
},
{
"type": "object",
"properties": {
"kind": {
"type": "string",
"enum": [
"plan"
]
},
"request": {
"type": "object",
"properties": {
"hostname": {
"$ref": "#/$defs/DomainName"
},
"records": {
"type": "array",
"items": {
"type": "object",
"properties": {
"name": {
"type": "string",
"minLength": 1,
"maxLength": 253
},
"type": {
"type": "string",
"enum": [
"A",
"AAAA",
"CNAME",
"MX",
"TXT",
"CAA",
"SRV",
"NS",
"PTR",
"NAPTR",
"DS"
]
},
"ttl": {
"type": "integer"
},
"values": {
"type": "array",
"items": {
"type": "string",
"maxLength": 65536
},
"maxItems": 500
},
"aliasTarget": {
"type": "object",
"properties": {
"dnsName": {
"type": "string",
"minLength": 1,
"maxLength": 253
},
"hostedZoneId": {
"type": "string",
"minLength": 1,
"maxLength": 128
},
"evaluateTargetHealth": {
"type": "boolean"
}
},
"required": [
"dnsName",
"hostedZoneId",
"evaluateTargetHealth"
],
"patternProperties": {
"^(?!(?:dnsName|hostedZoneId|evaluateTargetHealth)$)[\\s\\S]*$": false
},
"additionalProperties": true,
"propertyNames": {
"type": "string",
"enum": [
"dnsName",
"hostedZoneId",
"evaluateTargetHealth"
]
}
}
},
"required": [
"name",
"type",
"ttl",
"values"
],
"patternProperties": {
"^(?!(?:name|type|ttl|values|aliasTarget)$)[\\s\\S]*$": false
},
"additionalProperties": true,
"propertyNames": {
"type": "string",
"enum": [
"name",
"type",
"ttl",
"values",
"aliasTarget"
]
}
},
"maxItems": 500
},
"sourceNameservers": {
"type": "array",
"items": {
"type": "string",
"minLength": 1,
"maxLength": 253
},
"maxItems": 32
},
"completeExportAcknowledged": {
"type": "boolean"
}
},
"required": [
"hostname",
"records",
"sourceNameservers",
"completeExportAcknowledged"
],
"patternProperties": {
"^(?!(?:hostname|records|sourceNameservers|completeExportAcknowledged)$)[\\s\\S]*$": false
},
"additionalProperties": true,
"propertyNames": {
"type": "string",
"enum": [
"hostname",
"records",
"sourceNameservers",
"completeExportAcknowledged"
]
}
}
},
"required": [
"kind",
"request"
],
"patternProperties": {
"^(?!(?:kind|request)$)[\\s\\S]*$": false
},
"additionalProperties": true,
"propertyNames": {
"type": "string",
"enum": [
"kind",
"request"
]
}
},
{
"type": "object",
"properties": {
"kind": {
"type": "string",
"enum": [
"replan"
]
},
"zoneId": {
"type": "string",
"pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|[fF]{8}-[fF]{4}-[fF]{4}-[fF]{4}-[fF]{12})$",
"format": "uuid"
},
"request": {
"type": "object",
"properties": {
"expectedRevision": {
"type": "integer",
"minimum": 0,
"maximum": 9007199254740991
},
"records": {
"type": "array",
"items": {
"type": "object",
"properties": {
"name": {
"type": "string",
"minLength": 1,
"maxLength": 253
},
"type": {
"type": "string",
"enum": [
"A",
"AAAA",
"CNAME",
"MX",
"TXT",
"CAA",
"SRV",
"NS",
"PTR",
"NAPTR",
"DS"
]
},
"ttl": {
"type": "integer"
},
"values": {
"type": "array",
"items": {
"type": "string",
"maxLength": 65536
},
"maxItems": 500
},
"aliasTarget": {
"type": "object",
"properties": {
"dnsName": {
"type": "string",
"minLength": 1,
"maxLength": 253
},
"hostedZoneId": {
"type": "string",
"minLength": 1,
"maxLength": 128
},
"evaluateTargetHealth": {
"type": "boolean"
}
},
"required": [
"dnsName",
"hostedZoneId",
"evaluateTargetHealth"
],
"patternProperties": {
"^(?!(?:dnsName|hostedZoneId|evaluateTargetHealth)$)[\\s\\S]*$": false
},
"additionalProperties": true,
"propertyNames": {
"type": "string",
"enum": [
"dnsName",
"hostedZoneId",
"evaluateTargetHealth"
]
}
}
},
"required": [
"name",
"type",
"ttl",
"values"
],
"patternProperties": {
"^(?!(?:name|type|ttl|values|aliasTarget)$)[\\s\\S]*$": false
},
"additionalProperties": true,
"propertyNames": {
"type": "string",
"enum": [
"name",
"type",
"ttl",
"values",
"aliasTarget"
]
}
},
"maxItems": 500
},
"sourceNameservers": {
"type": "array",
"items": {
"type": "string",
"minLength": 1,
"maxLength": 253
},
"maxItems": 32
},
"completeExportAcknowledged": {
"type": "boolean"
}
},
"required": [
"expectedRevision",
"records",
"sourceNameservers",
"completeExportAcknowledged"
],
"patternProperties": {
"^(?!(?:expectedRevision|records|sourceNameservers|completeExportAcknowledged)$)[\\s\\S]*$": false
},
"additionalProperties": true,
"propertyNames": {
"type": "string",
"enum": [
"expectedRevision",
"records",
"sourceNameservers",
"completeExportAcknowledged"
]
}
}
},
"required": [
"kind",
"zoneId",
"request"
],
"patternProperties": {
"^(?!(?:kind|zoneId|request)$)[\\s\\S]*$": false
},
"additionalProperties": true,
"propertyNames": {
"type": "string",
"enum": [
"kind",
"zoneId",
"request"
]
}
},
{
"type": "object",
"properties": {
"kind": {
"type": "string",
"enum": [
"provision"
]
},
"zoneId": {
"type": "string",
"pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|[fF]{8}-[fF]{4}-[fF]{4}-[fF]{4}-[fF]{12})$",
"format": "uuid"
},
"request": {
"type": "object",
"properties": {
"expectedRevision": {
"type": "integer",
"minimum": 0,
"maximum": 9007199254740991
},
"planHash": {
"type": "string",
"minLength": 1,
"maxLength": 256
},
"paidHostingAcknowledged": {
"type": "boolean"
},
"dnssecMigrationAcknowledged": {
"type": "boolean"
},
"providerCoordinationAcknowledged": {
"type": "boolean"
}
},
"required": [
"expectedRevision",
"planHash",
"paidHostingAcknowledged",
"dnssecMigrationAcknowledged",
"providerCoordinationAcknowledged"
],
"patternProperties": {
"^(?!(?:expectedRevision|planHash|paidHostingAcknowledged|dnssecMigrationAcknowledged|providerCoordinationAcknowledged)$)[\\s\\S]*$": false
},
"additionalProperties": true,
"propertyNames": {
"type": "string",
"enum": [
"expectedRevision",
"planHash",
"paidHostingAcknowledged",
"dnssecMigrationAcknowledged",
"providerCoordinationAcknowledged"
]
}
}
},
"required": [
"kind",
"zoneId",
"request"
],
"patternProperties": {
"^(?!(?:kind|zoneId|request)$)[\\s\\S]*$": false
},
"additionalProperties": true,
"propertyNames": {
"type": "string",
"enum": [
"kind",
"zoneId",
"request"
]
}
},
{
"type": "object",
"properties": {
"kind": {
"type": "string",
"enum": [
"update"
]
},
"zoneId": {
"type": "string",
"pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|[fF]{8}-[fF]{4}-[fF]{4}-[fF]{4}-[fF]{12})$",
"format": "uuid"
},
"request": {
"type": "object",
"properties": {
"expectedRevision": {
"type": "integer",
"minimum": 0,
"maximum": 9007199254740991
},
"expectedRecordsHash": {
"type": "string",
"minLength": 1,
"maxLength": 256
},
"records": {
"type": "array",
"items": {
"type": "object",
"properties": {
"name": {
"type": "string",
"minLength": 1,
"maxLength": 253
},
"type": {
"type": "string",
"enum": [
"A",
"AAAA",
"CNAME",
"MX",
"TXT",
"CAA",
"SRV",
"NS",
"PTR",
"NAPTR",
"DS"
]
},
"ttl": {
"type": "integer"
},
"values": {
"type": "array",
"items": {
"type": "string",
"maxLength": 65536
},
"maxItems": 500
},
"aliasTarget": {
"type": "object",
"properties": {
"dnsName": {
"type": "string",
"minLength": 1,
"maxLength": 253
},
"hostedZoneId": {
"type": "string",
"minLength": 1,
"maxLength": 128
},
"evaluateTargetHealth": {
"type": "boolean"
}
},
"required": [
"dnsName",
"hostedZoneId",
"evaluateTargetHealth"
],
"patternProperties": {
"^(?!(?:dnsName|hostedZoneId|evaluateTargetHealth)$)[\\s\\S]*$": false
},
"additionalProperties": true,
"propertyNames": {
"type": "string",
"enum": [
"dnsName",
"hostedZoneId",
"evaluateTargetHealth"
]
}
}
},
"required": [
"name",
"type",
"ttl",
"values"
],
"patternProperties": {
"^(?!(?:name|type|ttl|values|aliasTarget)$)[\\s\\S]*$": false
},
"additionalProperties": true,
"propertyNames": {
"type": "string",
"enum": [
"name",
"type",
"ttl",
"values",
"aliasTarget"
]
}
},
"maxItems": 500
}
},
"required": [
"expectedRevision",
"expectedRecordsHash",
"records"
],
"patternProperties": {
"^(?!(?:expectedRevision|expectedRecordsHash|records)$)[\\s\\S]*$": false
},
"additionalProperties": true,
"propertyNames": {
"type": "string",
"enum": [
"expectedRevision",
"expectedRecordsHash",
"records"
]
}
}
},
"required": [
"kind",
"zoneId",
"request"
],
"patternProperties": {
"^(?!(?:kind|zoneId|request)$)[\\s\\S]*$": false
},
"additionalProperties": true,
"propertyNames": {
"type": "string",
"enum": [
"kind",
"zoneId",
"request"
]
}
},
{
"type": "object",
"properties": {
"kind": {
"type": "string",
"enum": [
"check"
]
},
"zoneId": {
"type": "string",
"pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|[fF]{8}-[fF]{4}-[fF]{4}-[fF]{4}-[fF]{12})$",
"format": "uuid"
},
"request": {
"type": "object",
"properties": {
"expectedRevision": {
"type": "integer",
"minimum": 0,
"maximum": 9007199254740991
}
},
"required": [
"expectedRevision"
],
"patternProperties": {
"^(?!(?:expectedRevision)$)[\\s\\S]*$": false
},
"additionalProperties": true,
"propertyNames": {
"anyOf": [
{
"type": "string",
"enum": [
"expectedRevision"
]
}
]
}
}
},
"required": [
"kind",
"zoneId",
"request"
],
"patternProperties": {
"^(?!(?:kind|zoneId|request)$)[\\s\\S]*$": false
},
"additionalProperties": true,
"propertyNames": {
"type": "string",
"enum": [
"kind",
"zoneId",
"request"
]
}
}
]
}
},
"required": [
"workspaceId",
"action"
],
"patternProperties": {
"^(?!(?:workspaceId|action)$)[\\s\\S]*$": false
},
"additionalProperties": true,
"propertyNames": {
"type": "string",
"enum": [
"workspaceId",
"action"
]
},
"$defs": {
"DomainName": {
"type": "string",
"minLength": 1,
"maxLength": 253,
"pattern": "^(?=.{1,253}$)(?:[a-zA-Z0-9](?:[a-zA-Z0-9-]{0,61}[a-zA-Z0-9])?\\.)+[a-zA-Z]{2,63}$"
}
}
}
```
### Input schema (OAuth / delegated agent)
```json
{
"type": "object",
"properties": {
"workspaceId": {
"type": "string",
"pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|[fF]{8}-[fF]{4}-[fF]{4}-[fF]{4}-[fF]{12})$",
"format": "uuid"
},
"action": {
"anyOf": [
{
"type": "object",
"properties": {
"kind": {
"type": "string",
"enum": [
"list"
]
}
},
"required": [
"kind"
],
"patternProperties": {
"^(?!(?:kind)$)[\\s\\S]*$": false
},
"additionalProperties": true,
"propertyNames": {
"anyOf": [
{
"type": "string",
"enum": [
"kind"
]
}
]
}
},
{
"type": "object",
"properties": {
"kind": {
"type": "string",
"enum": [
"get"
]
},
"zoneId": {
"type": "string",
"pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|[fF]{8}-[fF]{4}-[fF]{4}-[fF]{4}-[fF]{12})$",
"format": "uuid"
}
},
"required": [
"kind",
"zoneId"
],
"patternProperties": {
"^(?!(?:kind|zoneId)$)[\\s\\S]*$": false
},
"additionalProperties": true,
"propertyNames": {
"type": "string",
"enum": [
"kind",
"zoneId"
]
}
},
{
"type": "object",
"properties": {
"kind": {
"type": "string",
"enum": [
"plan"
]
},
"request": {
"type": "object",
"properties": {
"hostname": {
"$ref": "#/$defs/DomainName"
},
"records": {
"type": "array",
"items": {
"type": "object",
"properties": {
"name": {
"type": "string",
"minLength": 1,
"maxLength": 253
},
"type": {
"type": "string",
"enum": [
"A",
"AAAA",
"CNAME",
"MX",
"TXT",
"CAA",
"SRV",
"NS",
"PTR",
"NAPTR",
"DS"
]
},
"ttl": {
"type": "integer"
},
"values": {
"type": "array",
"items": {
"type": "string",
"maxLength": 65536
},
"maxItems": 500
},
"aliasTarget": {
"type": "object",
"properties": {
"dnsName": {
"type": "string",
"minLength": 1,
"maxLength": 253
},
"hostedZoneId": {
"type": "string",
"minLength": 1,
"maxLength": 128
},
"evaluateTargetHealth": {
"type": "boolean"
}
},
"required": [
"dnsName",
"hostedZoneId",
"evaluateTargetHealth"
],
"patternProperties": {
"^(?!(?:dnsName|hostedZoneId|evaluateTargetHealth)$)[\\s\\S]*$": false
},
"additionalProperties": true,
"propertyNames": {
"type": "string",
"enum": [
"dnsName",
"hostedZoneId",
"evaluateTargetHealth"
]
}
}
},
"required": [
"name",
"type",
"ttl",
"values"
],
"patternProperties": {
"^(?!(?:name|type|ttl|values|aliasTarget)$)[\\s\\S]*$": false
},
"additionalProperties": true,
"propertyNames": {
"type": "string",
"enum": [
"name",
"type",
"ttl",
"values",
"aliasTarget"
]
}
},
"maxItems": 500
},
"sourceNameservers": {
"type": "array",
"items": {
"type": "string",
"minLength": 1,
"maxLength": 253
},
"maxItems": 32
},
"completeExportAcknowledged": {
"type": "boolean"
}
},
"required": [
"hostname",
"records",
"sourceNameservers",
"completeExportAcknowledged"
],
"patternProperties": {
"^(?!(?:hostname|records|sourceNameservers|completeExportAcknowledged)$)[\\s\\S]*$": false
},
"additionalProperties": true,
"propertyNames": {
"type": "string",
"enum": [
"hostname",
"records",
"sourceNameservers",
"completeExportAcknowledged"
]
}
}
},
"required": [
"kind",
"request"
],
"patternProperties": {
"^(?!(?:kind|request)$)[\\s\\S]*$": false
},
"additionalProperties": true,
"propertyNames": {
"type": "string",
"enum": [
"kind",
"request"
]
}
},
{
"type": "object",
"properties": {
"kind": {
"type": "string",
"enum": [
"replan"
]
},
"zoneId": {
"type": "string",
"pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|[fF]{8}-[fF]{4}-[fF]{4}-[fF]{4}-[fF]{12})$",
"format": "uuid"
},
"request": {
"type": "object",
"properties": {
"expectedRevision": {
"type": "integer",
"minimum": 0,
"maximum": 9007199254740991
},
"records": {
"type": "array",
"items": {
"type": "object",
"properties": {
"name": {
"type": "string",
"minLength": 1,
"maxLength": 253
},
"type": {
"type": "string",
"enum": [
"A",
"AAAA",
"CNAME",
"MX",
"TXT",
"CAA",
"SRV",
"NS",
"PTR",
"NAPTR",
"DS"
]
},
"ttl": {
"type": "integer"
},
"values": {
"type": "array",
"items": {
"type": "string",
"maxLength": 65536
},
"maxItems": 500
},
"aliasTarget": {
"type": "object",
"properties": {
"dnsName": {
"type": "string",
"minLength": 1,
"maxLength": 253
},
"hostedZoneId": {
"type": "string",
"minLength": 1,
"maxLength": 128
},
"evaluateTargetHealth": {
"type": "boolean"
}
},
"required": [
"dnsName",
"hostedZoneId",
"evaluateTargetHealth"
],
"patternProperties": {
"^(?!(?:dnsName|hostedZoneId|evaluateTargetHealth)$)[\\s\\S]*$": false
},
"additionalProperties": true,
"propertyNames": {
"type": "string",
"enum": [
"dnsName",
"hostedZoneId",
"evaluateTargetHealth"
]
}
}
},
"required": [
"name",
"type",
"ttl",
"values"
],
"patternProperties": {
"^(?!(?:name|type|ttl|values|aliasTarget)$)[\\s\\S]*$": false
},
"additionalProperties": true,
"propertyNames": {
"type": "string",
"enum": [
"name",
"type",
"ttl",
"values",
"aliasTarget"
]
}
},
"maxItems": 500
},
"sourceNameservers": {
"type": "array",
"items": {
"type": "string",
"minLength": 1,
"maxLength": 253
},
"maxItems": 32
},
"completeExportAcknowledged": {
"type": "boolean"
}
},
"required": [
"expectedRevision",
"records",
"sourceNameservers",
"completeExportAcknowledged"
],
"patternProperties": {
"^(?!(?:expectedRevision|records|sourceNameservers|completeExportAcknowledged)$)[\\s\\S]*$": false
},
"additionalProperties": true,
"propertyNames": {
"type": "string",
"enum": [
"expectedRevision",
"records",
"sourceNameservers",
"completeExportAcknowledged"
]
}
}
},
"required": [
"kind",
"zoneId",
"request"
],
"patternProperties": {
"^(?!(?:kind|zoneId|request)$)[\\s\\S]*$": false
},
"additionalProperties": true,
"propertyNames": {
"type": "string",
"enum": [
"kind",
"zoneId",
"request"
]
}
},
{
"type": "object",
"properties": {
"kind": {
"type": "string",
"enum": [
"provision"
]
},
"zoneId": {
"type": "string",
"pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|[fF]{8}-[fF]{4}-[fF]{4}-[fF]{4}-[fF]{12})$",
"format": "uuid"
},
"request": {
"type": "object",
"properties": {
"expectedRevision": {
"type": "integer",
"minimum": 0,
"maximum": 9007199254740991
},
"planHash": {
"type": "string",
"minLength": 1,
"maxLength": 256
},
"paidHostingAcknowledged": {
"type": "boolean"
},
"dnssecMigrationAcknowledged": {
"type": "boolean"
},
"providerCoordinationAcknowledged": {
"type": "boolean"
}
},
"required": [
"expectedRevision",
"planHash",
"paidHostingAcknowledged",
"dnssecMigrationAcknowledged",
"providerCoordinationAcknowledged"
],
"patternProperties": {
"^(?!(?:expectedRevision|planHash|paidHostingAcknowledged|dnssecMigrationAcknowledged|providerCoordinationAcknowledged)$)[\\s\\S]*$": false
},
"additionalProperties": true,
"propertyNames": {
"type": "string",
"enum": [
"expectedRevision",
"planHash",
"paidHostingAcknowledged",
"dnssecMigrationAcknowledged",
"providerCoordinationAcknowledged"
]
}
}
},
"required": [
"kind",
"zoneId",
"request"
],
"patternProperties": {
"^(?!(?:kind|zoneId|request)$)[\\s\\S]*$": false
},
"additionalProperties": true,
"propertyNames": {
"type": "string",
"enum": [
"kind",
"zoneId",
"request"
]
}
},
{
"type": "object",
"properties": {
"kind": {
"type": "string",
"enum": [
"update"
]
},
"zoneId": {
"type": "string",
"pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|[fF]{8}-[fF]{4}-[fF]{4}-[fF]{4}-[fF]{12})$",
"format": "uuid"
},
"request": {
"type": "object",
"properties": {
"expectedRevision": {
"type": "integer",
"minimum": 0,
"maximum": 9007199254740991
},
"expectedRecordsHash": {
"type": "string",
"minLength": 1,
"maxLength": 256
},
"records": {
"type": "array",
"items": {
"type": "object",
"properties": {
"name": {
"type": "string",
"minLength": 1,
"maxLength": 253
},
"type": {
"type": "string",
"enum": [
"A",
"AAAA",
"CNAME",
"MX",
"TXT",
"CAA",
"SRV",
"NS",
"PTR",
"NAPTR",
"DS"
]
},
"ttl": {
"type": "integer"
},
"values": {
"type": "array",
"items": {
"type": "string",
"maxLength": 65536
},
"maxItems": 500
},
"aliasTarget": {
"type": "object",
"properties": {
"dnsName": {
"type": "string",
"minLength": 1,
"maxLength": 253
},
"hostedZoneId": {
"type": "string",
"minLength": 1,
"maxLength": 128
},
"evaluateTargetHealth": {
"type": "boolean"
}
},
"required": [
"dnsName",
"hostedZoneId",
"evaluateTargetHealth"
],
"patternProperties": {
"^(?!(?:dnsName|hostedZoneId|evaluateTargetHealth)$)[\\s\\S]*$": false
},
"additionalProperties": true,
"propertyNames": {
"type": "string",
"enum": [
"dnsName",
"hostedZoneId",
"evaluateTargetHealth"
]
}
}
},
"required": [
"name",
"type",
"ttl",
"values"
],
"patternProperties": {
"^(?!(?:name|type|ttl|values|aliasTarget)$)[\\s\\S]*$": false
},
"additionalProperties": true,
"propertyNames": {
"type": "string",
"enum": [
"name",
"type",
"ttl",
"values",
"aliasTarget"
]
}
},
"maxItems": 500
}
},
"required": [
"expectedRevision",
"expectedRecordsHash",
"records"
],
"patternProperties": {
"^(?!(?:expectedRevision|expectedRecordsHash|records)$)[\\s\\S]*$": false
},
"additionalProperties": true,
"propertyNames": {
"type": "string",
"enum": [
"expectedRevision",
"expectedRecordsHash",
"records"
]
}
}
},
"required": [
"kind",
"zoneId",
"request"
],
"patternProperties": {
"^(?!(?:kind|zoneId|request)$)[\\s\\S]*$": false
},
"additionalProperties": true,
"propertyNames": {
"type": "string",
"enum": [
"kind",
"zoneId",
"request"
]
}
},
{
"type": "object",
"properties": {
"kind": {
"type": "string",
"enum": [
"check"
]
},
"zoneId": {
"type": "string",
"pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|[fF]{8}-[fF]{4}-[fF]{4}-[fF]{4}-[fF]{12})$",
"format": "uuid"
},
"request": {
"type": "object",
"properties": {
"expectedRevision": {
"type": "integer",
"minimum": 0,
"maximum": 9007199254740991
}
},
"required": [
"expectedRevision"
],
"patternProperties": {
"^(?!(?:expectedRevision)$)[\\s\\S]*$": false
},
"additionalProperties": true,
"propertyNames": {
"anyOf": [
{
"type": "string",
"enum": [
"expectedRevision"
]
}
]
}
}
},
"required": [
"kind",
"zoneId",
"request"
],
"patternProperties": {
"^(?!(?:kind|zoneId|request)$)[\\s\\S]*$": false
},
"additionalProperties": true,
"propertyNames": {
"type": "string",
"enum": [
"kind",
"zoneId",
"request"
]
}
}
]
}
},
"required": [
"workspaceId",
"action"
],
"patternProperties": {
"^(?!(?:workspaceId|action)$)[\\s\\S]*$": false
},
"additionalProperties": true,
"propertyNames": {
"type": "string",
"enum": [
"workspaceId",
"action"
]
},
"$defs": {
"DomainName": {
"type": "string",
"minLength": 1,
"maxLength": 253,
"pattern": "^(?=.{1,253}$)(?:[a-zA-Z0-9](?:[a-zA-Z0-9-]{0,61}[a-zA-Z0-9])?\\.)+[a-zA-Z]{2,63}$"
}
}
}
```
### Output schema (structuredContent)
```json
{
"$defs": {
"DomainName": {
"type": "string",
"minLength": 1,
"maxLength": 253,
"pattern": "^(?=.{1,253}$)(?:[a-zA-Z0-9](?:[a-zA-Z0-9-]{0,61}[a-zA-Z0-9])?\\.)+[a-zA-Z]{2,63}$"
}
},
"type": "object",
"anyOf": [
{
"allOf": [
{
"anyOf": [
{
"type": "object",
"properties": {
"zones": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "string",
"pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|[fF]{8}-[fF]{4}-[fF]{4}-[fF]{4}-[fF]{12})$",
"format": "uuid"
},
"hostname": {
"$ref": "#/$defs/DomainName"
},
"revision": {
"type": "integer",
"minimum": 0,
"maximum": 9007199254740991
},
"recordsHash": {
"type": "string"
},
"status": {
"type": "string",
"enum": [
"ownership_pending",
"provisioning",
"import_pending",
"ready_to_delegate",
"observed_matching",
"needs_attention"
]
},
"ownershipRecord": {
"type": "object",
"properties": {
"name": {
"type": "string"
},
"type": {
"type": "string",
"enum": [
"TXT"
]
},
"value": {
"type": "string"
},
"removable": {
"type": "boolean"
}
},
"required": [
"name",
"type",
"value",
"removable"
],
"patternProperties": {
"^(?!(?:name|type|value|removable)$)[\\s\\S]*$": false
},
"additionalProperties": true,
"propertyNames": {
"type": "string",
"enum": [
"name",
"type",
"value",
"removable"
]
}
},
"records": {
"type": "array",
"items": {
"type": "object",
"properties": {
"name": {
"type": "string",
"minLength": 1,
"maxLength": 253
},
"type": {
"type": "string",
"enum": [
"A",
"AAAA",
"CNAME",
"MX",
"TXT",
"CAA",
"SRV",
"NS",
"PTR",
"NAPTR",
"DS"
]
},
"ttl": {
"type": "integer"
},
"values": {
"type": "array",
"items": {
"type": "string",
"maxLength": 65536
},
"maxItems": 500
},
"aliasTarget": {
"type": "object",
"properties": {
"dnsName": {
"type": "string",
"minLength": 1,
"maxLength": 253
},
"hostedZoneId": {
"type": "string",
"minLength": 1,
"maxLength": 128
},
"evaluateTargetHealth": {
"type": "boolean"
}
},
"required": [
"dnsName",
"hostedZoneId",
"evaluateTargetHealth"
],
"patternProperties": {
"^(?!(?:dnsName|hostedZoneId|evaluateTargetHealth)$)[\\s\\S]*$": false
},
"additionalProperties": true,
"propertyNames": {
"type": "string",
"enum": [
"dnsName",
"hostedZoneId",
"evaluateTargetHealth"
]
}
}
},
"required": [
"name",
"type",
"ttl",
"values"
],
"patternProperties": {
"^(?!(?:name|type|ttl|values|aliasTarget)$)[\\s\\S]*$": false
},
"additionalProperties": true,
"propertyNames": {
"type": "string",
"enum": [
"name",
"type",
"ttl",
"values",
"aliasTarget"
]
}
},
"maxItems": 500
},
"pendingRecords": {
"anyOf": [
{
"type": "array",
"items": {
"type": "object",
"properties": {
"name": {
"type": "string",
"minLength": 1,
"maxLength": 253
},
"type": {
"type": "string",
"enum": [
"A",
"AAAA",
"CNAME",
"MX",
"TXT",
"CAA",
"SRV",
"NS",
"PTR",
"NAPTR",
"DS"
]
},
"ttl": {
"type": "integer"
},
"values": {
"type": "array",
"items": {
"type": "string",
"maxLength": 65536
},
"maxItems": 500
},
"aliasTarget": {
"type": "object",
"properties": {
"dnsName": {
"type": "string",
"minLength": 1,
"maxLength": 253
},
"hostedZoneId": {
"type": "string",
"minLength": 1,
"maxLength": 128
},
"evaluateTargetHealth": {
"type": "boolean"
}
},
"required": [
"dnsName",
"hostedZoneId",
"evaluateTargetHealth"
],
"patternProperties": {
"^(?!(?:dnsName|hostedZoneId|evaluateTargetHealth)$)[\\s\\S]*$": false
},
"additionalProperties": true,
"propertyNames": {
"type": "string",
"enum": [
"dnsName",
"hostedZoneId",
"evaluateTargetHealth"
]
}
}
},
"required": [
"name",
"type",
"ttl",
"values"
],
"patternProperties": {
"^(?!(?:name|type|ttl|values|aliasTarget)$)[\\s\\S]*$": false
},
"additionalProperties": true,
"propertyNames": {
"type": "string",
"enum": [
"name",
"type",
"ttl",
"values",
"aliasTarget"
]
}
},
"maxItems": 500
},
{
"type": "null"
}
]
},
"sourceNameservers": {
"type": "array",
"items": {
"type": "string",
"minLength": 1,
"maxLength": 253
},
"maxItems": 32
},
"nameservers": {
"type": "array",
"items": {
"type": "string",
"minLength": 1,
"maxLength": 253
},
"maxItems": 32
},
"hostedZoneId": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"changeId": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"planHash": {
"type": "string"
},
"verifiedAt": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"checkedAt": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"reason": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"observedNameservers": {
"type": "array",
"items": {
"type": "string",
"minLength": 1,
"maxLength": 253
},
"maxItems": 32
},
"delegationEvidence": {
"type": "string",
"enum": [
"recursive_dns_only"
]
},
"hostingMonthlyUsd": {
"anyOf": [
{
"type": "number"
},
{
"type": "string",
"enum": [
"Infinity",
"-Infinity",
"NaN"
]
}
]
}
},
"required": [
"id",
"hostname",
"revision",
"recordsHash",
"status",
"ownershipRecord",
"records",
"pendingRecords",
"sourceNameservers",
"nameservers",
"hostedZoneId",
"changeId",
"planHash",
"verifiedAt",
"checkedAt",
"reason",
"observedNameservers",
"delegationEvidence",
"hostingMonthlyUsd"
],
"patternProperties": {
"^(?!(?:id|hostname|revision|recordsHash|status|ownershipRecord|records|pendingRecords|sourceNameservers|nameservers|hostedZoneId|changeId|planHash|verifiedAt|checkedAt|reason|observedNameservers|delegationEvidence|hostingMonthlyUsd)$)[\\s\\S]*$": false
},
"additionalProperties": true,
"propertyNames": {
"type": "string",
"enum": [
"id",
"hostname",
"revision",
"recordsHash",
"status",
"ownershipRecord",
"records",
"pendingRecords",
"sourceNameservers",
"nameservers",
"hostedZoneId",
"changeId",
"planHash",
"verifiedAt",
"checkedAt",
"reason",
"observedNameservers",
"delegationEvidence",
"hostingMonthlyUsd"
]
}
},
"maxItems": 50
}
},
"required": [
"zones"
],
"patternProperties": {
"^(?!(?:zones)$)[\\s\\S]*$": false
},
"additionalProperties": true,
"propertyNames": {
"anyOf": [
{
"type": "string",
"enum": [
"zones"
]
}
]
}
},
{
"type": "object",
"properties": {
"id": {
"type": "string",
"pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|[fF]{8}-[fF]{4}-[fF]{4}-[fF]{4}-[fF]{12})$",
"format": "uuid"
},
"hostname": {
"$ref": "#/$defs/DomainName"
},
"revision": {
"type": "integer",
"minimum": 0,
"maximum": 9007199254740991
},
"recordsHash": {
"type": "string"
},
"status": {
"type": "string",
"enum": [
"ownership_pending",
"provisioning",
"import_pending",
"ready_to_delegate",
"observed_matching",
"needs_attention"
]
},
"ownershipRecord": {
"type": "object",
"properties": {
"name": {
"type": "string"
},
"type": {
"type": "string",
"enum": [
"TXT"
]
},
"value": {
"type": "string"
},
"removable": {
"type": "boolean"
}
},
"required": [
"name",
"type",
"value",
"removable"
],
"patternProperties": {
"^(?!(?:name|type|value|removable)$)[\\s\\S]*$": false
},
"additionalProperties": true,
"propertyNames": {
"type": "string",
"enum": [
"name",
"type",
"value",
"removable"
]
}
},
"records": {
"type": "array",
"items": {
"type": "object",
"properties": {
"name": {
"type": "string",
"minLength": 1,
"maxLength": 253
},
"type": {
"type": "string",
"enum": [
"A",
"AAAA",
"CNAME",
"MX",
"TXT",
"CAA",
"SRV",
"NS",
"PTR",
"NAPTR",
"DS"
]
},
"ttl": {
"type": "integer"
},
"values": {
"type": "array",
"items": {
"type": "string",
"maxLength": 65536
},
"maxItems": 500
},
"aliasTarget": {
"type": "object",
"properties": {
"dnsName": {
"type": "string",
"minLength": 1,
"maxLength": 253
},
"hostedZoneId": {
"type": "string",
"minLength": 1,
"maxLength": 128
},
"evaluateTargetHealth": {
"type": "boolean"
}
},
"required": [
"dnsName",
"hostedZoneId",
"evaluateTargetHealth"
],
"patternProperties": {
"^(?!(?:dnsName|hostedZoneId|evaluateTargetHealth)$)[\\s\\S]*$": false
},
"additionalProperties": true,
"propertyNames": {
"type": "string",
"enum": [
"dnsName",
"hostedZoneId",
"evaluateTargetHealth"
]
}
}
},
"required": [
"name",
"type",
"ttl",
"values"
],
"patternProperties": {
"^(?!(?:name|type|ttl|values|aliasTarget)$)[\\s\\S]*$": false
},
"additionalProperties": true,
"propertyNames": {
"type": "string",
"enum": [
"name",
"type",
"ttl",
"values",
"aliasTarget"
]
}
},
"maxItems": 500
},
"pendingRecords": {
"anyOf": [
{
"type": "array",
"items": {
"type": "object",
"properties": {
"name": {
"type": "string",
"minLength": 1,
"maxLength": 253
},
"type": {
"type": "string",
"enum": [
"A",
"AAAA",
"CNAME",
"MX",
"TXT",
"CAA",
"SRV",
"NS",
"PTR",
"NAPTR",
"DS"
]
},
"ttl": {
"type": "integer"
},
"values": {
"type": "array",
"items": {
"type": "string",
"maxLength": 65536
},
"maxItems": 500
},
"aliasTarget": {
"type": "object",
"properties": {
"dnsName": {
"type": "string",
"minLength": 1,
"maxLength": 253
},
"hostedZoneId": {
"type": "string",
"minLength": 1,
"maxLength": 128
},
"evaluateTargetHealth": {
"type": "boolean"
}
},
"required": [
"dnsName",
"hostedZoneId",
"evaluateTargetHealth"
],
"patternProperties": {
"^(?!(?:dnsName|hostedZoneId|evaluateTargetHealth)$)[\\s\\S]*$": false
},
"additionalProperties": true,
"propertyNames": {
"type": "string",
"enum": [
"dnsName",
"hostedZoneId",
"evaluateTargetHealth"
]
}
}
},
"required": [
"name",
"type",
"ttl",
"values"
],
"patternProperties": {
"^(?!(?:name|type|ttl|values|aliasTarget)$)[\\s\\S]*$": false
},
"additionalProperties": true,
"propertyNames": {
"type": "string",
"enum": [
"name",
"type",
"ttl",
"values",
"aliasTarget"
]
}
},
"maxItems": 500
},
{
"type": "null"
}
]
},
"sourceNameservers": {
"type": "array",
"items": {
"type": "string",
"minLength": 1,
"maxLength": 253
},
"maxItems": 32
},
"nameservers": {
"type": "array",
"items": {
"type": "string",
"minLength": 1,
"maxLength": 253
},
"maxItems": 32
},
"hostedZoneId": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"changeId": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"planHash": {
"type": "string"
},
"verifiedAt": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"checkedAt": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"reason": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"observedNameservers": {
"type": "array",
"items": {
"type": "string",
"minLength": 1,
"maxLength": 253
},
"maxItems": 32
},
"delegationEvidence": {
"type": "string",
"enum": [
"recursive_dns_only"
]
},
"hostingMonthlyUsd": {
"anyOf": [
{
"type": "number"
},
{
"type": "string",
"enum": [
"Infinity",
"-Infinity",
"NaN"
]
}
]
}
},
"required": [
"id",
"hostname",
"revision",
"recordsHash",
"status",
"ownershipRecord",
"records",
"pendingRecords",
"sourceNameservers",
"nameservers",
"hostedZoneId",
"changeId",
"planHash",
"verifiedAt",
"checkedAt",
"reason",
"observedNameservers",
"delegationEvidence",
"hostingMonthlyUsd"
],
"patternProperties": {
"^(?!(?:id|hostname|revision|recordsHash|status|ownershipRecord|records|pendingRecords|sourceNameservers|nameservers|hostedZoneId|changeId|planHash|verifiedAt|checkedAt|reason|observedNameservers|delegationEvidence|hostingMonthlyUsd)$)[\\s\\S]*$": false
},
"additionalProperties": true,
"propertyNames": {
"type": "string",
"enum": [
"id",
"hostname",
"revision",
"recordsHash",
"status",
"ownershipRecord",
"records",
"pendingRecords",
"sourceNameservers",
"nameservers",
"hostedZoneId",
"changeId",
"planHash",
"verifiedAt",
"checkedAt",
"reason",
"observedNameservers",
"delegationEvidence",
"hostingMonthlyUsd"
]
}
}
]
},
{
"type": "object"
}
]
},
{
"type": "object",
"properties": {
"data": {
"allOf": [
{
"anyOf": [
{
"type": "object",
"properties": {
"zones": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "string",
"pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|[fF]{8}-[fF]{4}-[fF]{4}-[fF]{4}-[fF]{12})$",
"format": "uuid"
},
"hostname": {
"$ref": "#/$defs/DomainName"
},
"revision": {
"type": "integer",
"minimum": 0,
"maximum": 9007199254740991
},
"recordsHash": {
"type": "string"
},
"status": {
"type": "string",
"enum": [
"ownership_pending",
"provisioning",
"import_pending",
"ready_to_delegate",
"observed_matching",
"needs_attention"
]
},
"ownershipRecord": {
"type": "object",
"properties": {
"name": {
"type": "string"
},
"type": {
"type": "string",
"enum": [
"TXT"
]
},
"value": {
"type": "string"
},
"removable": {
"type": "boolean"
}
},
"required": [
"name",
"type",
"value",
"removable"
],
"patternProperties": {
"^(?!(?:name|type|value|removable)$)[\\s\\S]*$": false
},
"additionalProperties": true,
"propertyNames": {
"type": "string",
"enum": [
"name",
"type",
"value",
"removable"
]
}
},
"records": {
"type": "array",
"items": {
"type": "object",
"properties": {
"name": {
"type": "string",
"minLength": 1,
"maxLength": 253
},
"type": {
"type": "string",
"enum": [
"A",
"AAAA",
"CNAME",
"MX",
"TXT",
"CAA",
"SRV",
"NS",
"PTR",
"NAPTR",
"DS"
]
},
"ttl": {
"type": "integer"
},
"values": {
"type": "array",
"items": {
"type": "string",
"maxLength": 65536
},
"maxItems": 500
},
"aliasTarget": {
"type": "object",
"properties": {
"dnsName": {
"type": "string",
"minLength": 1,
"maxLength": 253
},
"hostedZoneId": {
"type": "string",
"minLength": 1,
"maxLength": 128
},
"evaluateTargetHealth": {
"type": "boolean"
}
},
"required": [
"dnsName",
"hostedZoneId",
"evaluateTargetHealth"
],
"patternProperties": {
"^(?!(?:dnsName|hostedZoneId|evaluateTargetHealth)$)[\\s\\S]*$": false
},
"additionalProperties": true,
"propertyNames": {
"type": "string",
"enum": [
"dnsName",
"hostedZoneId",
"evaluateTargetHealth"
]
}
}
},
"required": [
"name",
"type",
"ttl",
"values"
],
"patternProperties": {
"^(?!(?:name|type|ttl|values|aliasTarget)$)[\\s\\S]*$": false
},
"additionalProperties": true,
"propertyNames": {
"type": "string",
"enum": [
"name",
"type",
"ttl",
"values",
"aliasTarget"
]
}
},
"maxItems": 500
},
"pendingRecords": {
"anyOf": [
{
"type": "array",
"items": {
"type": "object",
"properties": {
"name": {
"type": "string",
"minLength": 1,
"maxLength": 253
},
"type": {
"type": "string",
"enum": [
"A",
"AAAA",
"CNAME",
"MX",
"TXT",
"CAA",
"SRV",
"NS",
"PTR",
"NAPTR",
"DS"
]
},
"ttl": {
"type": "integer"
},
"values": {
"type": "array",
"items": {
"type": "string",
"maxLength": 65536
},
"maxItems": 500
},
"aliasTarget": {
"type": "object",
"properties": {
"dnsName": {
"type": "string",
"minLength": 1,
"maxLength": 253
},
"hostedZoneId": {
"type": "string",
"minLength": 1,
"maxLength": 128
},
"evaluateTargetHealth": {
"type": "boolean"
}
},
"required": [
"dnsName",
"hostedZoneId",
"evaluateTargetHealth"
],
"patternProperties": {
"^(?!(?:dnsName|hostedZoneId|evaluateTargetHealth)$)[\\s\\S]*$": false
},
"additionalProperties": true,
"propertyNames": {
"type": "string",
"enum": [
"dnsName",
"hostedZoneId",
"evaluateTargetHealth"
]
}
}
},
"required": [
"name",
"type",
"ttl",
"values"
],
"patternProperties": {
"^(?!(?:name|type|ttl|values|aliasTarget)$)[\\s\\S]*$": false
},
"additionalProperties": true,
"propertyNames": {
"type": "string",
"enum": [
"name",
"type",
"ttl",
"values",
"aliasTarget"
]
}
},
"maxItems": 500
},
{
"type": "null"
}
]
},
"sourceNameservers": {
"type": "array",
"items": {
"type": "string",
"minLength": 1,
"maxLength": 253
},
"maxItems": 32
},
"nameservers": {
"type": "array",
"items": {
"type": "string",
"minLength": 1,
"maxLength": 253
},
"maxItems": 32
},
"hostedZoneId": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"changeId": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"planHash": {
"type": "string"
},
"verifiedAt": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"checkedAt": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"reason": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"observedNameservers": {
"type": "array",
"items": {
"type": "string",
"minLength": 1,
"maxLength": 253
},
"maxItems": 32
},
"delegationEvidence": {
"type": "string",
"enum": [
"recursive_dns_only"
]
},
"hostingMonthlyUsd": {
"anyOf": [
{
"type": "number"
},
{
"type": "string",
"enum": [
"Infinity",
"-Infinity",
"NaN"
]
}
]
}
},
"required": [
"id",
"hostname",
"revision",
"recordsHash",
"status",
"ownershipRecord",
"records",
"pendingRecords",
"sourceNameservers",
"nameservers",
"hostedZoneId",
"changeId",
"planHash",
"verifiedAt",
"checkedAt",
"reason",
"observedNameservers",
"delegationEvidence",
"hostingMonthlyUsd"
],
"patternProperties": {
"^(?!(?:id|hostname|revision|recordsHash|status|ownershipRecord|records|pendingRecords|sourceNameservers|nameservers|hostedZoneId|changeId|planHash|verifiedAt|checkedAt|reason|observedNameservers|delegationEvidence|hostingMonthlyUsd)$)[\\s\\S]*$": false
},
"additionalProperties": true,
"propertyNames": {
"type": "string",
"enum": [
"id",
"hostname",
"revision",
"recordsHash",
"status",
"ownershipRecord",
"records",
"pendingRecords",
"sourceNameservers",
"nameservers",
"hostedZoneId",
"changeId",
"planHash",
"verifiedAt",
"checkedAt",
"reason",
"observedNameservers",
"delegationEvidence",
"hostingMonthlyUsd"
]
}
},
"maxItems": 50
}
},
"required": [
"zones"
],
"patternProperties": {
"^(?!(?:zones)$)[\\s\\S]*$": false
},
"additionalProperties": true,
"propertyNames": {
"anyOf": [
{
"type": "string",
"enum": [
"zones"
]
}
]
}
},
{
"type": "object",
"properties": {
"id": {
"type": "string",
"pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|[fF]{8}-[fF]{4}-[fF]{4}-[fF]{4}-[fF]{12})$",
"format": "uuid"
},
"hostname": {
"$ref": "#/$defs/DomainName"
},
"revision": {
"type": "integer",
"minimum": 0,
"maximum": 9007199254740991
},
"recordsHash": {
"type": "string"
},
"status": {
"type": "string",
"enum": [
"ownership_pending",
"provisioning",
"import_pending",
"ready_to_delegate",
"observed_matching",
"needs_attention"
]
},
"ownershipRecord": {
"type": "object",
"properties": {
"name": {
"type": "string"
},
"type": {
"type": "string",
"enum": [
"TXT"
]
},
"value": {
"type": "string"
},
"removable": {
"type": "boolean"
}
},
"required": [
"name",
"type",
"value",
"removable"
],
"patternProperties": {
"^(?!(?:name|type|value|removable)$)[\\s\\S]*$": false
},
"additionalProperties": true,
"propertyNames": {
"type": "string",
"enum": [
"name",
"type",
"value",
"removable"
]
}
},
"records": {
"type": "array",
"items": {
"type": "object",
"properties": {
"name": {
"type": "string",
"minLength": 1,
"maxLength": 253
},
"type": {
"type": "string",
"enum": [
"A",
"AAAA",
"CNAME",
"MX",
"TXT",
"CAA",
"SRV",
"NS",
"PTR",
"NAPTR",
"DS"
]
},
"ttl": {
"type": "integer"
},
"values": {
"type": "array",
"items": {
"type": "string",
"maxLength": 65536
},
"maxItems": 500
},
"aliasTarget": {
"type": "object",
"properties": {
"dnsName": {
"type": "string",
"minLength": 1,
"maxLength": 253
},
"hostedZoneId": {
"type": "string",
"minLength": 1,
"maxLength": 128
},
"evaluateTargetHealth": {
"type": "boolean"
}
},
"required": [
"dnsName",
"hostedZoneId",
"evaluateTargetHealth"
],
"patternProperties": {
"^(?!(?:dnsName|hostedZoneId|evaluateTargetHealth)$)[\\s\\S]*$": false
},
"additionalProperties": true,
"propertyNames": {
"type": "string",
"enum": [
"dnsName",
"hostedZoneId",
"evaluateTargetHealth"
]
}
}
},
"required": [
"name",
"type",
"ttl",
"values"
],
"patternProperties": {
"^(?!(?:name|type|ttl|values|aliasTarget)$)[\\s\\S]*$": false
},
"additionalProperties": true,
"propertyNames": {
"type": "string",
"enum": [
"name",
"type",
"ttl",
"values",
"aliasTarget"
]
}
},
"maxItems": 500
},
"pendingRecords": {
"anyOf": [
{
"type": "array",
"items": {
"type": "object",
"properties": {
"name": {
"type": "string",
"minLength": 1,
"maxLength": 253
},
"type": {
"type": "string",
"enum": [
"A",
"AAAA",
"CNAME",
"MX",
"TXT",
"CAA",
"SRV",
"NS",
"PTR",
"NAPTR",
"DS"
]
},
"ttl": {
"type": "integer"
},
"values": {
"type": "array",
"items": {
"type": "string",
"maxLength": 65536
},
"maxItems": 500
},
"aliasTarget": {
"type": "object",
"properties": {
"dnsName": {
"type": "string",
"minLength": 1,
"maxLength": 253
},
"hostedZoneId": {
"type": "string",
"minLength": 1,
"maxLength": 128
},
"evaluateTargetHealth": {
"type": "boolean"
}
},
"required": [
"dnsName",
"hostedZoneId",
"evaluateTargetHealth"
],
"patternProperties": {
"^(?!(?:dnsName|hostedZoneId|evaluateTargetHealth)$)[\\s\\S]*$": false
},
"additionalProperties": true,
"propertyNames": {
"type": "string",
"enum": [
"dnsName",
"hostedZoneId",
"evaluateTargetHealth"
]
}
}
},
"required": [
"name",
"type",
"ttl",
"values"
],
"patternProperties": {
"^(?!(?:name|type|ttl|values|aliasTarget)$)[\\s\\S]*$": false
},
"additionalProperties": true,
"propertyNames": {
"type": "string",
"enum": [
"name",
"type",
"ttl",
"values",
"aliasTarget"
]
}
},
"maxItems": 500
},
{
"type": "null"
}
]
},
"sourceNameservers": {
"type": "array",
"items": {
"type": "string",
"minLength": 1,
"maxLength": 253
},
"maxItems": 32
},
"nameservers": {
"type": "array",
"items": {
"type": "string",
"minLength": 1,
"maxLength": 253
},
"maxItems": 32
},
"hostedZoneId": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"changeId": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"planHash": {
"type": "string"
},
"verifiedAt": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"checkedAt": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"reason": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"observedNameservers": {
"type": "array",
"items": {
"type": "string",
"minLength": 1,
"maxLength": 253
},
"maxItems": 32
},
"delegationEvidence": {
"type": "string",
"enum": [
"recursive_dns_only"
]
},
"hostingMonthlyUsd": {
"anyOf": [
{
"type": "number"
},
{
"type": "string",
"enum": [
"Infinity",
"-Infinity",
"NaN"
]
}
]
}
},
"required": [
"id",
"hostname",
"revision",
"recordsHash",
"status",
"ownershipRecord",
"records",
"pendingRecords",
"sourceNameservers",
"nameservers",
"hostedZoneId",
"changeId",
"planHash",
"verifiedAt",
"checkedAt",
"reason",
"observedNameservers",
"delegationEvidence",
"hostingMonthlyUsd"
],
"patternProperties": {
"^(?!(?:id|hostname|revision|recordsHash|status|ownershipRecord|records|pendingRecords|sourceNameservers|nameservers|hostedZoneId|changeId|planHash|verifiedAt|checkedAt|reason|observedNameservers|delegationEvidence|hostingMonthlyUsd)$)[\\s\\S]*$": false
},
"additionalProperties": true,
"propertyNames": {
"type": "string",
"enum": [
"id",
"hostname",
"revision",
"recordsHash",
"status",
"ownershipRecord",
"records",
"pendingRecords",
"sourceNameservers",
"nameservers",
"hostedZoneId",
"changeId",
"planHash",
"verifiedAt",
"checkedAt",
"reason",
"observedNameservers",
"delegationEvidence",
"hostingMonthlyUsd"
]
}
}
]
},
{
"not": {
"type": "object"
}
}
]
}
},
"required": [
"data"
],
"additionalProperties": false
}
]
}
```
### Underlying API operations
- `domainDns.list`: `GET /v1/workspaces/:workspaceId/domains/dns-hosting`
- `domainDns.get`: `GET /v1/workspaces/:workspaceId/domains/dns-hosting/:zoneId`
- `domainDns.plan`: `POST /v1/workspaces/:workspaceId/domains/dns-hosting`
- `domainDns.replan`: `POST /v1/workspaces/:workspaceId/domains/dns-hosting/:zoneId/plan`
- `domainDns.provision`: `POST /v1/workspaces/:workspaceId/domains/dns-hosting/:zoneId/provision`
- `domainDns.update`: `POST /v1/workspaces/:workspaceId/domains/dns-hosting/:zoneId/records`
- `domainDns.check`: `POST /v1/workspaces/:workspaceId/domains/dns-hosting/:zoneId/check`