Firewall

List Firewall Zones

Retrieve a list of all firewall zones on a site.

<details> <summary>Filterable properties (click to expand)</summary>

Name	Type	Allowed functions
id	UUID	eq ne in notIn
name	STRING	eq ne in notIn like
metadata.origin	STRING	eq ne in notIn
metadata.configurable	BOOLEAN	eq ne isNull isNotNull

</details>

get/v1/sites/{siteId}/firewall/zones

Request

Base URL
https://api.ui.com/v1/connector/consoles/942A6FF664C0000000000964970E0000000009E710560000000068A9873F:9999999999/proxy/network/integration
Auth
none declared
TypeScript
https://skmtc.dev/ubiquiti/apis/unifi-network-api/docs/v1/sites/:siteId/firewall/zones/get.ts
A function with typed inputs. Its response is checked against the schema.

Path parameters

siteIdstring uuid required

Query parameters

offsetinteger

limitinteger

filterstring

Response

offsetinteger required

limitinteger required

countinteger required

totalCountinteger required

Example response

{
  "limit": 25,
  "count": 10,
  "totalCount": 1000,
  "data": [
    {
      "id": "ffcdb32c-6278-4364-8947-df4f77118df8",
      "name": "Hotspot|My custom zone",
      "networkIds": [
        "dfb21062-8ea0-4dca-b1d8-1eb3da00e58b"
      ]
    }
  ]
}

Changes

No recorded changes to this operation across all 1 revision of this API.