delete_honeypot

delete_honeypot

Preview deletion of a honeypot entry.

v0.7.0 destructive pattern: this tool does not delete on its own. It returns a preview envelope with a token; call confirm_destructive_action(token) to commit. Tokens expire after 5 minutes.

Side effects:

• None until confirm_destructive_action runs against the token.
• On confirm: rewrites the ips setting’s honeypot list with the entry removed and sets honeypot_enabled based on whether the resulting list is empty.
• dry_run=True returns the legacy would_delete envelope with no token (informational only).

Example

delete_honeypot(id="65f...:10.0.50.2")

Parameters

Parameter	Type	Required	Default	Description
id	string	yes	—	The synthesised honeypot id from list_honeypots in {network_id}:{ip} form.
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.