Fields for rule uploads and downloads
The following are the fields available when setting up the syntax for CSV-based rules or downloading rules.
Data Type | CSV Column Name | Action/Description |
---|---|---|
Required Fields | ||
Rule name | ruleName |
Enter a descriptive name for the rule. This field is required for all rules. |
HTTP status code | result.statusCode |
For Edge Redirector,
enter the status code for the type of redirect this rule supports. Options include:
|
Source URL | matchURL |
For Edge Redirector
,enter the name of the source, or inbound, URL. Enter the full web
address that you are redirecting, including the protocol. For example: |
Redirect URL | result.redirectURL |
For Edge
Redirector, enter the HTTP- or HTTPS-based URL to redirect to if the rule is true. You must enter the full web address you are redirecting the source URL
to, including the protocol. For example: |
Optional Fields | ||
Continent Code
(Part of User Data Location Match) |
continentCode |
If applicable, enter
the appropriate continent code in uppercase letters to match based on
continent. For this match type, you can also select whether to use the client IP
address from the connecting IP address For example, enter
this to select one continent and both client IP options: |
Cookie | cookie |
Enter a cookie to
match on using the following format:
CookieName = value
For example: |
Country Code
(Part of User Data Location Match) |
countryCode |
If applicable,
enter the appropriate country code in uppercase letters to match based on country.
For this match type, you can also select whether to use the client
IP address from the connecting IP address US;CONNECTING_IP
XFF_HEADERS Note the spaces used between multiple values and the semicolon separating the data types. |
Default | matchAlways |
Enter 1 (true) to match on all incoming requests.
This match type is particularly useful at the end of a rule list. If none of the other rules in the list produce a match, then you can use the default match type to treat the remaining traffic in a particular way. |
Device Characteristics | deviceCharacteristics |
Enter one of these
device characteristics to match on:
When creating a true match, enter only the name of the device characteristic. To create a false match, add an exclamation point in front of the device characteristic’s name. For example:!
accept_third_party_cookie . |
End Time | utcEndTime |
Using the UTC
format, enter the end date and time for the rule in seconds. Enter 0 if you do not want the rule to expire. If you enter a value in this field other than “0”, you must enter a
value greater than “0” in the |
File Extension | extension |
Enter the file
extension(s) to match on. You do not need to enter the period before the extension.
For example: jpg
png Note: When
entering multiple values, separate them with a space. |
Hostname | hostname |
Enter the hostname
to match on. Include the domain, but exclude the protocol. For example:
www.example.com
. You can use the *
wildcard with this match type. |
IP address or CIDR List | clientip |
Enter an IP address
or CIDR list to match on. For example: 122.122.122.0 192.168.2.0/24
When entering multiple values, separate them with a space. You are limited to 8192 characters. For this match type, you can also select whether to use the client IP address from the connecting IP address(CONNECTING_IP) , the
X-Forwarded-For header value (XFF_HEADERS) , or either option. For example, enter this
to select one IP address and both client IP options: |
Pass Query Parameters | result.useIncomingQueryString |
Enter either
0 (false) or 1 (true) to append all query
parameters from the source URL to the redirect URL. |
Protocol | protocol |
Enter either
HTTP or
HTTPS as the protocol to match on. You can enter the protocol using either uppercase or lowercase letters. |
Proxy | proxy |
Enter the type of
proxy to match on. Values include anonymous ,
transparent , or both. While anonymous proxy servers hide the originating IP address, transparent proxy servers include the originating IP address in the X-Forwarded-For (XFF) value in the HTTP header. For this match type, you can also select whether to use the client IP address from
the connecting IP address For example, enter this to select both options for proxy
and client Note the spaces between the values and the semicolon between the data types. |
Query String Parameter Match | query |
Enter the query string to match on using the following format:
QueryStringName
=
value
For example:
Note: You can use the * wildcard with this match type. |
Region Code
(Part of User Data Location Match) |
regionCode |
If applicable,
enter the appropriate region code in uppercase letters. Region code matches are
based on a region, like a state or a province, within a country. For
this match type, you can also select whether to use the client IP address from the
connecting IP address For example, enter this to select one region/state and
both client IP options: Note the spaces between the values and the semicolon between the data types. |
Regular Expression Match | regex |
Enter a single URL-based regular
expression (regex) to match on. A single CVS rule cannot contain multiple regex
values. For example:
Note: When using a regular
expression match with Edge Redirector, the Redirect URL (result.redirectURL) can
include capture groups. For example:
\1:// www.company.com/\2/\3
.Path and Query String (result.pathAndQS) can include capture groups.
|
Request Header | header |
Enter the request
header to match on using the following format.
For example: Accept: Note: Separate the request
header type and value with a colon (:), not an equals sign. Note: You can use the * and ? wildcards with this match
type. |
Request Method | method |
Enter the request header to match on. Options include the following: DELETE, GET, HEAD, POST, and PUT. |
Start Time | utcStartTime |
Using the UTC format, enter the starting date and time for the rule in seconds. Enter 0 to always apply the rule.
If you enter a value in this field other than “0”, you must enter a value greater than “0” in the
|
URL Path | path |
Enter the URL path to match on. Include the leading slash, but omit any training slashes. For example:
/Q1Sale/images. Note: You can use the * wildcard with this match type. |