The effective configuration of a name is the site the edge nodes receive for it: the zone's settings with the name's own values merged in, its origin, the edge rules and rate limiting rules that reach it and its redirect rules. It comes from the same code that builds the nodes' configuration, so what you see is what is served.
Domain → Names → Effective configuration next to the name. Values marked Own value are customized for the name; the rest is inherited from the domain.
openwaf-cloud ctl zones effective example.com api.example.comcurl -sS "https://dash.openwaf.dev/v1/orgs/$ORG/zones/example.com/hosts/api.example.com/effective" \
-H "Authorization: Bearer $OPENWAF_TOKEN"effective_config with {"zone": "example.com", "host": "api.example.com"}.
Any role that can read the zone can read it. The answer carries the zone version in ETag.
The answer
200 OK
{
"zone_id": "…",
"host": "api.example.com",
"proxied": true,
"items": [
{"pool": "", "variant": false, "site": {"domain": "api.example.com", "mode": "active", "waf_level": "high", "…": "…"}}
]
}| Field | Meaning |
|---|---|
proxied | Whether the name has a proxied record. With false, site is a preview of what the name would get, without an upstream. |
items | One entry per group of edge nodes that serves the zone. Most zones have a single entry. |
site | The complete site: WAF settings, upstream_url, rules (IP, country, WAF exceptions, rate limit rules), rate_rules (only enabled ones that apply to the name), redirects, cache, AI Crawl Control… |
A name that isn't the zone or below it gets 404 host_not_in_zone.