Apply DNS template
apply_dns_templateApply a backend-defined DNS template to a native forward zone, optionally previewing records before writes. Use overwrite=true to replace conflicting records after validation and quota checks.
Instructions
Apply a backend-defined DNS template to a native forward zone. The written records can change public DNS answers; overwrite=true replaces conflicting records. Records still pass the same API validation, quotas and conflict rules as manual record writes. Prefer preview=true first to show the user exactly which records a template would write before changing the zone. Requires dns:write when using an API key.
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| preview | No | true to dry-run the template and return the records it would write without changing the zone | |
| zone_id | Yes | DNS zone ID | |
| template | Yes | Template ID returned by list_dns_templates, e.g. web_service, null_mx, google_workspace, microsoft_365, mail_security, caa_letsencrypt | |
| overwrite | No | true to replace existing records that conflict with the template. Destructive: confirm the exact conflicts with the user first, ideally from a preview run. | |
| parameters | No | Template parameters, e.g. { ipv4, ipv6, www, mx_target, ttl } depending on the template |