API reference · WAF
Save a zone's WAF settings against the revision read
PUT/v1/orgs/{org}/zones/{zone}/waf
- Permission
waf.settings.manage- Request body
- at most 1,048,576 bytes
- Audit log
waf.settings.update- Operation
waf.zones.replace
Parameters
| Name | In | Type | Required | Notes |
|---|
org | path | string | yes | for example "org_01h455vb4pex5vsknk084sn02q" |
zone | path | string | yes | for example "zone_01h455vb4pex5vsknk084sn02q" |
Idempotency-Key | header | string | no | One key per intended mutation. A retry with the key replays the recorded response instead of executing again; the key with another request answers 422 idempotency_key_reused. For example "01h455vb4pex5vsknk084sn02q" |
x-obhut-management-assignment | header | string | no | Select one staff assignment. Direct membership remains the default. Bound API tokens use their stored source and ignore this selector. For example "masg_01h455vb4pex5vsknk084sn02q" |
Request body
| Field | Type | Required | Notes |
|---|
revision | string or null | yes | |
vpatchMode | string | yes | one of "block", "log", "off" |
exceptions | array of object | yes | 0 to 100 items |
exceptions[].id | string | no | for example "wafx_01h455vb4pex5vsknk084sn02q" |
exceptions[].name | string | yes | 1 to 100 characters |
exceptions[].condition | string | yes | |
exceptions[].languageVersion | 1 | yes | |
exceptions[].rules | array of integer | yes | 1 to 32 items |
Response 200
| Field | Type | Required | Notes |
|---|
zoneId | string | yes | for example "zone_01h455vb4pex5vsknk084sn02q" |
revision | string or null | yes | |
vpatchMode | string | yes | one of "block", "log", "off" |
exceptions | array of object | yes | |
exceptions[].id | string | yes | for example "wafx_01h455vb4pex5vsknk084sn02q" |
exceptions[].name | string | yes | |
exceptions[].condition | string | yes | |
exceptions[].languageVersion | integer | yes | more than 0 |
exceptions[].rules | array of integer | yes | |
updatedAt | string (date-time) or null | yes | |