Operators and grouping symbols
The Cloudflare Rules language supports comparison and logical operators:
- Comparison operators specify how values defined in an expression must relate to the actual HTTP request value for the expression to return
true
. - Logical operators combine two expressions to form a compound expression and use order of precedence to determine how an expression is evaluated.
Grouping symbols allow you to organize expressions, enforce precedence, and nest expressions.
Comparison operators return true
when a value from an HTTP request matches a value defined in an expression.
This is the general pattern for using comparison operators:
The Rules language supports these comparison operators:
Name | Operator Notation | Supported Data Types | ||||
---|---|---|---|---|---|---|
English | C-like | String | IP | Number | Example (operator in bold) | |
Equal | eq | == | ✅ | ✅ | ✅ | http.request.uri.path eq "/articles/2008/" |
Not equal | ne | != | ✅ | ✅ | ✅ | ip.src ne 203.0.113.0 |
Less than | lt | < | ✅ | ❌ | ✅ | cf.threat_score lt 10 |
Less than or equal | le | <= | ✅ | ❌ | ✅ | cf.threat_score le 20 |
Greater than | gt | > | ✅ | ❌ | ✅ | cf.threat_score gt 25 |
Greater than or equal | ge | >= | ✅ | ❌ | ✅ | cf.threat_score ge 60 |
Contains | contains | ✅ | ❌ | ❌ | http.request.uri.path contains "/articles/" | |
Wildcard1 (case-insensitive) | wildcard | ✅ | ❌ | ❌ | http.request.uri.path wildcard "/articles/*" | |
Strict wildcard1 (case-sensitive) | strict wildcard | ✅ | ❌ | ❌ | http.request.uri.path strict wildcard "/AdminTeam/*" | |
Matches regex2 | matches | ~ | ✅ | ❌ | ❌ | http.request.uri.path matches "^/articles/200[7-8]/$" |
Is in set of values / list3 | in | ✅ | ✅ | ✅ | ip.src in { 203.0.113.0 203.0.113.1 } ip.src.asnum in $<LIST> |
1 For more information, refer to Wildcard matching.
2 Access to the matches
operator requires a Cloudflare Business or Enterprise plan. For more information, refer to Regular expression matching.
3 Currently, not all Cloudflare products support lists in their expressions. For more information on lists, refer to Inline lists and Lists.
The Cloudflare dashboard may show the following additional operators, depending on the exact field and the type of rule:
-
starts with (corresponding to the
starts_with()
function): Returnstrue
when a string starts with a given substring, andfalse
otherwise. -
ends with (corresponding to the
ends_with()
function): Returnstrue
when a string ends with a given substring, andfalse
otherwise. -
is in list (corresponding to
<FIELD> in $<LIST_NAME>
): Returnstrue
when the field value is present in the specified list, andfalse
otherwise. For more information, refer to Use lists in expressions. -
is not in list (corresponding to
not <FIELD> in $<LIST_NAME>
): Returnstrue
when the field value is not present in the specified list, andfalse
otherwise. For more information, refer to Use lists in expressions.
String comparison in rule expressions is case-sensitive. To account for possible variations of string capitalization in an expression, you can use the lower()
function and compare the result with a lowercased string, like in the following example:
Wildcard matching is only supported with the wildcard
and strict wildcard
operators, and regular expression matching is only supported with the matches
operator.
The wildcard
operator performs a case-insensitive match between a field value and a literal string containing zero or more *
metacharacters. Each *
metacharacter represents zero or more characters. The strict wildcard
operator performs a similar match, but is case-sensitive.
When using the wildcard
/strict wildcard
operator, the entire field value must match the literal string with wildcards (the literal after the operator).
Example B
Example C
The matching algorithm used by the wildcard
operator is case-insensitive. To perform case-sensitive wildcard matching, use the strict wildcard
operator.
To enter a literal *
character in a literal string with wildcards you must escape it using \*
. Additionally, you must also escape \
using \\
. Two unescaped *
characters in a row (**
) in a wildcard literal string are considered invalid and cannot be used. If you need to perform character escaping, it is recommended that you use the raw string syntax to specify a literal string with wildcards.
Customers on Business and Enterprise plans have access to the matches
operator. Regular expression matching is performed using the Rust regular expression engine.
If you are using a regular expression, you can test it using a tool like Regular Expressions 101 ↗ or Rustexp ↗.
For more information on regular expressions, refer to String values and regular expressions.
Logical operators combine two or more expressions into a single compound expression. A compound expression has this general syntax:
Each logical operator has an order of precedence. The order of precedence (along with grouping symbols) determines the order in which Cloudflare evaluates logical operators in an expression. The not
operator ranks first in order of precedence.
Name | English Notation | C-like Notation | Example | Order of Precedence |
---|---|---|---|---|
Logical NOT | not | ! | not ( http.host eq "www.cloudflare.com" and ip.src in {203.0.113.0/24} ) | 1 |
Logical AND | and | && | http.host eq "www.cloudflare.com" and ip.src in {203.0.113.0/24} | 2 |
Logical XOR (exclusive OR) | xor | ^^ | http.host eq "www.cloudflare.com" xor ip.src in {203.0.113.0/24} | 3 |
Logical OR | or | || | http.host eq "www.cloudflare.com" or ip.src in 203.0.113.0/24 | 4 |
When writing compound expressions, it is important to be aware of the precedence of logical operators so that your expression is evaluated the way you expect.
For example, consider the following generic expression, which uses and
and or
operators:
If these operators had no order of precedence, it would not be clear which of two interpretations is correct:
- Match when Expression 1 and Expression 2 are both true or when Expression 3 is true.
- Match when Expression 1 is true and either Expression 2 or Expression 3 is true.
Since the logical and
operator has precedence over logical or
, the and
operator must be evaluated first. Interpretation 1 is correct.
To avoid ambiguity when working with logical operators, use grouping symbols so that the order of evaluation is explicit.
The Rules language supports parentheses ((
,)
) as grouping symbols. Grouping symbols allow you to organize expressions, enforce precedence, and nest expressions.
Only the Expression Editor and the Cloudflare API support grouping symbols. The Expression Builder does not.
Use parentheses to explicitly group expressions that should be evaluated together. In this example, the parentheses do not alter the evaluation of the expression, but they unambiguously call out which logical operators to evaluate first.
Because grouping symbols are so explicit, you are less likely to make errors when you use them to write compound expressions.
Grouping symbols are a powerful tool to enforce precedence for grouped elements of a compound expression. In this example, parentheses force the logical or
operator to be evaluated before the logical and
:
Without parentheses, the logical and
operator would take precedence.
You can nest expressions grouped by parentheses inside other groups to create very precise, sophisticated expressions, such as this example for a rule designed to block access to a domain:
Note that when evaluating the precedence of logical operators, parentheses inside strings delimited by quotes are ignored, such as those in the following regular expression, drawn from the example above: