Edge Security Acceleration:CreateCacheRule

The ID of the Site. Call the ListSites operation to obtain this ID.

The version of the Site's configuration. If the Site has versioning enabled, this parameter specifies which version the configuration applies to. The default is 0.

The name of the Rule. This parameter is not required when adding a global configuration.

Indicates whether the Rule is enabled or disabled. This parameter is not required when adding a global configuration. Valid values:

• on: Enabled.

• off: Disabled.

The content of the Rule, a conditional expression that matches user requests. This parameter is not required when adding a global configuration. It supports two use cases:

• To match all incoming requests, set the value to true.

• To match specific requests, set the value to a custom expression. For example: (http.host eq "video.example.com")

The Bypass Cache mode. Valid values:

• cache_all: Caches all requests.

• bypass_all: Bypasses the cache for all requests.

The Browser Cache mode. Valid values:

• no_cache: Disables Browser Cache.

• follow_origin: Honors the origin server's cache policy.

• override_origin: Overrides the origin server's cache policy.

The Browser Cache TTL (Time-To-Live), in seconds.

The cache mode for the Edge Node. Valid values:

• follow_origin: Honors the origin server's cache policy if present. Otherwise, the default cache policy is used.

• no_cache: Disables caching on the Edge Node.

• override_origin: Overrides the origin server's cache policy.

• follow_origin_bypass: Honors the origin server's cache policy if present. Otherwise, content is not cached.

• follow_origin_override: Honors the origin server's cache policy if present. Otherwise, a custom Cache TTL is used.

The Cache TTL (in seconds) for content on the Edge Node.

The Cache TTL for specific status codes, in seconds.

• You can set the Cache TTL for an individual status code. For example, 404=10 caches responses with a 404 status code for 10 seconds.

• You can also set the Cache TTL for a series of status codes, such as 4xx or 5xx. For example, 4xx=10 caches all responses in the 400-series for 10 seconds.

Specifies whether to sort query strings before generating the Cache Key. Disabled by default. Valid values:

• on: Enabled.

• off: Disabled.

Defines how to handle query strings when generating the Cache Key. Valid values:

• ignore_all: Excludes all query strings from the Cache Key.

• exclude_query_string: Excludes specific query strings from the Cache Key.

• reserve_all: Default. Includes all query strings in the Cache Key.

• include_query_string: Includes only specific query strings in the Cache Key.

The specific query strings to include or exclude, depending on the QueryStringMode. Separate multiple query strings with a space.

The names of the headers to include in the Cache Key. This includes both the header name and its value. Separate multiple headers with a space.

The names of the cookies to include in the Cache Key. This includes both the cookie name and its value. Separate multiple cookies with a space.

Controls whether a request bypasses the Cache Reservation node during an Origin Fetch. Valid values:

• bypass_cache_reserve: The request bypasses Cache Reservation.

• eligible_for_cache_reserve: The request is eligible for Cache Reservation.

Specifies headers to check for presence when generating the Cache Key. If a specified header exists in the request, its name (case-insensitive) is included in the Cache Key. Separate multiple header names with a space.

Specifies cookies to check for presence when generating the Cache Key. If a specified cookie exists in the request, its name (case-insensitive) is included in the Cache Key. Separate multiple cookie names with a space.

If enabled, includes the client's device type in the Cache Key. Valid values:

• on: Enabled.

• off: Disabled.

If enabled, includes the client's geographic location in the Cache Key. Valid values:

• on: Enabled.

• off: Disabled.

If enabled, includes the client's language in the Cache Key. Valid values:

• on: Enabled.

• off: Disabled.

If enabled, allows the Edge Node to serve stale (expired) content when the Origin Server is unavailable. Valid values:

• on: Enabled.

• off: Disabled.

Specifies additional ports where caching is enabled. Valid ports: 8880, 2052, 2082, 2086, 2095, 2053, 2083, 2087, 2096.

If enabled, provides cache deception defense by validating content before caching it. Valid values:

• on: Enabled.

• off: Disabled.

The execution order of the Rule. A smaller value indicates a higher priority.

Enables or disables caching for POST requests.

The maximum size (in KB) of a request body to cache. The supported range is from 1 to 8 KB. If left empty, the default limit is 8 KB.

Specifies how to handle the request body when generating the Cache Key for POST requests.