Access Control (ACL Rules)

List ACL Rules

Retrieve a paginated list of all ACL rules on a site.

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

Name	Type	Allowed functions
type	STRING	eq ne in notIn
id	UUID	eq ne in notIn
enabled	BOOLEAN	eq ne
name	STRING	eq ne in notIn like
description	STRING	isNull isNotNull eq ne in notIn like
action	STRING	eq ne in notIn
index	INTEGER	eq ne gt ge lt le in notIn
protocolFilter	SET(STRING)	isNull isNotNull contains containsAny containsAll containsExactly
networkId	UUID	isNull isNotNull eq ne in notIn
enforcingDeviceFilter.deviceIds	SET(UUID)	isNull isNotNull contains containsAny containsAll containsExactly
metadata.origin	STRING	eq ne in notIn
sourceFilter.type	STRING	isNull isNotNull eq ne in notIn
sourceFilter.ipAddressesOrSubnets	SET(STRING)	contains containsAny containsAll containsExactly
sourceFilter.portFilter	SET(INTEGER)	isNull isNotNull contains containsAny containsAll containsExactly
sourceFilter.networkIds	SET(UUID)	contains containsAny containsAll containsExactly
sourceFilter.macAddresses	SET(STRING)	contains containsAny containsAll containsExactly
sourceFilter.prefixLength	INTEGER	isNull isNotNull eq ne gt ge lt le in notIn
destinationFilter.type	STRING	isNull isNotNull eq ne in notIn
destinationFilter.ipAddressesOrSubnets	SET(STRING)	contains containsAny containsAll containsExactly
destinationFilter.portFilter	SET(INTEGER)	isNull isNotNull contains containsAny containsAll containsExactly
destinationFilter.networkIds	SET(UUID)	contains containsAny containsAll containsExactly
destinationFilter.macAddresses	SET(STRING)	contains containsAny containsAll containsExactly
destinationFilter.prefixLength	INTEGER	isNull isNotNull eq ne gt ge lt le in notIn

</details>

get/v1/sites/{siteId}/acl-rules

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/acl-rules/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": [
    {
      "enabled": true,
      "action": "ALLOW|BLOCK"
    }
  ]
}

Changes

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