Skip to content

Commit b02fe8c

Browse files
authored
Ruleset Engine: fix links to specific fields and functions (#16112)
1 parent eae6328 commit b02fe8c

File tree

44 files changed

+115
-115
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

44 files changed

+115
-115
lines changed

src/content/changelogs/rules.yaml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -16,7 +16,7 @@ entries:
1616
description: |-
1717
Wildcards are now supported across our Ruleset Engine-based products, including Single Redirects, Cache Rules, Transform Rules, WAF, Waiting Room, and more:
1818
* You can now use the `wildcard` and `strict wildcard` operators with any string field in the Ruleset Engine, such as full URI, host, headers, cookies, user-agent, and country. For more details, refer to [Operators](/ruleset-engine/rules-language/operators/) and [Wildcard matching](/ruleset-engine/rules-language/operators/#wildcard-matching).
19-
* In [Single Redirects](/rules/url-forwarding/single-redirects/), the `wildcard_replace()` function allows you to use segments matched by the `wildcard` and `strict wildcard` operators in redirect URL targets. For more information, refer to [Functions](/ruleset-engine/rules-language/functions/#function-wildcard_replace).
19+
* In [Single Redirects](/rules/url-forwarding/single-redirects/), the `wildcard_replace()` function allows you to use segments matched by the `wildcard` and `strict wildcard` operators in redirect URL targets. For more information, refer to [Functions](/ruleset-engine/rules-language/functions/#wildcard_replace).
2020
2121
- publish_date: '2024-07-01'
2222
title: Cloudflare Snippets now available to all paid customers

src/content/docs/bots/troubleshooting.mdx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -90,7 +90,7 @@ Cloudflare has built an allowlist of good, automated bots, e.g. Google Search En
9090

9191
This allowlist is large based on reverse DNS verification, meaning that the IPs we allow really match the requesting service. In addition to this, Cloudflare uses multiple validation methods including ASN blocks and public lists. If none of these validation types are available for a customer, we use internal Cloudflare data and machine learning to identify legitimate IP addresses from good bots.
9292

93-
To allow traffic from good bots, use the [Verified Bot](/ruleset-engine/rules-language/fields/#field-cf-bot_management-verified_bot) field in your WAF custom rule.
93+
To allow traffic from good bots, use the [Verified Bot](/ruleset-engine/rules-language/fields/dynamic-fields/#cfbot_managementverified_bot) field in your WAF custom rule.
9494

9595

9696
***

src/content/docs/cloudflare-for-platforms/cloudflare-for-saas/domain-support/custom-metadata.mdx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -84,7 +84,7 @@ addEventListener('fetch', event => {
8484

8585
## Accessing custom metadata in a rule expression
8686

87-
Use the [`cf.hostname.metadata`](/ruleset-engine/rules-language/fields/#field-cf-hostname-metadata) field to access the metadata object in rule expressions. To obtain the different values from the JSON object, use the [`lookup_json_string`](/ruleset-engine/rules-language/functions/#function-lookup_json_string) function.
87+
Use the [`cf.hostname.metadata`](/ruleset-engine/rules-language/fields/dynamic-fields/#cfhostnamemetadata) field to access the metadata object in rule expressions. To obtain the different values from the JSON object, use the [`lookup_json_string`](/ruleset-engine/rules-language/functions/#lookup_json_string) function.
8888

8989
The following rule expression defines that there will be a rule match if the `security_tag` value in custom metadata contains the value `low`:
9090

src/content/docs/fundamentals/basic-tasks/trace-request/how-to.mdx

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -35,9 +35,9 @@ import { GlossaryTooltip } from "~/components"
3535
* **Protocol** (HTTP protocol version)
3636
* **Request headers**
3737
* **Cookies**
38-
* **Geolocation** (request source [country](/ruleset-engine/rules-language/fields/#field-ip-src-country), [region](/ruleset-engine/rules-language/fields/#field-ip-src-region_code), and [city](/ruleset-engine/rules-language/fields/#field-ip-src-city))
38+
* **Geolocation** (request source [country](/ruleset-engine/rules-language/fields/standard-fields/#ipsrccountry), [region](/ruleset-engine/rules-language/fields/standard-fields/#ipsrcregion), and [city](/ruleset-engine/rules-language/fields/standard-fields/#ipsrccity))
3939
* [**Bot score**](/bots/concepts/bot-score/)
40-
* <GlossaryTooltip term="threat score" link="/ruleset-engine/rules-language/fields/#field-cf-threat_score">**Threat score**</GlossaryTooltip>
40+
* <GlossaryTooltip term="threat score" link="/ruleset-engine/rules-language/fields/dynamic-fields/#cfthreat_score">**Threat score**</GlossaryTooltip>
4141
* **Request body** (for `POST`, `PUT`, and `PATCH` requests)
4242
* **Skip challenge** (skips a Cloudflare-issued [challenge](/waf/reference/cloudflare-challenges/), if any, allowing the trace to continue)
4343

src/content/docs/fundamentals/reference/http-request-headers.mdx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -142,7 +142,7 @@ The intended purpose of this header is to provide a means for recipients (for ex
142142
:::note
143143

144144

145-
When configuring WAF custom rules, do not match on this header. These rules are applied before Cloudflare adds the `CF-Worker` header. Instead, use the [`cf.worker.upstream_zone`](/ruleset-engine/rules-language/fields/#field-cf-worker-upstream_zone) dynamic field, which contains the same value and exists for the same purpose.
145+
When configuring WAF custom rules, do not match on this header. These rules are applied before Cloudflare adds the `CF-Worker` header. Instead, use the [`cf.worker.upstream_zone`](/ruleset-engine/rules-language/fields/dynamic-fields/#cfworkerupstream_zone) dynamic field, which contains the same value and exists for the same purpose.
146146

147147

148148
:::

src/content/docs/load-balancing/additional-options/load-balancing-rules/reference.mdx

Lines changed: 13 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -91,7 +91,7 @@ Many of these fields are referenced from the [Rules language documentation](/rul
9191
</thead>
9292
<tbody>
9393
<tr id="field-http-cookie">
94-
<td valign="top"><a href="/ruleset-engine/rules-language/fields/#field-http-cookie"><code>http.cookie</code></a><br />`String`</td>
94+
<td valign="top"><a href="/ruleset-engine/rules-language/fields/standard-fields/#httpcookie"><code>http.cookie</code></a><br />`String`</td>
9595
<td>(<a href="/load-balancing/additional-options/load-balancing-rules/expressions/#expression-editor">Manual entry only</a>)</td>
9696
<td>
9797
<p>Represents the entire cookie as a string.</p>
@@ -102,7 +102,7 @@ Many of these fields are referenced from the [Rules language documentation](/rul
102102
</td>
103103
</tr>
104104
<tr id="field-http-host">
105-
<td valign="top"><a href="/ruleset-engine/rules-language/fields/#field-http-host"><code>http.host</code></a><br />`String`</td>
105+
<td valign="top"><a href="/ruleset-engine/rules-language/fields/standard-fields/#httphost"><code>http.host</code></a><br />`String`</td>
106106
<td>(<a href="/load-balancing/additional-options/load-balancing-rules/expressions/#expression-editor">Manual entry only</a>)</td>
107107
<td>
108108
<p>Represents the hostname used in the full request URI.</p>
@@ -113,7 +113,7 @@ Many of these fields are referenced from the [Rules language documentation](/rul
113113
</td>
114114
</tr>
115115
<tr id="field-http-referer">
116-
<td valign="top"><a href="/ruleset-engine/rules-language/fields/#field-http-referer"><code>http.referer</code></a><br />`String`</td>
116+
<td valign="top"><a href="/ruleset-engine/rules-language/fields/standard-fields/#httpreferer"><code>http.referer</code></a><br />`String`</td>
117117
<td>(<a href="/load-balancing/additional-options/load-balancing-rules/expressions/#expression-editor">Manual entry only</a>)</td>
118118
<td>
119119
<p>Represents the HTTP Referer request header, which contains the address of the web page that linked to the currently requested page.</p>
@@ -124,7 +124,7 @@ Many of these fields are referenced from the [Rules language documentation](/rul
124124
</td>
125125
</tr>
126126
<tr id="field-http-request-headers">
127-
<td valign="top"><a href="/ruleset-engine/rules-language/fields/#field-http-request-headers"><code>http.request.headers</code></a><br />`Map<Array<String>>`</td>
127+
<td valign="top"><a href="/ruleset-engine/rules-language/fields/http-request-header/"><code>http.request.headers</code></a><br />`Map<Array<String>>`</td>
128128
<td><code>Header</code></td>
129129
<td>
130130
<p>Represents HTTP request headers as a Map (or associative array).</p>
@@ -146,7 +146,7 @@ Many of these fields are referenced from the [Rules language documentation](/rul
146146
</td>
147147
</tr>
148148
<tr id="field-http-request-method">
149-
<td valign="top"><a href="/ruleset-engine/rules-language/fields/#field-http-request-method"><code>http.request.method</code></a><br />`String`</td>
149+
<td valign="top"><a href="/ruleset-engine/rules-language/fields/standard-fields/#httprequestmethod"><code>http.request.method</code></a><br />`String`</td>
150150
<td><code>Request Method</code></td>
151151
<td>
152152
<p>Represents the HTTP method, returned as a string of uppercase characters.</p>
@@ -157,7 +157,7 @@ Many of these fields are referenced from the [Rules language documentation](/rul
157157
</td>
158158
</tr>
159159
<tr id="field-http-request-timestamp-sec">
160-
<td valign="top"><a href="/ruleset-engine/rules-language/fields/#field-http-request-timestamp-sec"><code>http.request.timestamp.sec</code></a><br />`Integer`</td>
160+
<td valign="top"><a href="/ruleset-engine/rules-language/fields/standard-fields/#httprequesttimestampsec"><code>http.request.timestamp.sec</code></a><br />`Integer`</td>
161161
<td><code>Timestamp</code></td>
162162
<td>
163163
<p>Represents the timestamp when Cloudflare received the request, expressed as Unix time in seconds. This value is 10 digits long.</p>
@@ -168,7 +168,7 @@ Many of these fields are referenced from the [Rules language documentation](/rul
168168
</td>
169169
</tr>
170170
<tr id="field-http-request-uri">
171-
<td valign="top"><a href="/ruleset-engine/rules-language/fields/#field-http-request-uri"><code>http.request.uri</code></a><br />`String`</td>
171+
<td valign="top"><a href="/ruleset-engine/rules-language/fields/standard-fields/#httprequesturi"><code>http.request.uri</code></a><br />`String`</td>
172172
<td><code>URI</code></td>
173173
<td>
174174
<p>Represents the URI path and query string of the request.</p>
@@ -179,7 +179,7 @@ Many of these fields are referenced from the [Rules language documentation](/rul
179179
</td>
180180
</tr>
181181
<tr id="field-http-request-uri-args">
182-
<td valign="top"><a href="/ruleset-engine/rules-language/fields/#field-http-request-uri-args"><code>http.request.uri.args</code></a><br />`Map<Array<String>>`</td>
182+
<td valign="top"><a href="/ruleset-engine/rules-language/fields/uri/"><code>http.request.uri.args</code></a><br />`Map<Array<String>>`</td>
183183
<td>(<a href="/load-balancing/additional-options/load-balancing-rules/expressions/#expression-editor">Manual entry only</a>)</td>
184184
<td>
185185
<p>Represents the HTTP URI arguments associated with a request as a Map (associative array).</p>
@@ -202,7 +202,7 @@ Many of these fields are referenced from the [Rules language documentation](/rul
202202
</td>
203203
</tr>
204204
<tr id="field-http-request-uri-args-names">
205-
<td valign="top"><a href="/ruleset-engine/rules-language/fields/#field-http-request-uri-args-names"><code>http.request.uri.args.names</code></a><br />`Array<String>`</td>
205+
<td valign="top"><a href="/ruleset-engine/rules-language/fields/uri/#httprequesturiargsnames"><code>http.request.uri.args.names</code></a><br />`Array<String>`</td>
206206
<td>(<a href="/load-balancing/additional-options/load-balancing-rules/expressions/#expression-editor">Manual entry only</a>)</td>
207207
<td>
208208
<p>Represents the names of the arguments in the HTTP URI query string. The names are not pre-processed and retain the original case used in the request.</p>
@@ -222,7 +222,7 @@ Many of these fields are referenced from the [Rules language documentation](/rul
222222
</td>
223223
</tr>
224224
<tr id="field-http-request-uri-args-values">
225-
<td valign="top"><a href="/ruleset-engine/rules-language/fields/#field-http-request-uri-args-values"><code>http.request.uri.args.values</code></a><br />`Array<String>`</td>
225+
<td valign="top"><a href="/ruleset-engine/rules-language/fields/uri/#httprequesturiargsvalues"><code>http.request.uri.args.values</code></a><br />`Array<String>`</td>
226226
<td>(<a href="/load-balancing/additional-options/load-balancing-rules/expressions/#expression-editor">Manual entry only</a>)</td>
227227
<td>
228228
<p>Represents the values of arguments in the HTTP URI query string. The values are not pre-processed and retain the original case used in the request. They are in the same order as in the request.</p>
@@ -242,7 +242,7 @@ Many of these fields are referenced from the [Rules language documentation](/rul
242242
</td>
243243
</tr>
244244
<tr id="field-http-request-uri-path">
245-
<td valign="top"><a href="/ruleset-engine/rules-language/fields/#field-http-request-uri-path"><code>http.request.uri.path</code></a><br />`String`</td>
245+
<td valign="top"><a href="/ruleset-engine/rules-language/fields/standard-fields/#httprequesturipath"><code>http.request.uri.path</code></a><br />`String`</td>
246246
<td><code>URI Path</code></td>
247247
<td>
248248
<p>Represents the URI path of the request.</p>
@@ -253,7 +253,7 @@ Many of these fields are referenced from the [Rules language documentation](/rul
253253
</td>
254254
</tr>
255255
<tr id="field-http-request-uri-query">
256-
<td valign="top"><a href="/ruleset-engine/rules-language/fields/#field-http-request-uri-query"><code>http.request.uri.query</code></a><br />`String`</td>
256+
<td valign="top"><a href="/ruleset-engine/rules-language/fields/standard-fields/#httprequesturiquery"><code>http.request.uri.query</code></a><br />`String`</td>
257257
<td><code>URI Query</code></td>
258258
<td>
259259
<p>Represents the entire query string, without the <code class="InlineCode">?</code> delimiter.</p>
@@ -264,7 +264,7 @@ Many of these fields are referenced from the [Rules language documentation](/rul
264264
</td>
265265
</tr>
266266
<tr id="field-http-request-version">
267-
<td valign="top"><a href="/ruleset-engine/rules-language/fields/#field-http-request-version"><code>http.request.version</code></a><br />`String`</td>
267+
<td valign="top"><a href="/ruleset-engine/rules-language/fields/standard-fields/#httprequestversion"><code>http.request.version</code></a><br />`String`</td>
268268
<td><code>HTTP Version</code></td>
269269
<td>
270270
<p>Represents the version of the HTTP protocol used. Use this field when you require different checks for different versions.</p>

src/content/docs/magic-firewall/about/protocol-validation-rules.mdx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -6,6 +6,6 @@ pcx_content_type: concept
66

77
Magic Firewall supports [Session Initiation Protocol (SIP)](https://datatracker.ietf.org/doc/html/rfc2543) to inspect traffic validity and enforce a positive security model.
88

9-
You can use the `sip` field when creating a rule to determine if packets are valid SIP Layer 7 (L7) protocol. Refer to [Magic Firewall fields](/ruleset-engine/rules-language/fields/#magic-firewall-fields), specifically the `sip` field, for more information on this topic.
9+
You can use the `sip` field when creating a rule to determine if packets are valid SIP Layer 7 (L7) protocol. Refer to [Magic Firewall fields](/ruleset-engine/rules-language/fields/magic-firewall/), specifically the `sip` field, for more information on this topic.
1010

1111
Contact your account manager if you need Magic Firewall to support additional protocols.

src/content/docs/magic-firewall/about/traffic-types.mdx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -10,4 +10,4 @@ Magic Firewall enables you to allow or block traffic on a variety of packet char
1010

1111
Magic Firewall supports layers three and four — network and transport — protocols such as TCP, UDP, and ICMP. Any type of layer three or four protocols can go through Magic Firewall and then be matched on those protocols.
1212

13-
To view the list of available fields, refer to [Magic Firewall fields](/ruleset-engine/rules-language/fields/#magic-firewall-fields).
13+
To view the list of available fields, refer to [Magic Firewall fields](/ruleset-engine/rules-language/fields/magic-firewall/).
Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
---
22
pcx_content_type: navigation
33
title: Magic Firewall fields
4-
external_link: /ruleset-engine/rules-language/fields/#magic-firewall-fields
4+
external_link: /ruleset-engine/rules-language/fields/magic-firewall/
55

66
---

src/content/docs/rules/compression-rules/index.mdx

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -39,9 +39,9 @@ The following fields are commonly used in expressions of compression rules:
3939

4040
| Field in [Expression Builder](/ruleset-engine/rules-language/expressions/edit-expressions/#expression-builder) | Field name |
4141
| -------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------- |
42-
| *Media Type* | [`http.response.content_type.media_type`](/ruleset-engine/rules-language/fields/#field-http-response-content_type-media_type) |
43-
| *File extension* | [`http.request.uri.path.extension`](/ruleset-engine/rules-language/fields/#field-http-request-uri-path-extension) |
44-
| N/A | [`raw.http.request.uri.path.extension`](/ruleset-engine/rules-language/fields/#field-raw-http-request-uri-path-extension) |
42+
| *Media Type* | [`http.response.content_type.media_type`](/ruleset-engine/rules-language/fields/http-request-response/#httpresponsecontent_typemedia_type) |
43+
| *File extension* | [`http.request.uri.path.extension`](/ruleset-engine/rules-language/fields/standard-fields/#httprequesturipathextension) |
44+
| N/A | [`raw.http.request.uri.path.extension`](/ruleset-engine/rules-language/fields/standard-fields/#rawhttprequesturipathextension) |
4545

4646

4747

0 commit comments

Comments
 (0)