Create DDNS token
create_ddns_tokenCreate a scoped DNS updater token for one hostname or pattern in a verified zone, enabling DDNS A/AAAA or ACME TXT DNS-01 updates; optionally restrict source IPs.
Instructions
Create a narrow DNS updater token for one hostname/pattern inside a verified customer-owned zone. purpose=ddns allows A/AAAA updater use; purpose=acme allows TXT only under _acme-challenge for DNS-01. Set allow_from to restrict updater source IPs/CIDRs. The full token is returned once. Requires dns:write when using an API key.
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| purpose | No | Token purpose. ddns allows A/AAAA updates; acme allows TXT-only DNS-01 updates under _acme-challenge. Defaults to ddns. | |
| zone_id | Yes | DNS zone ID | |
| allow_from | No | Optional comma-separated source IP/CIDR allowlist for updater requests, e.g. 203.0.113.10,2001:db8::/64. | |
| expires_at | No | Optional expiry date (YYYY-MM-DD or datetime). | |
| name_pattern | Yes | Allowed hostname or wildcard pattern. For purpose=acme this must be _acme-challenge.<zone> or _acme-challenge.<host>.<zone>. | |
| record_types | No | Allowed record types. For purpose=ddns: A, AAAA, or A,AAAA. For purpose=acme: TXT only. | |
| rate_limit_per_minute | No | Per-token update limit, 1-120/min. Defaults to 10. |