delete_content_filter
delete_content_filter
Section titled “delete_content_filter”Preview deletion of a content-filtering profile.
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_actionruns against the token. - On confirm: removes the profile. The clients and networks in its scope stop being filtered by it and fall back to whatever other profile (or none) applies.
dry_run=Truereturns the legacywould_deleteenvelope with no token: purely informational, no commit step possible.
Example
Section titled “Example”delete_content_filter(filter_id="65f...")Parameters
Section titled “Parameters”| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
filter_id | string | yes | — | The _id from list_content_filters. |
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. |