Skip to content

Commit 87399c2

Browse files
committed
adds missing API shield fields
1 parent f5290a6 commit 87399c2

File tree

1 file changed

+20
-0
lines changed

1 file changed

+20
-0
lines changed

src/content/docs/ruleset-engine/rules-language/fields/dynamic-fields.mdx

Lines changed: 20 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -14,6 +14,8 @@ Dynamic fields represent computed or derived values, typically related to threat
1414

1515
:::note
1616

17+
- Access to `cf.api_gateway.auth_id_present` requires a Cloudflare Enterprise plan with [API Shield](/api-shield/) enabled.
18+
1719
- Access to `cf.bot_management.*` fields requires a Cloudflare Enterprise plan with [Bot Management](/bots/plans/bm-subscription/) enabled.
1820

1921
- Access to `cf.waf.content_scan.*` fields requires a Cloudflare Enterprise plan with [malicious uploads detection](/waf/detections/malicious-uploads/) enabled.
@@ -26,6 +28,24 @@ Dynamic fields represent computed or derived values, typically related to threat
2628

2729
The Cloudflare Rules language supports these dynamic fields.
2830

31+
## `cf.api_gateway.auth_id_present`
32+
33+
`cf.api_gateway.auth_id_present` <Type text='Boolean' />
34+
35+
Indicates whether or not the request contained an API session authentication token, as defined by API Shield's saved [session identifiers](/api-shield/get-started/#session-identifiers/).
36+
37+
## `cf.api_gateway.request_violates_schema`
38+
39+
`cf.api_gateway.request_violates_schema` <Type text='Boolean' />
40+
41+
Indicates whether the request violated the [schema assigned](/api-shield/security/schema-validation/) to the respective saved endpoint.
42+
43+
## `cf.api_gateway.fallthrough_detected`
44+
45+
`cf.api_gateway.fallthrough_detected` <Type text='Boolean' />
46+
47+
Indicates whether the request matched a saved endpoint in [Endpoint Management](/api-shield/management-and-monitoring/).
48+
2949
## `cf.bot_management.verified_bot`
3050

3151
`cf.bot_management.verified_bot` <Type text='Boolean' />

0 commit comments

Comments
 (0)