Docs

API reference · WAF

Read a zone's WAF settings

GET/v1/orgs/{org}/zones/{zone}/waf
Permission
waf.settings.read
Operation
waf.zones.get

Parameters

NameInTypeRequiredNotes
orgpathstringyesfor example "org_01h455vb4pex5vsknk084sn02q"
zonepathstringyesfor example "zone_01h455vb4pex5vsknk084sn02q"
x-obhut-management-assignmentheaderstringnoSelect one staff assignment. Direct membership remains the default. Bound API tokens use their stored source and ignore this selector. For example "masg_01h455vb4pex5vsknk084sn02q"

Response 200

FieldTypeRequiredNotes
zoneIdstringyesfor example "zone_01h455vb4pex5vsknk084sn02q"
revisionstring or nullyes
vpatchModestringyesone of "block", "log", "off"
exceptionsarray of objectyes
exceptions[].idstringyesfor example "wafx_01h455vb4pex5vsknk084sn02q"
exceptions[].namestringyes
exceptions[].conditionstringyes
exceptions[].languageVersionintegeryesmore than 0
exceptions[].rulesarray of integeryes
updatedAtstring (date-time) or nullyes