update_port_forward
update_port_forward
Section titled “update_port_forward”Patch fields on an existing port-forward rule.
Side effects:
- Modifies the named forward in place. Only fields supplied in
updateschange. - Takes effect immediately on the next inbound packet.
- Mutates controller state. Use dry_run=True to preview the change without applying.
Example
Section titled “Example”update_port_forward(forward_id="65f...", updates={"enabled": False})Parameters
Section titled “Parameters”| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
forward_id | string | yes | — | The _id from list_port_forwards. |
updates | object | yes | — | Partial record. Common keys: enabled, fwd_port, dst_port, proto, src, fwd, name. |
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. |