Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

[Ruleset Engine] Adds missing API Shield fields #18989

Merged
merged 3 commits into from
Jan 7, 2025
Merged

[Ruleset Engine] Adds missing API Shield fields #18989

Changes from 1 commit
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
87399c2
adds missing API shield fields
crwaters16 Jan 2, 2025
4ab2e2d
Update src/content/docs/ruleset-engine/rules-language/fields/dynamic-…
crwaters16 Jan 7, 2025
4c40ff8
Update src/content/docs/ruleset-engine/rules-language/fields/dynamic-…
crwaters16 Jan 7, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
20 changes: 20 additions & 0 deletions src/content/docs/ruleset-engine/rules-language/fields/dynamic-fields.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -14,6 +14,8 @@ Dynamic fields represent computed or derived values, typically related to threat

:::note

- Access to `cf.api_gateway.auth_id_present` requires a Cloudflare Enterprise plan with [API Shield](/api-shield/) enabled.

- Access to `cf.bot_management.*` fields requires a Cloudflare Enterprise plan with [Bot Management](/bots/plans/bm-subscription/) enabled.

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

The Cloudflare Rules language supports these dynamic fields.

## `cf.api_gateway.auth_id_present`

`cf.api_gateway.auth_id_present` <Type text='Boolean' />

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/).
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

We usually leave out "or not" (implied?) for boolean fields.

crwaters16 marked this conversation as resolved.
Show resolved Hide resolved

## `cf.api_gateway.request_violates_schema`

`cf.api_gateway.request_violates_schema` <Type text='Boolean' />

Indicates whether the request violated the [schema assigned](/api-shield/security/schema-validation/) to the respective saved endpoint.
crwaters16 marked this conversation as resolved.
Show resolved Hide resolved

## `cf.api_gateway.fallthrough_detected`

`cf.api_gateway.fallthrough_detected` <Type text='Boolean' />

Indicates whether the request matched a saved endpoint in [Endpoint Management](/api-shield/management-and-monitoring/).

## `cf.bot_management.verified_bot`

`cf.bot_management.verified_bot` <Type text='Boolean' />
Expand Down
Loading