---
title: "Patch Firewall Policy"
method: PATCH
path: "/v1/sites/{siteId}/firewall/policies/{firewallPolicyId}"
tags: ["Firewall"]
---

# Patch Firewall Policy

`PATCH /v1/sites/{siteId}/firewall/policies/{firewallPolicyId}`

## Request

- Base URL: `https://api.ui.com/v1/connector/consoles/942A6FF664C0000000000964970E0000000009E710560000000068A9873F:9999999999/proxy/network/integration`
- URL: `https://api.ui.com/v1/connector/consoles/942A6FF664C0000000000964970E0000000009E710560000000068A9873F:9999999999/proxy/network/integration/v1/sites/{siteId}/firewall/policies/{firewallPolicyId}`
- Auth: none declared
- TypeScript: <https://skmtc.dev/ubiquiti/apis/unifi-network-api/docs/v1/sites/:siteId/firewall/policies/:firewallPolicyId/patch.ts> (a function with typed inputs; its response is checked against the schema)

Patch an existing firewall policy on a site.

## Path parameters

- `firewallPolicyId` string, uuid, required
- `siteId` string, uuid, required

## Request body

- PatchFirewallPolicy
  - `loggingEnabled` boolean

## Response `200`

OK

- FirewallPolicy
  - `id` string, uuid, required
  - `enabled` boolean, required
  - `name` string, required
  - `description` string
  - `index` integer, required
  - `action` FirewallPolicyAction, required: Defines action for matched traffic.
    - `type` string, required
  - `source` FirewallPolicySource, required
    - `zoneId` string, uuid, required: ID of the firewall zone from which the matched traffic originates.
    - `trafficFilter` FirewallPolicySourceTrafficFilter
      - `type` string, required
  - `destination` FirewallPolicyDestination, required
    - `zoneId` string, uuid, required: ID of the firewall zone to which the matched traffic is destined.
    - `trafficFilter` FirewallPolicyDestinationTrafficFilter
      - `type` string, required
  - `ipProtocolScope` FirewallPolicyIPProtocolScope, required: Defines rules for matching by IP version and protocol.
    - `ipVersion` string, required
  - `connectionStateFilter` string[]: Match on firewall connection state. If null, matches all connection states.
  - `ipsecFilter` 'MATCH_ENCRYPTED' | 'MATCH_NOT_ENCRYPTED': Match on traffic encrypted, or not encrypted by IPsec. If null, matches all traffic.
  - `loggingEnabled` boolean, required: Generate syslog entries when traffic is matched. Such entries are sent to a remote syslog server.
  - `schedule` FirewallSchedule: Defines date and time when the entity is active. If null, the entity is always active.
    - `mode` string, required
  - `metadata` UserOrSystemDefinedOrDerivedEntityMetadata, required
    - `origin` string, required

---

[API](https://skmtc.dev/ubiquiti/apis/unifi-network-api.md) - [All operations](https://skmtc.dev/ubiquiti/apis/unifi-network-api/llms.txt) - [OpenAPI document](https://skmtc.dev/ubiquiti/apis/unifi-network-api/revisions/822d5af98ce5?raw)