delete_dynamic_dns

delete_dynamic_dns

Preview deletion of a Dynamic DNS config.

This tool does not delete on its own. It returns a preview envelope with a token; call confirm_destructive_action(token) to commit the delete. Tokens expire after 5 minutes.

Side effects:

• None until confirm_destructive_action runs against the token.
• On confirm: removes the DDNS config. The provider stops receiving updates from the gateway; the external hostname goes stale once its TTL lapses.
• dry_run=True returns the legacy would_delete envelope with no token: purely informational, no commit step possible.

Example

delete_dynamic_dns(ddns_id="65f...")

Parameters

Parameter	Type	Required	Default	Description
ddns_id	string	yes	—	The _id from list_dynamic_dns.
controller	string	no	”default”	Name of the UniFi controller to target. Defaults to "default".
dry_run	boolean	no	false	True skips token generation and returns the legacy {"dry_run": true, ...} envelope. False (default) generates a preview token that must be confirmed.