Skip to content
mcp-unifi

update_dynamic_dns

update_dynamic_dns

Section titled “update_dynamic_dns”

Patch fields on an existing Dynamic DNS config.

Side effects:

  • Modifies the named DDNS config in place. Only fields supplied in updates change; everything else is preserved.
  • Takes effect immediately: changing host_name or service repoints the next update; toggling enabled starts or stops updates.
  • Mutates controller state. Use dry_run=True to preview the change without applying.

Example

Section titled “Example”
update_dynamic_dns(ddns_id="65f...", updates={"enabled": False})

Parameters

Section titled “Parameters”
Parameter Type Required Default Description
ddns_id string yes — The _id from list_dynamic_dns.
updates object yes — Partial DDNS record. Common keys: service, host_name, login, x_password (new password/token), server, interface, enabled.
controller string no “default” Name of the UniFi controller to target. Defaults to "default".
dry_run boolean no false Preview the change without applying it. Returns the predicted change set (x_password redacted if present).