list_firewall_policies
Retrieve firewall policies for a UniFi site by host and site, with optional filters and pagination controls to get the complete list or a specific page.
Instructions
List firewall policies for a site.
host: console name, ID, or composite ID (MAC:numericId format). site: site name or ID.
By default every page is drained and the complete policy list is returned as
{data, totalCount}. Pass offset/limit to fetch a single page manually (the
API's totalCount is surfaced so you can advance). filter: optional Network
Integration API filter expression, forwarded unchanged as the upstream filter
query parameter for server-side filtering (e.g. name.like('*guest*'),
metadata.origin.eq('USER_DEFINED')); omitted entirely when unset. A capped drain
returns the policies gathered so far with incomplete=true rather than truncating
silently.
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| host | Yes | ||
| site | Yes | ||
| limit | No | ||
| filter | No | ||
| offset | No |
Output Schema
| Name | Required | Description | Default |
|---|---|---|---|
No arguments | |||