--- title: Rules --- [Skip to content](#_top) [API Reference](https://developers.cloudflare.com/api) [Rulesets](https://developers.cloudflare.com/api/resources/rulesets) Copy Markdown Open in **Claude**Open in **ChatGPT**Open in **Cursor** --- **Copy Markdown****View as Markdown** # Rules ##### [Create an account or zone ruleset rule](https://developers.cloudflare.com/api/resources/rulesets/subresources/rules/methods/create) POST/{accounts\_or\_zones}/{account\_or\_zone\_id}/rulesets/{ruleset\_id}/rules ##### [Update an account or zone ruleset rule](https://developers.cloudflare.com/api/resources/rulesets/subresources/rules/methods/edit) PATCH/{accounts\_or\_zones}/{account\_or\_zone\_id}/rulesets/{ruleset\_id}/rules/{rule\_id} ##### [Delete an account or zone ruleset rule](https://developers.cloudflare.com/api/resources/rulesets/subresources/rules/methods/delete) DELETE/{accounts\_or\_zones}/{account\_or\_zone\_id}/rulesets/{ruleset\_id}/rules/{rule\_id} ##### ModelsExpand Collapse

BlockRule object {last\_updated, version, id, 10 more }

last\_updated: string The timestamp of when the rule was last modified. formatdate-time Link to this property version: string The version of the rule. Link to this property id: optional string The unique ID of the rule. Link to this property action: optional "block" The action to perform when the rule matches. Link to this property

action\_parameters: optional object {response } The parameters configuring the rule’s action.

response: optional object {content, content\_type, status\_code } The response to show when the block is applied.

content: string The content to return. minLength1 Link to this property content\_type: string The type of the content to return. minLength1 Link to this property status\_code: number The status code to return. maximum499 minimum400 Link to this property

Link to this property

Link to this property categories: optional array of string The categories of the rule. Link to this property description: optional string An informative description of the rule. Link to this property enabled: optional boolean Whether the rule should be executed. Link to this property

exposed\_credential\_check: optional object {password\_expression, username\_expression } Configuration for exposed credential checking.

password\_expression: string An expression that selects the password used in the credentials check. minLength1 Link to this property username\_expression: string An expression that selects the user ID used in the credentials check. minLength1 Link to this property

Link to this property expression: optional string The expression defining which traffic will match the rule. minLength1 Link to this property logging: optional Logging { enabled } An object configuring the rule’s logging behavior. Link to this property

ratelimit: optional object {characteristics, period, counting\_expression, 5 more } An object configuring the rule’s rate limit behavior.

characteristics: array of string Characteristics of the request on which the rate limit counter will be incremented. Link to this property period: number Period in seconds over which the counter is being incremented. minimum0 Link to this property counting\_expression: optional string An expression that defines when the rate limit counter should be incremented. It defaults to the same as the rule’s expression. minLength1 Link to this property mitigation\_timeout: optional number Period of time in seconds after which the action will be disabled following its first execution. Link to this property requests\_per\_period: optional number The threshold of requests per period after which the action will be executed for the first time. minimum1 Link to this property requests\_to\_origin: optional boolean Whether counting is only performed when an origin is reached. Link to this property score\_per\_period: optional number The score threshold per period for which the action will be executed the first time. Link to this property score\_response\_header\_name: optional string A response header name provided by the origin, which contains the score to increment rate limit counter with. minLength1 Link to this property

Link to this property ref: optional string The reference of the rule (the rule’s ID by default). minLength1 Link to this property

[Link to this property](<#(resource)%20rulesets.rules%20%3E%20(model)%20block_rule%20%3E%20(schema)>)

CompressResponseRule object {last\_updated, version, id, 10 more }

last\_updated: string The timestamp of when the rule was last modified. formatdate-time Link to this property version: string The version of the rule. Link to this property id: optional string The unique ID of the rule. Link to this property action: optional "compress\_response" The action to perform when the rule matches. Link to this property

action\_parameters: optional object {algorithms } The parameters configuring the rule’s action.

algorithms: array of object {name } Custom order for compression algorithms.

name: optional "none"or "auto"or "default"or 3 more Name of the compression algorithm to enable.

One of the following: "none" Link to this property "auto" Link to this property "default" Link to this property "gzip" Link to this property "brotli" Link to this property "zstd" Link to this property

Link to this property

Link to this property

Link to this property categories: optional array of string The categories of the rule. Link to this property description: optional string An informative description of the rule. Link to this property enabled: optional boolean Whether the rule should be executed. Link to this property

exposed\_credential\_check: optional object {password\_expression, username\_expression } Configuration for exposed credential checking.

password\_expression: string An expression that selects the password used in the credentials check. minLength1 Link to this property username\_expression: string An expression that selects the user ID used in the credentials check. minLength1 Link to this property

Link to this property expression: optional string The expression defining which traffic will match the rule. minLength1 Link to this property logging: optional Logging { enabled } An object configuring the rule’s logging behavior. Link to this property

ratelimit: optional object {characteristics, period, counting\_expression, 5 more } An object configuring the rule’s rate limit behavior.

characteristics: array of string Characteristics of the request on which the rate limit counter will be incremented. Link to this property period: number Period in seconds over which the counter is being incremented. minimum0 Link to this property counting\_expression: optional string An expression that defines when the rate limit counter should be incremented. It defaults to the same as the rule’s expression. minLength1 Link to this property mitigation\_timeout: optional number Period of time in seconds after which the action will be disabled following its first execution. Link to this property requests\_per\_period: optional number The threshold of requests per period after which the action will be executed for the first time. minimum1 Link to this property requests\_to\_origin: optional boolean Whether counting is only performed when an origin is reached. Link to this property score\_per\_period: optional number The score threshold per period for which the action will be executed the first time. Link to this property score\_response\_header\_name: optional string A response header name provided by the origin, which contains the score to increment rate limit counter with. minLength1 Link to this property

Link to this property ref: optional string The reference of the rule (the rule’s ID by default). minLength1 Link to this property

[Link to this property](<#(resource)%20rulesets.rules%20%3E%20(model)%20compress_response_rule%20%3E%20(schema)>)

DDoSDynamicRule object {last\_updated, version, id, 10 more }

last\_updated: string The timestamp of when the rule was last modified. formatdate-time Link to this property version: string The version of the rule. Link to this property id: optional string The unique ID of the rule. Link to this property action: optional "ddos\_dynamic" The action to perform when the rule matches. Link to this property action\_parameters: optional unknown The parameters configuring the rule’s action. Link to this property categories: optional array of string The categories of the rule. Link to this property description: optional string An informative description of the rule. Link to this property enabled: optional boolean Whether the rule should be executed. Link to this property

exposed\_credential\_check: optional object {password\_expression, username\_expression } Configuration for exposed credential checking.

password\_expression: string An expression that selects the password used in the credentials check. minLength1 Link to this property username\_expression: string An expression that selects the user ID used in the credentials check. minLength1 Link to this property

Link to this property expression: optional string The expression defining which traffic will match the rule. minLength1 Link to this property logging: optional Logging { enabled } An object configuring the rule’s logging behavior. Link to this property

ratelimit: optional object {characteristics, period, counting\_expression, 5 more } An object configuring the rule’s rate limit behavior.

characteristics: array of string Characteristics of the request on which the rate limit counter will be incremented. Link to this property period: number Period in seconds over which the counter is being incremented. minimum0 Link to this property counting\_expression: optional string An expression that defines when the rate limit counter should be incremented. It defaults to the same as the rule’s expression. minLength1 Link to this property mitigation\_timeout: optional number Period of time in seconds after which the action will be disabled following its first execution. Link to this property requests\_per\_period: optional number The threshold of requests per period after which the action will be executed for the first time. minimum1 Link to this property requests\_to\_origin: optional boolean Whether counting is only performed when an origin is reached. Link to this property score\_per\_period: optional number The score threshold per period for which the action will be executed the first time. Link to this property score\_response\_header\_name: optional string A response header name provided by the origin, which contains the score to increment rate limit counter with. minLength1 Link to this property

Link to this property ref: optional string The reference of the rule (the rule’s ID by default). minLength1 Link to this property

[Link to this property](<#(resource)%20rulesets.rules%20%3E%20(model)%20ddos_dynamic_rule%20%3E%20(schema)>)

ExecuteRule object {last\_updated, version, id, 10 more }

last\_updated: string The timestamp of when the rule was last modified. formatdate-time Link to this property version: string The version of the rule. Link to this property id: optional string The unique ID of the rule. Link to this property action: optional "execute" The action to perform when the rule matches. Link to this property

action\_parameters: optional object {id, matched\_data, overrides } The parameters configuring the rule’s action.

id: string The ID of the ruleset to execute. Link to this property

matched\_data: optional object {public\_key } The configuration to use for matched data logging.

public\_key: string The public key to encrypt matched data logs with. minLength1 Link to this property

Link to this property

overrides: optional object {action, categories, enabled, 2 more } A set of overrides to apply to the target ruleset.

action: optional string An action to override all rules with. This option has lower precedence than rule and category overrides. Link to this property

categories: optional array of object {category, action, enabled, sensitivity\_level } A list of category-level overrides. This option has the second-highest precedence after rule-level overrides.

category: string The name of the category to override. minLength1 Link to this property action: optional string The action to override rules in the category with. Link to this property enabled: optional boolean Whether to enable execution of rules in the category. Link to this property

sensitivity\_level: optional "default"or "medium"or "low"or "eoff" The sensitivity level to use for rules in the category. This option is only applicable for DDoS phases.

One of the following: "default" Link to this property "medium" Link to this property "low" Link to this property "eoff" Link to this property

Link to this property

Link to this property enabled: optional boolean Whether to enable execution of all rules. This option has lower precedence than rule and category overrides. Link to this property

rules: optional array of object {id, action, enabled, 2 more } A list of rule-level overrides. This option has the highest precedence.

id: string The ID of the rule to override. Link to this property action: optional string The action to override the rule with. Link to this property enabled: optional boolean Whether to enable execution of the rule. Link to this property score\_threshold: optional number The score threshold to use for the rule. Link to this property

sensitivity\_level: optional "default"or "medium"or "low"or "eoff" The sensitivity level to use for the rule. This option is only applicable for DDoS phases.

One of the following: "default" Link to this property "medium" Link to this property "low" Link to this property "eoff" Link to this property

Link to this property

Link to this property

sensitivity\_level: optional "default"or "medium"or "low"or "eoff" A sensitivity level to set for all rules. This option has lower precedence than rule and category overrides and is only applicable for DDoS phases.

One of the following: "default" Link to this property "medium" Link to this property "low" Link to this property "eoff" Link to this property

Link to this property

Link to this property

Link to this property categories: optional array of string The categories of the rule. Link to this property description: optional string An informative description of the rule. Link to this property enabled: optional boolean Whether the rule should be executed. Link to this property

exposed\_credential\_check: optional object {password\_expression, username\_expression } Configuration for exposed credential checking.

password\_expression: string An expression that selects the password used in the credentials check. minLength1 Link to this property username\_expression: string An expression that selects the user ID used in the credentials check. minLength1 Link to this property

Link to this property expression: optional string The expression defining which traffic will match the rule. minLength1 Link to this property logging: optional Logging { enabled } An object configuring the rule’s logging behavior. Link to this property

ratelimit: optional object {characteristics, period, counting\_expression, 5 more } An object configuring the rule’s rate limit behavior.

characteristics: array of string Characteristics of the request on which the rate limit counter will be incremented. Link to this property period: number Period in seconds over which the counter is being incremented. minimum0 Link to this property counting\_expression: optional string An expression that defines when the rate limit counter should be incremented. It defaults to the same as the rule’s expression. minLength1 Link to this property mitigation\_timeout: optional number Period of time in seconds after which the action will be disabled following its first execution. Link to this property requests\_per\_period: optional number The threshold of requests per period after which the action will be executed for the first time. minimum1 Link to this property requests\_to\_origin: optional boolean Whether counting is only performed when an origin is reached. Link to this property score\_per\_period: optional number The score threshold per period for which the action will be executed the first time. Link to this property score\_response\_header\_name: optional string A response header name provided by the origin, which contains the score to increment rate limit counter with. minLength1 Link to this property

Link to this property ref: optional string The reference of the rule (the rule’s ID by default). minLength1 Link to this property

[Link to this property](<#(resource)%20rulesets.rules%20%3E%20(model)%20execute_rule%20%3E%20(schema)>)

ForceConnectionCloseRule object {last\_updated, version, id, 10 more }

last\_updated: string The timestamp of when the rule was last modified. formatdate-time Link to this property version: string The version of the rule. Link to this property id: optional string The unique ID of the rule. Link to this property action: optional "force\_connection\_close" The action to perform when the rule matches. Link to this property action\_parameters: optional unknown The parameters configuring the rule’s action. Link to this property categories: optional array of string The categories of the rule. Link to this property description: optional string An informative description of the rule. Link to this property enabled: optional boolean Whether the rule should be executed. Link to this property

exposed\_credential\_check: optional object {password\_expression, username\_expression } Configuration for exposed credential checking.

password\_expression: string An expression that selects the password used in the credentials check. minLength1 Link to this property username\_expression: string An expression that selects the user ID used in the credentials check. minLength1 Link to this property

Link to this property expression: optional string The expression defining which traffic will match the rule. minLength1 Link to this property logging: optional Logging { enabled } An object configuring the rule’s logging behavior. Link to this property

ratelimit: optional object {characteristics, period, counting\_expression, 5 more } An object configuring the rule’s rate limit behavior.

characteristics: array of string Characteristics of the request on which the rate limit counter will be incremented. Link to this property period: number Period in seconds over which the counter is being incremented. minimum0 Link to this property counting\_expression: optional string An expression that defines when the rate limit counter should be incremented. It defaults to the same as the rule’s expression. minLength1 Link to this property mitigation\_timeout: optional number Period of time in seconds after which the action will be disabled following its first execution. Link to this property requests\_per\_period: optional number The threshold of requests per period after which the action will be executed for the first time. minimum1 Link to this property requests\_to\_origin: optional boolean Whether counting is only performed when an origin is reached. Link to this property score\_per\_period: optional number The score threshold per period for which the action will be executed the first time. Link to this property score\_response\_header\_name: optional string A response header name provided by the origin, which contains the score to increment rate limit counter with. minLength1 Link to this property

Link to this property ref: optional string The reference of the rule (the rule’s ID by default). minLength1 Link to this property

[Link to this property](<#(resource)%20rulesets.rules%20%3E%20(model)%20force_connection_close_rule%20%3E%20(schema)>)

LogCustomFieldRule object {last\_updated, version, id, 10 more }

last\_updated: string The timestamp of when the rule was last modified. formatdate-time Link to this property version: string The version of the rule. Link to this property id: optional string The unique ID of the rule. Link to this property action: optional "log\_custom\_field" The action to perform when the rule matches. Link to this property

action\_parameters: optional object {cookie\_fields, raw\_response\_fields, request\_fields, 2 more } The parameters configuring the rule’s action.

cookie\_fields: optional array of object {name } The cookie fields to log.

name: string The name of the cookie. minLength1 Link to this property

Link to this property

raw\_response\_fields: optional array of object {name, preserve\_duplicates } The raw response fields to log.

name: string The name of the response header. minLength1 Link to this property preserve\_duplicates: optional boolean Whether to log duplicate values of the same header. Link to this property

Link to this property

request\_fields: optional array of object {name } The raw request fields to log.

name: string The name of the header. minLength1 Link to this property

Link to this property

response\_fields: optional array of object {name, preserve\_duplicates } The transformed response fields to log.

name: string The name of the response header. minLength1 Link to this property preserve\_duplicates: optional boolean Whether to log duplicate values of the same header. Link to this property

Link to this property

transformed\_request\_fields: optional array of object {name } The transformed request fields to log.

name: string The name of the header. minLength1 Link to this property

Link to this property

Link to this property categories: optional array of string The categories of the rule. Link to this property description: optional string An informative description of the rule. Link to this property enabled: optional boolean Whether the rule should be executed. Link to this property

exposed\_credential\_check: optional object {password\_expression, username\_expression } Configuration for exposed credential checking.

password\_expression: string An expression that selects the password used in the credentials check. minLength1 Link to this property username\_expression: string An expression that selects the user ID used in the credentials check. minLength1 Link to this property

Link to this property expression: optional string The expression defining which traffic will match the rule. minLength1 Link to this property logging: optional Logging { enabled } An object configuring the rule’s logging behavior. Link to this property

ratelimit: optional object {characteristics, period, counting\_expression, 5 more } An object configuring the rule’s rate limit behavior.

characteristics: array of string Characteristics of the request on which the rate limit counter will be incremented. Link to this property period: number Period in seconds over which the counter is being incremented. minimum0 Link to this property counting\_expression: optional string An expression that defines when the rate limit counter should be incremented. It defaults to the same as the rule’s expression. minLength1 Link to this property mitigation\_timeout: optional number Period of time in seconds after which the action will be disabled following its first execution. Link to this property requests\_per\_period: optional number The threshold of requests per period after which the action will be executed for the first time. minimum1 Link to this property requests\_to\_origin: optional boolean Whether counting is only performed when an origin is reached. Link to this property score\_per\_period: optional number The score threshold per period for which the action will be executed the first time. Link to this property score\_response\_header\_name: optional string A response header name provided by the origin, which contains the score to increment rate limit counter with. minLength1 Link to this property

Link to this property ref: optional string The reference of the rule (the rule’s ID by default). minLength1 Link to this property

[Link to this property](<#(resource)%20rulesets.rules%20%3E%20(model)%20log_custom_field_rule%20%3E%20(schema)>)

LogRule object {last\_updated, version, id, 10 more }

last\_updated: string The timestamp of when the rule was last modified. formatdate-time Link to this property version: string The version of the rule. Link to this property id: optional string The unique ID of the rule. Link to this property action: optional "log" The action to perform when the rule matches. Link to this property action\_parameters: optional unknown The parameters configuring the rule’s action. Link to this property categories: optional array of string The categories of the rule. Link to this property description: optional string An informative description of the rule. Link to this property enabled: optional boolean Whether the rule should be executed. Link to this property

exposed\_credential\_check: optional object {password\_expression, username\_expression } Configuration for exposed credential checking.

password\_expression: string An expression that selects the password used in the credentials check. minLength1 Link to this property username\_expression: string An expression that selects the user ID used in the credentials check. minLength1 Link to this property

Link to this property expression: optional string The expression defining which traffic will match the rule. minLength1 Link to this property logging: optional Logging { enabled } An object configuring the rule’s logging behavior. Link to this property

ratelimit: optional object {characteristics, period, counting\_expression, 5 more } An object configuring the rule’s rate limit behavior.

characteristics: array of string Characteristics of the request on which the rate limit counter will be incremented. Link to this property period: number Period in seconds over which the counter is being incremented. minimum0 Link to this property counting\_expression: optional string An expression that defines when the rate limit counter should be incremented. It defaults to the same as the rule’s expression. minLength1 Link to this property mitigation\_timeout: optional number Period of time in seconds after which the action will be disabled following its first execution. Link to this property requests\_per\_period: optional number The threshold of requests per period after which the action will be executed for the first time. minimum1 Link to this property requests\_to\_origin: optional boolean Whether counting is only performed when an origin is reached. Link to this property score\_per\_period: optional number The score threshold per period for which the action will be executed the first time. Link to this property score\_response\_header\_name: optional string A response header name provided by the origin, which contains the score to increment rate limit counter with. minLength1 Link to this property

Link to this property ref: optional string The reference of the rule (the rule’s ID by default). minLength1 Link to this property

[Link to this property](<#(resource)%20rulesets.rules%20%3E%20(model)%20log_rule%20%3E%20(schema)>)

Logging object {enabled } An object configuring the rule’s logging behavior.

enabled: boolean Whether to generate a log when the rule matches. Link to this property

[Link to this property](<#(resource)%20rulesets.rules%20%3E%20(model)%20logging%20%3E%20(schema)>)

ManagedChallengeRule object {last\_updated, version, id, 10 more }

last\_updated: string The timestamp of when the rule was last modified. formatdate-time Link to this property version: string The version of the rule. Link to this property id: optional string The unique ID of the rule. Link to this property action: optional "managed\_challenge" The action to perform when the rule matches. Link to this property action\_parameters: optional unknown The parameters configuring the rule’s action. Link to this property categories: optional array of string The categories of the rule. Link to this property description: optional string An informative description of the rule. Link to this property enabled: optional boolean Whether the rule should be executed. Link to this property

exposed\_credential\_check: optional object {password\_expression, username\_expression } Configuration for exposed credential checking.

password\_expression: string An expression that selects the password used in the credentials check. minLength1 Link to this property username\_expression: string An expression that selects the user ID used in the credentials check. minLength1 Link to this property

Link to this property expression: optional string The expression defining which traffic will match the rule. minLength1 Link to this property logging: optional Logging { enabled } An object configuring the rule’s logging behavior. Link to this property

ratelimit: optional object {characteristics, period, counting\_expression, 5 more } An object configuring the rule’s rate limit behavior.

characteristics: array of string Characteristics of the request on which the rate limit counter will be incremented. Link to this property period: number Period in seconds over which the counter is being incremented. minimum0 Link to this property counting\_expression: optional string An expression that defines when the rate limit counter should be incremented. It defaults to the same as the rule’s expression. minLength1 Link to this property mitigation\_timeout: optional number Period of time in seconds after which the action will be disabled following its first execution. Link to this property requests\_per\_period: optional number The threshold of requests per period after which the action will be executed for the first time. minimum1 Link to this property requests\_to\_origin: optional boolean Whether counting is only performed when an origin is reached. Link to this property score\_per\_period: optional number The score threshold per period for which the action will be executed the first time. Link to this property score\_response\_header\_name: optional string A response header name provided by the origin, which contains the score to increment rate limit counter with. minLength1 Link to this property

Link to this property ref: optional string The reference of the rule (the rule’s ID by default). minLength1 Link to this property

[Link to this property](<#(resource)%20rulesets.rules%20%3E%20(model)%20managed_challenge_rule%20%3E%20(schema)>)

RedirectRule object {last\_updated, version, id, 10 more }

last\_updated: string The timestamp of when the rule was last modified. formatdate-time Link to this property version: string The version of the rule. Link to this property id: optional string The unique ID of the rule. Link to this property action: optional "redirect" The action to perform when the rule matches. Link to this property

action\_parameters: optional object {from\_list, from\_value } The parameters configuring the rule’s action.

from\_list: optional object {key, name } A redirect based on a bulk list lookup.

key: string An expression that evaluates to the list lookup key. minLength1 Link to this property name: string The name of the list to match against. Link to this property

Link to this property

from\_value: optional object {target\_url, preserve\_query\_string, status\_code } A redirect based on the request properties.

target\_url: object {expression, value } A URL to redirect the request to.

expression: optional string An expression that evaluates to a URL to redirect the request to. minLength1 Link to this property value: optional string A URL to redirect the request to. minLength1 Link to this property

Link to this property preserve\_query\_string: optional boolean Whether to keep the query string of the original request. Link to this property

status\_code: optional 301or 302or 303or 2 more The status code to use for the redirect.

One of the following: 301 Link to this property 302 Link to this property 303 Link to this property 307 Link to this property 308 Link to this property

Link to this property

Link to this property

Link to this property categories: optional array of string The categories of the rule. Link to this property description: optional string An informative description of the rule. Link to this property enabled: optional boolean Whether the rule should be executed. Link to this property

exposed\_credential\_check: optional object {password\_expression, username\_expression } Configuration for exposed credential checking.

password\_expression: string An expression that selects the password used in the credentials check. minLength1 Link to this property username\_expression: string An expression that selects the user ID used in the credentials check. minLength1 Link to this property

Link to this property expression: optional string The expression defining which traffic will match the rule. minLength1 Link to this property logging: optional Logging { enabled } An object configuring the rule’s logging behavior. Link to this property

ratelimit: optional object {characteristics, period, counting\_expression, 5 more } An object configuring the rule’s rate limit behavior.

characteristics: array of string Characteristics of the request on which the rate limit counter will be incremented. Link to this property period: number Period in seconds over which the counter is being incremented. minimum0 Link to this property counting\_expression: optional string An expression that defines when the rate limit counter should be incremented. It defaults to the same as the rule’s expression. minLength1 Link to this property mitigation\_timeout: optional number Period of time in seconds after which the action will be disabled following its first execution. Link to this property requests\_per\_period: optional number The threshold of requests per period after which the action will be executed for the first time. minimum1 Link to this property requests\_to\_origin: optional boolean Whether counting is only performed when an origin is reached. Link to this property score\_per\_period: optional number The score threshold per period for which the action will be executed the first time. Link to this property score\_response\_header\_name: optional string A response header name provided by the origin, which contains the score to increment rate limit counter with. minLength1 Link to this property

Link to this property ref: optional string The reference of the rule (the rule’s ID by default). minLength1 Link to this property

[Link to this property](<#(resource)%20rulesets.rules%20%3E%20(model)%20redirect_rule%20%3E%20(schema)>)

RewriteRule object {last\_updated, version, id, 10 more }

last\_updated: string The timestamp of when the rule was last modified. formatdate-time Link to this property version: string The version of the rule. Link to this property id: optional string The unique ID of the rule. Link to this property action: optional "rewrite" The action to perform when the rule matches. Link to this property

action\_parameters: optional object {headers, uri } The parameters configuring the rule’s action.

headers: optional map\[object {operation, value } or object {expression, operation } or object {operation, value } or 2 more] A map of headers to rewrite.

One of the following:

AddStaticHeader object {operation, value } A header with a static value to add.

operation: "add" The operation to perform on the header. Link to this property value: string A static value for the header. minLength1 Link to this property

Link to this property

AddDynamicHeader object {expression, operation } A header with a dynamic value to add.

expression: string An expression that evaluates to a value for the header. minLength1 Link to this property operation: "add" The operation to perform on the header. Link to this property

Link to this property

SetStaticHeader object {operation, value } A header with a static value to set.

operation: "set" The operation to perform on the header. Link to this property value: string A static value for the header. minLength1 Link to this property

Link to this property

SetDynamicHeader object {expression, operation } A header with a dynamic value to set.

expression: string An expression that evaluates to a value for the header. minLength1 Link to this property operation: "set" The operation to perform on the header. Link to this property

Link to this property

RemoveHeader object {operation } A header to remove.

operation: "remove" The operation to perform on the header. Link to this property

Link to this property

Link to this property

uri: optional object {path, origin } or object {query, origin } A URI path rewrite.

One of the following:

URIPath object {path, origin } A URI path rewrite.

path: object {expression, value } A URI path rewrite.

expression: optional string An expression that evaluates to a value to rewrite the URI path to. minLength1 Link to this property value: optional string A value to rewrite the URI path to. minLength1 Link to this property

Link to this property origin: optional boolean Whether to propagate the rewritten URI to origin. Link to this property

Link to this property

URIQuery object {query, origin } A URI query rewrite.

query: object {expression, value } A URI query rewrite.

expression: optional string An expression that evaluates to a value to rewrite the URI query to. minLength1 Link to this property value: optional string A value to rewrite the URI query to. Link to this property

Link to this property origin: optional boolean Whether to propagate the rewritten URI to origin. Link to this property

Link to this property

Link to this property

Link to this property categories: optional array of string The categories of the rule. Link to this property description: optional string An informative description of the rule. Link to this property enabled: optional boolean Whether the rule should be executed. Link to this property

exposed\_credential\_check: optional object {password\_expression, username\_expression } Configuration for exposed credential checking.

password\_expression: string An expression that selects the password used in the credentials check. minLength1 Link to this property username\_expression: string An expression that selects the user ID used in the credentials check. minLength1 Link to this property

Link to this property expression: optional string The expression defining which traffic will match the rule. minLength1 Link to this property logging: optional Logging { enabled } An object configuring the rule’s logging behavior. Link to this property

ratelimit: optional object {characteristics, period, counting\_expression, 5 more } An object configuring the rule’s rate limit behavior.

characteristics: array of string Characteristics of the request on which the rate limit counter will be incremented. Link to this property period: number Period in seconds over which the counter is being incremented. minimum0 Link to this property counting\_expression: optional string An expression that defines when the rate limit counter should be incremented. It defaults to the same as the rule’s expression. minLength1 Link to this property mitigation\_timeout: optional number Period of time in seconds after which the action will be disabled following its first execution. Link to this property requests\_per\_period: optional number The threshold of requests per period after which the action will be executed for the first time. minimum1 Link to this property requests\_to\_origin: optional boolean Whether counting is only performed when an origin is reached. Link to this property score\_per\_period: optional number The score threshold per period for which the action will be executed the first time. Link to this property score\_response\_header\_name: optional string A response header name provided by the origin, which contains the score to increment rate limit counter with. minLength1 Link to this property

Link to this property ref: optional string The reference of the rule (the rule’s ID by default). minLength1 Link to this property

[Link to this property](<#(resource)%20rulesets.rules%20%3E%20(model)%20rewrite_rule%20%3E%20(schema)>)

RouteRule object {last\_updated, version, id, 10 more }

last\_updated: string The timestamp of when the rule was last modified. formatdate-time Link to this property version: string The version of the rule. Link to this property id: optional string The unique ID of the rule. Link to this property action: optional "route" The action to perform when the rule matches. Link to this property

action\_parameters: optional object {host\_header, origin, sni } The parameters configuring the rule’s action.

host\_header: optional string A value to rewrite the HTTP host header to. minLength1 Link to this property

origin: optional object {host, port } An origin to route to.

host: optional string A resolved host to route to. minLength1 Link to this property port: optional number A destination port to route to. maximum65535 minimum1 Link to this property

Link to this property

sni: optional object {value } A Server Name Indication (SNI) override.

value: string A value to override the SNI to. minLength1 Link to this property

Link to this property

Link to this property categories: optional array of string The categories of the rule. Link to this property description: optional string An informative description of the rule. Link to this property enabled: optional boolean Whether the rule should be executed. Link to this property

exposed\_credential\_check: optional object {password\_expression, username\_expression } Configuration for exposed credential checking.

password\_expression: string An expression that selects the password used in the credentials check. minLength1 Link to this property username\_expression: string An expression that selects the user ID used in the credentials check. minLength1 Link to this property

Link to this property expression: optional string The expression defining which traffic will match the rule. minLength1 Link to this property logging: optional Logging { enabled } An object configuring the rule’s logging behavior. Link to this property

ratelimit: optional object {characteristics, period, counting\_expression, 5 more } An object configuring the rule’s rate limit behavior.

characteristics: array of string Characteristics of the request on which the rate limit counter will be incremented. Link to this property period: number Period in seconds over which the counter is being incremented. minimum0 Link to this property counting\_expression: optional string An expression that defines when the rate limit counter should be incremented. It defaults to the same as the rule’s expression. minLength1 Link to this property mitigation\_timeout: optional number Period of time in seconds after which the action will be disabled following its first execution. Link to this property requests\_per\_period: optional number The threshold of requests per period after which the action will be executed for the first time. minimum1 Link to this property requests\_to\_origin: optional boolean Whether counting is only performed when an origin is reached. Link to this property score\_per\_period: optional number The score threshold per period for which the action will be executed the first time. Link to this property score\_response\_header\_name: optional string A response header name provided by the origin, which contains the score to increment rate limit counter with. minLength1 Link to this property

Link to this property ref: optional string The reference of the rule (the rule’s ID by default). minLength1 Link to this property

[Link to this property](<#(resource)%20rulesets.rules%20%3E%20(model)%20route_rule%20%3E%20(schema)>)

RulesetRule object {last\_updated, version, id, 10 more }

last\_updated: string The timestamp of when the rule was last modified. formatdate-time Link to this property version: string The version of the rule. Link to this property id: optional string The unique ID of the rule. Link to this property action: optional string The action to perform when the rule matches. Link to this property action\_parameters: optional unknown The parameters configuring the rule’s action. Link to this property categories: optional array of string The categories of the rule. Link to this property description: optional string An informative description of the rule. Link to this property enabled: optional boolean Whether the rule should be executed. Link to this property

exposed\_credential\_check: optional object {password\_expression, username\_expression } Configuration for exposed credential checking.

password\_expression: string An expression that selects the password used in the credentials check. minLength1 Link to this property username\_expression: string An expression that selects the user ID used in the credentials check. minLength1 Link to this property

Link to this property expression: optional string The expression defining which traffic will match the rule. minLength1 Link to this property logging: optional Logging { enabled } An object configuring the rule’s logging behavior. Link to this property

ratelimit: optional object {characteristics, period, counting\_expression, 5 more } An object configuring the rule’s rate limit behavior.

characteristics: array of string Characteristics of the request on which the rate limit counter will be incremented. Link to this property period: number Period in seconds over which the counter is being incremented. minimum0 Link to this property counting\_expression: optional string An expression that defines when the rate limit counter should be incremented. It defaults to the same as the rule’s expression. minLength1 Link to this property mitigation\_timeout: optional number Period of time in seconds after which the action will be disabled following its first execution. Link to this property requests\_per\_period: optional number The threshold of requests per period after which the action will be executed for the first time. minimum1 Link to this property requests\_to\_origin: optional boolean Whether counting is only performed when an origin is reached. Link to this property score\_per\_period: optional number The score threshold per period for which the action will be executed the first time. Link to this property score\_response\_header\_name: optional string A response header name provided by the origin, which contains the score to increment rate limit counter with. minLength1 Link to this property

Link to this property ref: optional string The reference of the rule (the rule’s ID by default). minLength1 Link to this property

[Link to this property](<#(resource)%20rulesets.rules%20%3E%20(model)%20ruleset_rule%20%3E%20(schema)>)

ScoreRule object {last\_updated, version, id, 10 more }

last\_updated: string The timestamp of when the rule was last modified. formatdate-time Link to this property version: string The version of the rule. Link to this property id: optional string The unique ID of the rule. Link to this property action: optional "score" The action to perform when the rule matches. Link to this property

action\_parameters: optional object {increment } The parameters configuring the rule’s action.

increment: number A delta to change the score by, which can be either positive or negative. Link to this property

Link to this property categories: optional array of string The categories of the rule. Link to this property description: optional string An informative description of the rule. Link to this property enabled: optional boolean Link to this property

exposed\_credential\_check: optional object {password\_expression, username\_expression } Configuration for exposed credential checking.

password\_expression: string An expression that selects the password used in the credentials check. minLength1 Link to this property username\_expression: string An expression that selects the user ID used in the credentials check. minLength1 Link to this property

Link to this property expression: optional string The expression defining which traffic will match the rule. minLength1 Link to this property logging: optional Logging { enabled } An object configuring the rule’s logging behavior. Link to this property

ratelimit: optional object {characteristics, period, counting\_expression, 5 more } An object configuring the rule’s rate limit behavior.

characteristics: array of string Characteristics of the request on which the rate limit counter will be incremented. Link to this property period: number Period in seconds over which the counter is being incremented. minimum0 Link to this property counting\_expression: optional string An expression that defines when the rate limit counter should be incremented. It defaults to the same as the rule’s expression. minLength1 Link to this property mitigation\_timeout: optional number Period of time in seconds after which the action will be disabled following its first execution. Link to this property requests\_per\_period: optional number The threshold of requests per period after which the action will be executed for the first time. minimum1 Link to this property requests\_to\_origin: optional boolean Whether counting is only performed when an origin is reached. Link to this property score\_per\_period: optional number The score threshold per period for which the action will be executed the first time. Link to this property score\_response\_header\_name: optional string A response header name provided by the origin, which contains the score to increment rate limit counter with. minLength1 Link to this property

Link to this property ref: optional string The reference of the rule (the rule’s ID by default). minLength1 Link to this property

[Link to this property](<#(resource)%20rulesets.rules%20%3E%20(model)%20score_rule%20%3E%20(schema)>)

ServeErrorRule object {last\_updated, version, id, 10 more }

last\_updated: string The timestamp of when the rule was last modified. formatdate-time Link to this property version: string The version of the rule. Link to this property id: optional string The unique ID of the rule. Link to this property action: optional "serve\_error" The action to perform when the rule matches. Link to this property

action\_parameters: optional object {content, content\_type, status\_code } or object {asset\_name, content\_type, status\_code } The parameters configuring the rule’s action.

One of the following:

ActionParametersContent object {content, content\_type, status\_code }

content: string The response content. minLength1 Link to this property

content\_type: optional "application/json"or "text/html"or "text/plain"or "text/xml" The content type header to set with the error response.

One of the following: "application/json" Link to this property "text/html" Link to this property "text/plain" Link to this property "text/xml" Link to this property

Link to this property status\_code: optional number The status code to use for the error. maximum999 minimum400 Link to this property

Link to this property

ActionParametersAsset object {asset\_name, content\_type, status\_code }

asset\_name: string The name of a custom asset to serve as the error response. minLength1 Link to this property

content\_type: optional "application/json"or "text/html"or "text/plain"or "text/xml" The content type header to set with the error response.

One of the following: "application/json" Link to this property "text/html" Link to this property "text/plain" Link to this property "text/xml" Link to this property

Link to this property status\_code: optional number The status code to use for the error. maximum999 minimum400 Link to this property

Link to this property

Link to this property categories: optional array of string The categories of the rule. Link to this property description: optional string An informative description of the rule. Link to this property enabled: optional boolean Link to this property

exposed\_credential\_check: optional object {password\_expression, username\_expression } Configuration for exposed credential checking.

password\_expression: string An expression that selects the password used in the credentials check. minLength1 Link to this property username\_expression: string An expression that selects the user ID used in the credentials check. minLength1 Link to this property

Link to this property expression: optional string The expression defining which traffic will match the rule. minLength1 Link to this property logging: optional Logging { enabled } An object configuring the rule’s logging behavior. Link to this property

ratelimit: optional object {characteristics, period, counting\_expression, 5 more } An object configuring the rule’s rate limit behavior.

characteristics: array of string Characteristics of the request on which the rate limit counter will be incremented. Link to this property period: number Period in seconds over which the counter is being incremented. minimum0 Link to this property counting\_expression: optional string An expression that defines when the rate limit counter should be incremented. It defaults to the same as the rule’s expression. minLength1 Link to this property mitigation\_timeout: optional number Period of time in seconds after which the action will be disabled following its first execution. Link to this property requests\_per\_period: optional number The threshold of requests per period after which the action will be executed for the first time. minimum1 Link to this property requests\_to\_origin: optional boolean Whether counting is only performed when an origin is reached. Link to this property score\_per\_period: optional number The score threshold per period for which the action will be executed the first time. Link to this property score\_response\_header\_name: optional string A response header name provided by the origin, which contains the score to increment rate limit counter with. minLength1 Link to this property

Link to this property ref: optional string The reference of the rule (the rule’s ID by default). minLength1 Link to this property

[Link to this property](<#(resource)%20rulesets.rules%20%3E%20(model)%20serve_error_rule%20%3E%20(schema)>)

SetCacheSettingsRule object {last\_updated, version, id, 10 more }

last\_updated: string The timestamp of when the rule was last modified. formatdate-time Link to this property version: string The version of the rule. Link to this property id: optional string The unique ID of the rule. Link to this property action: optional "set\_cache\_settings" The action to perform when the rule matches. Link to this property

action\_parameters: optional object {additional\_cacheable\_ports, browser\_ttl, cache, 14 more } The parameters configuring the rule’s action.

additional\_cacheable\_ports: optional array of number A list of additional ports that caching should be enabled on. Link to this property

browser\_ttl: optional object {mode, default } How long client browsers should cache the response. Cloudflare cache purge will not purge content cached on client browsers, so high browser TTLs may lead to stale content.

mode: "respect\_origin"or "bypass\_by\_default"or "override\_origin"or "bypass" The browser TTL mode.

One of the following: "respect\_origin" Link to this property "bypass\_by\_default" Link to this property "override\_origin" Link to this property "bypass" Link to this property

Link to this property default: optional number The browser TTL (in seconds) if you choose the “override\_origin” mode. minimum0 Link to this property

Link to this property cache: optional boolean Whether the request’s response from the origin is eligible for caching. Caching itself will still depend on the cache control header and your other caching configurations. Link to this property

cache\_key: optional object {cache\_by\_device\_type, cache\_deception\_armor, custom\_key, ignore\_query\_strings\_order } Which components of the request are included in or excluded from the cache key Cloudflare uses to store the response in cache.

cache\_by\_device\_type: optional boolean Whether to separate cached content based on the visitor’s device type. Link to this property cache\_deception\_armor: optional boolean Whether to protect from web cache deception attacks, while allowing static assets to be cached. Link to this property

custom\_key: optional object {cookie, header, host, 2 more } Which components of the request are included or excluded from the cache key.

cookie: optional object {check\_presence, include } Which cookies to include in the cache key.

check\_presence: optional array of string A list of cookies to check for the presence of. The presence of these cookies is included in the cache key. Link to this property include: optional array of string A list of cookies to include in the cache key. Link to this property

Link to this property

header: optional object {check\_presence, contains, exclude\_origin, include } Which headers to include in the cache key.

check\_presence: optional array of string A list of headers to check for the presence of. The presence of these headers is included in the cache key. Link to this property contains: optional map\[array of string] A mapping of header names to a list of values. If a header is present in the request and contains any of the values provided, its value is included in the cache key. Link to this property exclude\_origin: optional boolean Whether to exclude the origin header in the cache key. Link to this property include: optional array of string A list of headers to include in the cache key. Link to this property

Link to this property

host: optional object {resolved } How to use the host in the cache key.

resolved: optional boolean Whether to use the resolved host in the cache key. Link to this property

Link to this property

query\_string: optional object {exclude, include } Which query string parameters to include in or exclude from the cache key.

exclude: optional object {all, list } Which query string parameters to exclude from the cache key.

all: optional true Whether to exclude all query string parameters from the cache key. Link to this property list: optional array of string A list of query string parameters to exclude from the cache key. Link to this property

Link to this property

include: optional object {all, list } Which query string parameters to include in the cache key.

all: optional true Whether to include all query string parameters in the cache key. Link to this property list: optional array of string A list of query string parameters to include in the cache key. Link to this property

Link to this property

Link to this property

user: optional object {device\_type, geo, lang } How to use characteristics of the request user agent in the cache key.

device\_type: optional boolean Whether to use the user agent’s device type in the cache key. Link to this property geo: optional boolean Whether to use the user agents’s country in the cache key. Link to this property lang: optional boolean Whether to use the user agent’s language in the cache key. Link to this property

Link to this property

Link to this property ignore\_query\_strings\_order: optional boolean Whether to treat requests with the same query parameters the same, regardless of the order those query parameters are in. Link to this property

Link to this property

cache\_reserve: optional object {eligible, minimum\_file\_size } Settings to determine whether the request’s response from origin is eligible for Cache Reserve (requires a Cache Reserve add-on plan).

eligible: boolean Whether Cache Reserve is enabled. If this is true and a request meets eligibility criteria, Cloudflare will write the resource to Cache Reserve. Link to this property minimum\_file\_size: optional number The minimum file size eligible for storage in Cache Reserve. minimum0 Link to this property

Link to this property

edge\_ttl: optional object {mode, default, status\_code\_ttl } How long the Cloudflare edge network should cache the response.

mode: "respect\_origin"or "bypass\_by\_default"or "override\_origin" The edge TTL mode.

One of the following: "respect\_origin" Link to this property "bypass\_by\_default" Link to this property "override\_origin" Link to this property

Link to this property default: optional number The edge TTL (in seconds) if you choose the “override\_origin” mode. minimum0 Link to this property

status\_code\_ttl: optional array of object {value, status\_code, status\_code\_range } A list of TTLs to apply to specific status codes or status code ranges.

value: number The time to cache the response for (in seconds). A value of 0 is equivalent to setting the cache control header with the value “no-cache”. A value of -1 is equivalent to setting the cache control header with the value of “no-store”. Link to this property status\_code: optional number A single status code to apply the TTL to. maximum999 minimum100 Link to this property

status\_code\_range: optional object {from, to } A range of status codes to apply the TTL to.

from: optional number The lower bound of the range. maximum999 minimum100 Link to this property to: optional number The upper bound of the range. maximum999 minimum100 Link to this property

Link to this property

Link to this property

Link to this property origin\_cache\_control: optional boolean Whether Cloudflare will aim to strictly adhere to RFC 7234. Link to this property origin\_error\_page\_passthru: optional boolean Whether to generate Cloudflare error pages for issues from the origin server. Link to this property

origin\_range\_requests: optional object {mode } Controls whether Cloudflare fetches a large asset from the origin as a series of range requests instead of one whole-body request.

mode: "on"or "off"or "default" Whether to use range requests. default is the behaviour the zone gets without this rule.

One of the following: "on" Link to this property "off" Link to this property "default" Link to this property

Link to this property

Link to this property read\_timeout: optional number A timeout value between two successive read operations to use for your origin server. Historically, the timeout value between two read options from Cloudflare to an origin server is 100 seconds. If you are attempting to reduce HTTP 524 errors because of timeouts from an origin server, try increasing this timeout value. maximum6000 minimum100 Link to this property respect\_strong\_etags: optional boolean Whether Cloudflare should respect strong ETag (entity tag) headers. If false, Cloudflare converts strong ETag headers to weak ETag headers. Link to this property

serve\_stale: optional object {disable\_stale\_while\_updating } When to serve stale content from cache.

disable\_stale\_while\_updating: optional boolean Whether Cloudflare should disable serving stale content while getting the latest content from the origin. Link to this property

Link to this property

shared\_dictionary: optional object {match\_pattern } Configuration for shared dictionary compression. When set, Cloudflare injects Use-As-Dictionary headers on matching cacheable responses.

match\_pattern: string URL pattern for the Use-As-Dictionary match field. This pattern specifies which URLs can use this response as a dictionary. maxLength1024 minLength1 Link to this property

Link to this property strip\_etags: optional boolean Whether to strip ETag headers from the origin response before caching. Link to this property strip\_last\_modified: optional boolean Whether to strip Last-Modified headers from the origin response before caching. Link to this property strip\_set\_cookie: optional boolean Whether to strip Set-Cookie headers from the origin response before caching. Link to this property

vary: optional object {default, headers } Controls how cached responses vary based on request headers. default is required by the API and applies to any Vary response header that does not have a per-header override.

default: optional object {action } Controls how response Vary headers without a per-header override contribute to the cache key.

action: "bypass"or "passthrough"or "normalize" How the header value is treated when building the cache key.

One of the following: "bypass" Link to this property "passthrough" Link to this property "normalize" Link to this property

Link to this property

Link to this property

headers: optional map\[object {action, languages, media\_types } ] A mapping of lowercase request header names to their vary configuration.

action: "bypass"or "passthrough"or "normalize" How the header value is treated when building the cache key.

One of the following: "bypass" Link to this property "passthrough" Link to this property "normalize" Link to this property

Link to this property languages: optional array of string The set of languages to normalize against. Only valid for the accept-language header. Link to this property media\_types: optional array of string The set of media types to normalize against. Only valid for the accept header. Link to this property

Link to this property

Link to this property

Link to this property categories: optional array of string The categories of the rule. Link to this property description: optional string An informative description of the rule. Link to this property enabled: optional boolean Link to this property

exposed\_credential\_check: optional object {password\_expression, username\_expression } Configuration for exposed credential checking.

password\_expression: string An expression that selects the password used in the credentials check. minLength1 Link to this property username\_expression: string An expression that selects the user ID used in the credentials check. minLength1 Link to this property

Link to this property expression: optional string The expression defining which traffic will match the rule. minLength1 Link to this property logging: optional Logging { enabled } An object configuring the rule’s logging behavior. Link to this property

ratelimit: optional object {characteristics, period, counting\_expression, 5 more } An object configuring the rule’s rate limit behavior.

characteristics: array of string Characteristics of the request on which the rate limit counter will be incremented. Link to this property period: number Period in seconds over which the counter is being incremented. minimum0 Link to this property counting\_expression: optional string An expression that defines when the rate limit counter should be incremented. It defaults to the same as the rule’s expression. minLength1 Link to this property mitigation\_timeout: optional number Period of time in seconds after which the action will be disabled following its first execution. Link to this property requests\_per\_period: optional number The threshold of requests per period after which the action will be executed for the first time. minimum1 Link to this property requests\_to\_origin: optional boolean Whether counting is only performed when an origin is reached. Link to this property score\_per\_period: optional number The score threshold per period for which the action will be executed the first time. Link to this property score\_response\_header\_name: optional string A response header name provided by the origin, which contains the score to increment rate limit counter with. minLength1 Link to this property

Link to this property ref: optional string The reference of the rule (the rule’s ID by default). minLength1 Link to this property

[Link to this property](<#(resource)%20rulesets.rules%20%3E%20(model)%20set_cache_settings_rule%20%3E%20(schema)>)

SetConfigRule object {last\_updated, version, id, 10 more }

last\_updated: string The timestamp of when the rule was last modified. formatdate-time Link to this property version: string The version of the rule. Link to this property id: optional string The unique ID of the rule. Link to this property action: optional "set\_config" The action to perform when the rule matches. Link to this property

action\_parameters: optional object {automatic\_https\_rewrites, autominify, bic, 21 more } The parameters configuring the rule’s action.

automatic\_https\_rewrites: optional boolean Whether to enable Automatic HTTPS Rewrites. Link to this property

autominify: optional object {css, html, js } Which file extensions to minify automatically.

css: optional boolean Whether to minify CSS files. Link to this property html: optional boolean Whether to minify HTML files. Link to this property js: optional boolean Whether to minify JavaScript files. Link to this property

Link to this property bic: optional boolean Whether to enable Browser Integrity Check (BIC). Link to this property content\_converter: optional boolean Whether to enable content conversion (e.g., HTML to Markdown). Link to this property Deprecateddisable\_apps: optional true Cloudflare Apps are deprected. Whether to disable Cloudflare Apps. Link to this property disable\_pay\_per\_crawl: optional true Whether to disable Pay Per Crawl. Link to this property disable\_rum: optional true Whether to disable Real User Monitoring (RUM). Link to this property disable\_zaraz: optional true Whether to disable Zaraz. Link to this property email\_obfuscation: optional boolean Whether to enable Email Obfuscation. Link to this property fonts: optional boolean Whether to enable Cloudflare Fonts. Link to this property hotlink\_protection: optional boolean Whether to enable Hotlink Protection. Link to this property Deprecatedmirage: optional boolean Mirage is deprecated. More information at https://developers.cloudflare.com/speed/optimization/images/mirage/. Whether to enable Mirage. Link to this property opportunistic\_encryption: optional boolean Whether to enable Opportunistic Encryption. Link to this property

polish: optional "off"or "lossless"or "lossy"or "webp" The Polish level to configure.

One of the following: "off" Link to this property "lossless" Link to this property "lossy" Link to this property "webp" Link to this property

Link to this property redirects\_for\_ai\_training: optional boolean Whether to redirect verified AI training crawlers to canonical URLs found in the HTML response. Link to this property

request\_body\_buffering: optional "none"or "standard"or "full" The request body buffering mode.

One of the following: "none" Link to this property "standard" Link to this property "full" Link to this property

Link to this property

response\_body\_buffering: optional "none"or "standard" The response body buffering mode.

One of the following: "none" Link to this property "standard" Link to this property

Link to this property rocket\_loader: optional boolean Whether to enable Rocket Loader. Link to this property

security\_level: optional "off"or "essentially\_off"or "low"or 3 more The Security Level to configure.

One of the following: "off" Link to this property "essentially\_off" Link to this property "low" Link to this property "medium" Link to this property "high" Link to this property "under\_attack" Link to this property

Link to this property server\_side\_excludes: optional boolean Whether to enable Server-Side Excludes. Link to this property

ssl: optional "off"or "flexible"or "full"or 2 more The SSL level to configure.

One of the following: "off" Link to this property "flexible" Link to this property "full" Link to this property "strict" Link to this property "origin\_pull" Link to this property

Link to this property Deprecatedsxg: optional boolean Signed Exchanges (SXG) is deprecated. Whether to enable Signed Exchanges (SXG). Link to this property webmcp\_enabled: optional boolean Whether to serve the WebMCP bridge script, which exposes the page’s tools to browser AI agents. Link to this property webmcp\_packs: optional array of string Bundled WebMCP tool packs to activate for matching requests. An empty array disables all packs. Omitting this parameter leaves the pack selection unchanged. Does not enable the WebMCP bridge itself. Non-empty selections require the WebMCP Configuration Rules entitlement. Link to this property

Link to this property categories: optional array of string The categories of the rule. Link to this property description: optional string An informative description of the rule. Link to this property enabled: optional boolean Link to this property

exposed\_credential\_check: optional object {password\_expression, username\_expression } Configuration for exposed credential checking.

password\_expression: string An expression that selects the password used in the credentials check. minLength1 Link to this property username\_expression: string An expression that selects the user ID used in the credentials check. minLength1 Link to this property

Link to this property expression: optional string The expression defining which traffic will match the rule. minLength1 Link to this property logging: optional Logging { enabled } An object configuring the rule’s logging behavior. Link to this property

ratelimit: optional object {characteristics, period, counting\_expression, 5 more } An object configuring the rule’s rate limit behavior.

characteristics: array of string Characteristics of the request on which the rate limit counter will be incremented. Link to this property period: number Period in seconds over which the counter is being incremented. minimum0 Link to this property counting\_expression: optional string An expression that defines when the rate limit counter should be incremented. It defaults to the same as the rule’s expression. minLength1 Link to this property mitigation\_timeout: optional number Period of time in seconds after which the action will be disabled following its first execution. Link to this property requests\_per\_period: optional number The threshold of requests per period after which the action will be executed for the first time. minimum1 Link to this property requests\_to\_origin: optional boolean Whether counting is only performed when an origin is reached. Link to this property score\_per\_period: optional number The score threshold per period for which the action will be executed the first time. Link to this property score\_response\_header\_name: optional string A response header name provided by the origin, which contains the score to increment rate limit counter with. minLength1 Link to this property

Link to this property ref: optional string The reference of the rule (the rule’s ID by default). minLength1 Link to this property

[Link to this property](<#(resource)%20rulesets.rules%20%3E%20(model)%20set_config_rule%20%3E%20(schema)>)

SkipRule object {last\_updated, version, id, 10 more }

last\_updated: string The timestamp of when the rule was last modified. formatdate-time Link to this property version: string The version of the rule. Link to this property id: optional string The unique ID of the rule. Link to this property action: optional "skip" The action to perform when the rule matches. Link to this property

action\_parameters: optional object {phase, phases, products, 3 more } The parameters configuring the rule’s action.

phase: optional "current" A phase to skip the execution of. This option is only compatible with the products option. Link to this property

phases: optional array of Phase A list of phases to skip the execution of. This option is incompatible with the rulesets option.

One of the following: "ddos\_l4" Link to this property "ddos\_l7" Link to this property "http\_config\_settings" Link to this property "http\_custom\_errors" Link to this property "http\_log\_custom\_fields" Link to this property "http\_ratelimit" Link to this property "http\_request\_cache\_settings" Link to this property "http\_request\_dynamic\_redirect" Link to this property "http\_request\_firewall\_custom" Link to this property "http\_request\_firewall\_managed" Link to this property "http\_request\_late\_transform" Link to this property "http\_request\_origin" Link to this property "http\_request\_redirect" Link to this property "http\_request\_sanitize" Link to this property "http\_request\_sbfm" Link to this property "http\_request\_transform" Link to this property "http\_response\_cache\_settings" Link to this property "http\_response\_compression" Link to this property "http\_response\_firewall\_managed" Link to this property "http\_response\_headers\_transform" Link to this property "magic\_transit" Link to this property "magic\_transit\_ids\_managed" Link to this property "magic\_transit\_managed" Link to this property "magic\_transit\_ratelimit" Link to this property

Link to this property

products: optional array of "bic"or "hot"or "rateLimit"or 4 more A list of legacy security products to skip the execution of.

One of the following: "bic" Link to this property "hot" Link to this property "rateLimit" Link to this property "securityLevel" Link to this property "uaBlock" Link to this property "waf" Link to this property "zoneLockdown" Link to this property

Link to this property rules: optional map\[array of string] A mapping of ruleset IDs to a list of rule IDs in that ruleset to skip the execution of. This option is incompatible with the ruleset option. Link to this property ruleset: optional "current" A ruleset to skip the execution of. This option is incompatible with the rulesets option. Link to this property rulesets: optional array of string A list of ruleset IDs to skip the execution of. This option is incompatible with the ruleset and phases options. Link to this property

Link to this property categories: optional array of string The categories of the rule. Link to this property description: optional string An informative description of the rule. Link to this property enabled: optional boolean Link to this property

exposed\_credential\_check: optional object {password\_expression, username\_expression } Configuration for exposed credential checking.

password\_expression: string An expression that selects the password used in the credentials check. minLength1 Link to this property username\_expression: string An expression that selects the user ID used in the credentials check. minLength1 Link to this property

Link to this property expression: optional string The expression defining which traffic will match the rule. minLength1 Link to this property logging: optional Logging { enabled } An object configuring the rule’s logging behavior. Link to this property

ratelimit: optional object {characteristics, period, counting\_expression, 5 more } An object configuring the rule’s rate limit behavior.

characteristics: array of string Characteristics of the request on which the rate limit counter will be incremented. Link to this property period: number Period in seconds over which the counter is being incremented. minimum0 Link to this property counting\_expression: optional string An expression that defines when the rate limit counter should be incremented. It defaults to the same as the rule’s expression. minLength1 Link to this property mitigation\_timeout: optional number Period of time in seconds after which the action will be disabled following its first execution. Link to this property requests\_per\_period: optional number The threshold of requests per period after which the action will be executed for the first time. minimum1 Link to this property requests\_to\_origin: optional boolean Whether counting is only performed when an origin is reached. Link to this property score\_per\_period: optional number The score threshold per period for which the action will be executed the first time. Link to this property score\_response\_header\_name: optional string A response header name provided by the origin, which contains the score to increment rate limit counter with. minLength1 Link to this property

Link to this property ref: optional string The reference of the rule (the rule’s ID by default). minLength1 Link to this property

[Link to this property](<#(resource)%20rulesets.rules%20%3E%20(model)%20skip_rule%20%3E%20(schema)>)

RuleCreateResponse = object {id, kind, last\_updated, 5 more } or unknown A result.

One of the following:

Ruleset object {id, kind, last\_updated, 5 more } A ruleset object.

id: string The unique ID of the ruleset. Link to this property kind: Kind The kind of the ruleset. Link to this property last\_updated: string The timestamp of when the ruleset was last modified. formatdate-time Link to this property name: string The human-readable name of the ruleset. minLength1 Link to this property phase: Phase The phase of the ruleset. Link to this property

rules: array of BlockRule { last\_updated, version, id, 10 more } or object {id, action, enabled, 10 more } or CompressResponseRule { last\_updated, version, id, 10 more } or 18 more The list of rules in the ruleset.

One of the following:

BlockRule = BlockRule { last\_updated, version, id, 10 more }

id: string Link to this property action: string Link to this property enabled: boolean Link to this property expression: string Link to this property ref: string Link to this property

Link to this property

ChallengeRule object {id, action, enabled, 10 more }

id: string The unique ID of the rule. Link to this property action: "challenge" The action to perform when the rule matches. Link to this property enabled: boolean Whether the rule should be executed. Link to this property expression: string The expression defining which traffic will match the rule. minLength1 Link to this property last\_updated: string The timestamp of when the rule was last modified. formatdate-time Link to this property ref: string The reference of the rule (the rule’s ID by default). minLength1 Link to this property version: string The version of the rule. Link to this property action\_parameters: optional unknown The parameters configuring the rule’s action. Link to this property categories: optional array of string The categories of the rule. Link to this property description: optional string An informative description of the rule. Link to this property

exposed\_credential\_check: optional object {password\_expression, username\_expression } Configuration for exposed credential checking.

password\_expression: string An expression that selects the password used in the credentials check. minLength1 Link to this property username\_expression: string An expression that selects the user ID used in the credentials check. minLength1 Link to this property

Link to this property logging: optional Logging { enabled } An object configuring the rule’s logging behavior. Link to this property

ratelimit: optional object {characteristics, period, counting\_expression, 5 more } An object configuring the rule’s rate limit behavior.

characteristics: array of string Characteristics of the request on which the rate limit counter will be incremented. Link to this property period: number Period in seconds over which the counter is being incremented. minimum0 Link to this property counting\_expression: optional string An expression that defines when the rate limit counter should be incremented. It defaults to the same as the rule’s expression. minLength1 Link to this property mitigation\_timeout: optional number Period of time in seconds after which the action will be disabled following its first execution. Link to this property requests\_per\_period: optional number The threshold of requests per period after which the action will be executed for the first time. minimum1 Link to this property requests\_to\_origin: optional boolean Whether counting is only performed when an origin is reached. Link to this property score\_per\_period: optional number The score threshold per period for which the action will be executed the first time. Link to this property score\_response\_header\_name: optional string A response header name provided by the origin, which contains the score to increment rate limit counter with. minLength1 Link to this property

Link to this property

Link to this property

ResponseCompressionRule = CompressResponseRule { last\_updated, version, id, 10 more }

id: string Link to this property action: string Link to this property enabled: boolean Link to this property expression: string Link to this property ref: string Link to this property

Link to this property

DDoSDynamicRule = DDoSDynamicRule { last\_updated, version, id, 10 more }

id: string Link to this property action: string Link to this property enabled: boolean Link to this property expression: string Link to this property ref: string Link to this property

Link to this property

ExecuteRule = ExecuteRule { last\_updated, version, id, 10 more }

id: string Link to this property action: string Link to this property enabled: boolean Link to this property expression: string Link to this property ref: string Link to this property

Link to this property

ForceConnectionCloseRule = ForceConnectionCloseRule { last\_updated, version, id, 10 more }

id: string Link to this property action: string Link to this property enabled: boolean Link to this property expression: string Link to this property ref: string Link to this property

Link to this property

JavaScriptChallengeRule object {id, action, enabled, 10 more }

id: string The unique ID of the rule. Link to this property action: "js\_challenge" The action to perform when the rule matches. Link to this property enabled: boolean Whether the rule should be executed. Link to this property expression: string The expression defining which traffic will match the rule. minLength1 Link to this property last\_updated: string The timestamp of when the rule was last modified. formatdate-time Link to this property ref: string The reference of the rule (the rule’s ID by default). minLength1 Link to this property version: string The version of the rule. Link to this property action\_parameters: optional unknown The parameters configuring the rule’s action. Link to this property categories: optional array of string The categories of the rule. Link to this property description: optional string An informative description of the rule. Link to this property

exposed\_credential\_check: optional object {password\_expression, username\_expression } Configuration for exposed credential checking.

password\_expression: string An expression that selects the password used in the credentials check. minLength1 Link to this property username\_expression: string An expression that selects the user ID used in the credentials check. minLength1 Link to this property

Link to this property logging: optional Logging { enabled } An object configuring the rule’s logging behavior. Link to this property

ratelimit: optional object {characteristics, period, counting\_expression, 5 more } An object configuring the rule’s rate limit behavior.

characteristics: array of string Characteristics of the request on which the rate limit counter will be incremented. Link to this property period: number Period in seconds over which the counter is being incremented. minimum0 Link to this property counting\_expression: optional string An expression that defines when the rate limit counter should be incremented. It defaults to the same as the rule’s expression. minLength1 Link to this property mitigation\_timeout: optional number Period of time in seconds after which the action will be disabled following its first execution. Link to this property requests\_per\_period: optional number The threshold of requests per period after which the action will be executed for the first time. minimum1 Link to this property requests\_to\_origin: optional boolean Whether counting is only performed when an origin is reached. Link to this property score\_per\_period: optional number The score threshold per period for which the action will be executed the first time. Link to this property score\_response\_header\_name: optional string A response header name provided by the origin, which contains the score to increment rate limit counter with. minLength1 Link to this property

Link to this property

Link to this property

LogRule = LogRule { last\_updated, version, id, 10 more }

id: string Link to this property action: string Link to this property enabled: boolean Link to this property expression: string Link to this property ref: string Link to this property

Link to this property

LogCustomFieldRule = LogCustomFieldRule { last\_updated, version, id, 10 more }

id: string Link to this property action: string Link to this property enabled: boolean Link to this property expression: string Link to this property ref: string Link to this property

Link to this property

ManagedChallengeRule = ManagedChallengeRule { last\_updated, version, id, 10 more }

id: string Link to this property action: string Link to this property enabled: boolean Link to this property expression: string Link to this property ref: string Link to this property

Link to this property

RedirectRule = RedirectRule { last\_updated, version, id, 10 more }

id: string Link to this property action: string Link to this property enabled: boolean Link to this property expression: string Link to this property ref: string Link to this property

Link to this property

RewriteRule = RewriteRule { last\_updated, version, id, 10 more }

id: string Link to this property action: string Link to this property enabled: boolean Link to this property expression: string Link to this property ref: string Link to this property

Link to this property

RouteRule = RouteRule { last\_updated, version, id, 10 more }

id: string Link to this property action: string Link to this property enabled: boolean Link to this property expression: string Link to this property ref: string Link to this property

Link to this property

ScoreRule = ScoreRule { last\_updated, version, id, 10 more }

id: string Link to this property action: string Link to this property enabled: boolean Link to this property expression: string Link to this property ref: string Link to this property

Link to this property

ServeErrorRule = ServeErrorRule { last\_updated, version, id, 10 more }

id: string Link to this property action: string Link to this property enabled: boolean Link to this property expression: string Link to this property ref: string Link to this property

Link to this property

SetCacheControlRule object {id, action, enabled, 10 more }

id: string The unique ID of the rule. Link to this property action: "set\_cache\_control" The action to perform when the rule matches. Link to this property enabled: boolean Link to this property expression: string The expression defining which traffic will match the rule. minLength1 Link to this property last\_updated: string The timestamp of when the rule was last modified. formatdate-time Link to this property ref: string The reference of the rule (the rule’s ID by default). minLength1 Link to this property version: string The version of the rule. Link to this property

action\_parameters: optional object {immutable, "max-age", "must-revalidate", 10 more } The parameters configuring the rule’s action.

immutable: optional object {operation, cloudflare\_only } or object {operation, cloudflare\_only } A cache-control directive configuration.

One of the following:

SetDirective object {operation, cloudflare\_only } Set the directive.

operation: "set"or "remove" The operation to perform on the cache-control directive.

One of the following: "set" Link to this property "remove" Link to this property

Link to this property cloudflare\_only: optional boolean Whether the directive should only be applied to the Cloudflare CDN cache. Link to this property

Link to this property

RemoveDirective object {operation, cloudflare\_only } Remove the directive.

operation: "set"or "remove" The operation to perform on the cache-control directive.

One of the following: "set" Link to this property "remove" Link to this property

Link to this property cloudflare\_only: optional boolean Whether the directive should only be applied to the Cloudflare CDN cache. Link to this property

Link to this property

Link to this property

"max-age": optional object {operation, value, cloudflare\_only } or object {operation, cloudflare\_only } A cache-control directive configuration that accepts a duration value in seconds.

One of the following:

SetDirective object {operation, value, cloudflare\_only } Set the directive with a duration value in seconds.

operation: "set"or "remove" The operation to perform on the cache-control directive.

One of the following: "set" Link to this property "remove" Link to this property

Link to this property value: number The duration value in seconds for the directive. minimum0 Link to this property cloudflare\_only: optional boolean Whether the directive should only be applied to the Cloudflare CDN cache. Link to this property

Link to this property

RemoveDirective object {operation, cloudflare\_only } Remove the directive.

operation: "set"or "remove" The operation to perform on the cache-control directive.

One of the following: "set" Link to this property "remove" Link to this property

Link to this property cloudflare\_only: optional boolean Whether the directive should only be applied to the Cloudflare CDN cache. Link to this property

Link to this property

Link to this property

"must-revalidate": optional object {operation, cloudflare\_only } or object {operation, cloudflare\_only } A cache-control directive configuration.

One of the following:

SetDirective object {operation, cloudflare\_only } Set the directive.

operation: "set"or "remove" The operation to perform on the cache-control directive.

One of the following: "set" Link to this property "remove" Link to this property

Link to this property cloudflare\_only: optional boolean Whether the directive should only be applied to the Cloudflare CDN cache. Link to this property

Link to this property

RemoveDirective object {operation, cloudflare\_only } Remove the directive.

operation: "set"or "remove" The operation to perform on the cache-control directive.

One of the following: "set" Link to this property "remove" Link to this property

Link to this property cloudflare\_only: optional boolean Whether the directive should only be applied to the Cloudflare CDN cache. Link to this property

Link to this property

Link to this property

"must-understand": optional object {operation, cloudflare\_only } or object {operation, cloudflare\_only } A cache-control directive configuration.

One of the following:

SetDirective object {operation, cloudflare\_only } Set the directive.

operation: "set"or "remove" The operation to perform on the cache-control directive.

One of the following: "set" Link to this property "remove" Link to this property

Link to this property cloudflare\_only: optional boolean Whether the directive should only be applied to the Cloudflare CDN cache. Link to this property

Link to this property

RemoveDirective object {operation, cloudflare\_only } Remove the directive.

operation: "set"or "remove" The operation to perform on the cache-control directive.

One of the following: "set" Link to this property "remove" Link to this property

Link to this property cloudflare\_only: optional boolean Whether the directive should only be applied to the Cloudflare CDN cache. Link to this property

Link to this property

Link to this property

"no-cache": optional object {operation, cloudflare\_only, qualifiers } or object {operation, cloudflare\_only } A cache-control directive configuration that accepts optional qualifiers (header names).

One of the following:

SetDirective object {operation, cloudflare\_only, qualifiers } Set the directive with optional qualifiers.

operation: "set"or "remove" The operation to perform on the cache-control directive.

One of the following: "set" Link to this property "remove" Link to this property

Link to this property cloudflare\_only: optional boolean Whether the directive should only be applied to the Cloudflare CDN cache. Link to this property qualifiers: optional array of string Optional list of header names to qualify the directive (e.g., for “private” or “no-cache” directives). Link to this property

Link to this property

RemoveDirective object {operation, cloudflare\_only } Remove the directive.

operation: "set"or "remove" The operation to perform on the cache-control directive.

One of the following: "set" Link to this property "remove" Link to this property

Link to this property cloudflare\_only: optional boolean Whether the directive should only be applied to the Cloudflare CDN cache. Link to this property

Link to this property

Link to this property

"no-store": optional object {operation, cloudflare\_only } or object {operation, cloudflare\_only } A cache-control directive configuration.

One of the following:

SetDirective object {operation, cloudflare\_only } Set the directive.

operation: "set"or "remove" The operation to perform on the cache-control directive.

One of the following: "set" Link to this property "remove" Link to this property

Link to this property cloudflare\_only: optional boolean Whether the directive should only be applied to the Cloudflare CDN cache. Link to this property

Link to this property

RemoveDirective object {operation, cloudflare\_only } Remove the directive.

operation: "set"or "remove" The operation to perform on the cache-control directive.

One of the following: "set" Link to this property "remove" Link to this property

Link to this property cloudflare\_only: optional boolean Whether the directive should only be applied to the Cloudflare CDN cache. Link to this property

Link to this property

Link to this property

"no-transform": optional object {operation, cloudflare\_only } or object {operation, cloudflare\_only } A cache-control directive configuration.

One of the following:

SetDirective object {operation, cloudflare\_only } Set the directive.

operation: "set"or "remove" The operation to perform on the cache-control directive.

One of the following: "set" Link to this property "remove" Link to this property

Link to this property cloudflare\_only: optional boolean Whether the directive should only be applied to the Cloudflare CDN cache. Link to this property

Link to this property

RemoveDirective object {operation, cloudflare\_only } Remove the directive.

operation: "set"or "remove" The operation to perform on the cache-control directive.

One of the following: "set" Link to this property "remove" Link to this property

Link to this property cloudflare\_only: optional boolean Whether the directive should only be applied to the Cloudflare CDN cache. Link to this property

Link to this property

Link to this property

private: optional object {operation, cloudflare\_only, qualifiers } or object {operation, cloudflare\_only } A cache-control directive configuration that accepts optional qualifiers (header names).

One of the following:

SetDirective object {operation, cloudflare\_only, qualifiers } Set the directive with optional qualifiers.

operation: "set"or "remove" The operation to perform on the cache-control directive.

One of the following: "set" Link to this property "remove" Link to this property

Link to this property cloudflare\_only: optional boolean Whether the directive should only be applied to the Cloudflare CDN cache. Link to this property qualifiers: optional array of string Optional list of header names to qualify the directive (e.g., for “private” or “no-cache” directives). Link to this property

Link to this property

RemoveDirective object {operation, cloudflare\_only } Remove the directive.

operation: "set"or "remove" The operation to perform on the cache-control directive.

One of the following: "set" Link to this property "remove" Link to this property

Link to this property cloudflare\_only: optional boolean Whether the directive should only be applied to the Cloudflare CDN cache. Link to this property

Link to this property

Link to this property

"proxy-revalidate": optional object {operation, cloudflare\_only } or object {operation, cloudflare\_only } A cache-control directive configuration.

One of the following:

SetDirective object {operation, cloudflare\_only } Set the directive.

operation: "set"or "remove" The operation to perform on the cache-control directive.

One of the following: "set" Link to this property "remove" Link to this property

Link to this property cloudflare\_only: optional boolean Whether the directive should only be applied to the Cloudflare CDN cache. Link to this property

Link to this property

RemoveDirective object {operation, cloudflare\_only } Remove the directive.

operation: "set"or "remove" The operation to perform on the cache-control directive.

One of the following: "set" Link to this property "remove" Link to this property

Link to this property cloudflare\_only: optional boolean Whether the directive should only be applied to the Cloudflare CDN cache. Link to this property

Link to this property

Link to this property

public: optional object {operation, cloudflare\_only } or object {operation, cloudflare\_only } A cache-control directive configuration.

One of the following:

SetDirective object {operation, cloudflare\_only } Set the directive.

operation: "set"or "remove" The operation to perform on the cache-control directive.

One of the following: "set" Link to this property "remove" Link to this property

Link to this property cloudflare\_only: optional boolean Whether the directive should only be applied to the Cloudflare CDN cache. Link to this property

Link to this property

RemoveDirective object {operation, cloudflare\_only } Remove the directive.

operation: "set"or "remove" The operation to perform on the cache-control directive.

One of the following: "set" Link to this property "remove" Link to this property

Link to this property cloudflare\_only: optional boolean Whether the directive should only be applied to the Cloudflare CDN cache. Link to this property

Link to this property

Link to this property

"s-maxage": optional object {operation, value, cloudflare\_only } or object {operation, cloudflare\_only } A cache-control directive configuration that accepts a duration value in seconds.

One of the following:

SetDirective object {operation, value, cloudflare\_only } Set the directive with a duration value in seconds.

operation: "set"or "remove" The operation to perform on the cache-control directive.

One of the following: "set" Link to this property "remove" Link to this property

Link to this property value: number The duration value in seconds for the directive. minimum0 Link to this property cloudflare\_only: optional boolean Whether the directive should only be applied to the Cloudflare CDN cache. Link to this property

Link to this property

RemoveDirective object {operation, cloudflare\_only } Remove the directive.

operation: "set"or "remove" The operation to perform on the cache-control directive.

One of the following: "set" Link to this property "remove" Link to this property

Link to this property cloudflare\_only: optional boolean Whether the directive should only be applied to the Cloudflare CDN cache. Link to this property

Link to this property

Link to this property

"stale-if-error": optional object {operation, value, cloudflare\_only } or object {operation, cloudflare\_only } A cache-control directive configuration that accepts a duration value in seconds.

One of the following:

SetDirective object {operation, value, cloudflare\_only } Set the directive with a duration value in seconds.

operation: "set"or "remove" The operation to perform on the cache-control directive.

One of the following: "set" Link to this property "remove" Link to this property

Link to this property value: number The duration value in seconds for the directive. minimum0 Link to this property cloudflare\_only: optional boolean Whether the directive should only be applied to the Cloudflare CDN cache. Link to this property

Link to this property

RemoveDirective object {operation, cloudflare\_only } Remove the directive.

operation: "set"or "remove" The operation to perform on the cache-control directive.

One of the following: "set" Link to this property "remove" Link to this property

Link to this property cloudflare\_only: optional boolean Whether the directive should only be applied to the Cloudflare CDN cache. Link to this property

Link to this property

Link to this property

"stale-while-revalidate": optional object {operation, value, cloudflare\_only } or object {operation, cloudflare\_only } A cache-control directive configuration that accepts a duration value in seconds.

One of the following:

SetDirective object {operation, value, cloudflare\_only } Set the directive with a duration value in seconds.

operation: "set"or "remove" The operation to perform on the cache-control directive.

One of the following: "set" Link to this property "remove" Link to this property

Link to this property value: number The duration value in seconds for the directive. minimum0 Link to this property cloudflare\_only: optional boolean Whether the directive should only be applied to the Cloudflare CDN cache. Link to this property

Link to this property

RemoveDirective object {operation, cloudflare\_only } Remove the directive.

operation: "set"or "remove" The operation to perform on the cache-control directive.

One of the following: "set" Link to this property "remove" Link to this property

Link to this property cloudflare\_only: optional boolean Whether the directive should only be applied to the Cloudflare CDN cache. Link to this property

Link to this property

Link to this property

Link to this property categories: optional array of string The categories of the rule. Link to this property description: optional string An informative description of the rule. Link to this property

exposed\_credential\_check: optional object {password\_expression, username\_expression } Configuration for exposed credential checking.

password\_expression: string An expression that selects the password used in the credentials check. minLength1 Link to this property username\_expression: string An expression that selects the user ID used in the credentials check. minLength1 Link to this property

Link to this property logging: optional Logging { enabled } An object configuring the rule’s logging behavior. Link to this property

ratelimit: optional object {characteristics, period, counting\_expression, 5 more } An object configuring the rule’s rate limit behavior.

characteristics: array of string Characteristics of the request on which the rate limit counter will be incremented. Link to this property period: number Period in seconds over which the counter is being incremented. minimum0 Link to this property counting\_expression: optional string An expression that defines when the rate limit counter should be incremented. It defaults to the same as the rule’s expression. minLength1 Link to this property mitigation\_timeout: optional number Period of time in seconds after which the action will be disabled following its first execution. Link to this property requests\_per\_period: optional number The threshold of requests per period after which the action will be executed for the first time. minimum1 Link to this property requests\_to\_origin: optional boolean Whether counting is only performed when an origin is reached. Link to this property score\_per\_period: optional number The score threshold per period for which the action will be executed the first time. Link to this property score\_response\_header\_name: optional string A response header name provided by the origin, which contains the score to increment rate limit counter with. minLength1 Link to this property

Link to this property

Link to this property

SetCacheSettingsRule = SetCacheSettingsRule { last\_updated, version, id, 10 more }

id: string Link to this property action: string Link to this property enabled: boolean Link to this property expression: string Link to this property ref: string Link to this property

Link to this property

SetCacheTagsRule object {id, action, enabled, 10 more }

id: string The unique ID of the rule. Link to this property action: "set\_cache\_tags" The action to perform when the rule matches. Link to this property enabled: boolean Link to this property expression: string The expression defining which traffic will match the rule. minLength1 Link to this property last\_updated: string The timestamp of when the rule was last modified. formatdate-time Link to this property ref: string The reference of the rule (the rule’s ID by default). minLength1 Link to this property version: string The version of the rule. Link to this property

action\_parameters: optional object {operation, values } or object {expression, operation } or object {operation, values } or 3 more The parameters configuring the rule’s action.

One of the following:

AddCacheTagsValues object {operation, values } Add cache tags using a list of values.

operation: "add"or "remove"or "set" The operation to perform on the cache tags.

One of the following: "add" Link to this property "remove" Link to this property "set" Link to this property

Link to this property values: array of string A list of cache tag values. Link to this property

Link to this property

AddCacheTagsExpression object {expression, operation } Add cache tags using an expression.

expression: string An expression that evaluates to an array of cache tag values. minLength1 Link to this property

operation: "add"or "remove"or "set" The operation to perform on the cache tags.

One of the following: "add" Link to this property "remove" Link to this property "set" Link to this property

Link to this property

Link to this property

RemoveCacheTagsValues object {operation, values } Remove cache tags using a list of values.

operation: "add"or "remove"or "set" The operation to perform on the cache tags.

One of the following: "add" Link to this property "remove" Link to this property "set" Link to this property

Link to this property values: array of string A list of cache tag values. Link to this property

Link to this property

RemoveCacheTagsExpression object {expression, operation } Remove cache tags using an expression.

expression: string An expression that evaluates to an array of cache tag values. minLength1 Link to this property

operation: "add"or "remove"or "set" The operation to perform on the cache tags.

One of the following: "add" Link to this property "remove" Link to this property "set" Link to this property

Link to this property

Link to this property

SetCacheTagsValues object {operation, values } Set cache tags using a list of values.

operation: "add"or "remove"or "set" The operation to perform on the cache tags.

One of the following: "add" Link to this property "remove" Link to this property "set" Link to this property

Link to this property values: array of string A list of cache tag values. Link to this property

Link to this property

SetCacheTagsExpression object {expression, operation } Set cache tags using an expression.

expression: string An expression that evaluates to an array of cache tag values. minLength1 Link to this property

operation: "add"or "remove"or "set" The operation to perform on the cache tags.

One of the following: "add" Link to this property "remove" Link to this property "set" Link to this property

Link to this property

Link to this property

Link to this property categories: optional array of string The categories of the rule. Link to this property description: optional string An informative description of the rule. Link to this property

exposed\_credential\_check: optional object {password\_expression, username\_expression } Configuration for exposed credential checking.

password\_expression: string An expression that selects the password used in the credentials check. minLength1 Link to this property username\_expression: string An expression that selects the user ID used in the credentials check. minLength1 Link to this property

Link to this property logging: optional Logging { enabled } An object configuring the rule’s logging behavior. Link to this property

ratelimit: optional object {characteristics, period, counting\_expression, 5 more } An object configuring the rule’s rate limit behavior.

characteristics: array of string Characteristics of the request on which the rate limit counter will be incremented. Link to this property period: number Period in seconds over which the counter is being incremented. minimum0 Link to this property counting\_expression: optional string An expression that defines when the rate limit counter should be incremented. It defaults to the same as the rule’s expression. minLength1 Link to this property mitigation\_timeout: optional number Period of time in seconds after which the action will be disabled following its first execution. Link to this property requests\_per\_period: optional number The threshold of requests per period after which the action will be executed for the first time. minimum1 Link to this property requests\_to\_origin: optional boolean Whether counting is only performed when an origin is reached. Link to this property score\_per\_period: optional number The score threshold per period for which the action will be executed the first time. Link to this property score\_response\_header\_name: optional string A response header name provided by the origin, which contains the score to increment rate limit counter with. minLength1 Link to this property

Link to this property

Link to this property

SetConfigurationRule = SetConfigRule { last\_updated, version, id, 10 more }

id: string Link to this property action: string Link to this property enabled: boolean Link to this property expression: string Link to this property ref: string Link to this property

Link to this property

SkipRule = SkipRule { last\_updated, version, id, 10 more }

id: string Link to this property action: string Link to this property enabled: boolean Link to this property expression: string Link to this property ref: string Link to this property

Link to this property

TransformResponseHTMLRule object {id, action, enabled, 10 more }

id: string The unique ID of the rule. Link to this property action: "transform\_response\_html" The action to perform when the rule matches. Link to this property enabled: boolean Link to this property expression: string The expression defining which traffic will match the rule. minLength1 Link to this property last\_updated: string The timestamp of when the rule was last modified. formatdate-time Link to this property ref: string The reference of the rule (the rule’s ID by default). minLength1 Link to this property version: string The version of the rule. Link to this property

action\_parameters: optional object {link\_maze } The parameters configuring the rule’s action.

link\_maze: unknown Enables the link maze transformation on the response. Link to this property

Link to this property categories: optional array of string The categories of the rule. Link to this property description: optional string An informative description of the rule. Link to this property

exposed\_credential\_check: optional object {password\_expression, username\_expression } Configuration for exposed credential checking.

password\_expression: string An expression that selects the password used in the credentials check. minLength1 Link to this property username\_expression: string An expression that selects the user ID used in the credentials check. minLength1 Link to this property

Link to this property logging: optional Logging { enabled } An object configuring the rule’s logging behavior. Link to this property

ratelimit: optional object {characteristics, period, counting\_expression, 5 more } An object configuring the rule’s rate limit behavior.

characteristics: array of string Characteristics of the request on which the rate limit counter will be incremented. Link to this property period: number Period in seconds over which the counter is being incremented. minimum0 Link to this property counting\_expression: optional string An expression that defines when the rate limit counter should be incremented. It defaults to the same as the rule’s expression. minLength1 Link to this property mitigation\_timeout: optional number Period of time in seconds after which the action will be disabled following its first execution. Link to this property requests\_per\_period: optional number The threshold of requests per period after which the action will be executed for the first time. minimum1 Link to this property requests\_to\_origin: optional boolean Whether counting is only performed when an origin is reached. Link to this property score\_per\_period: optional number The score threshold per period for which the action will be executed the first time. Link to this property score\_response\_header\_name: optional string A response header name provided by the origin, which contains the score to increment rate limit counter with. minLength1 Link to this property

Link to this property

Link to this property

Link to this property version: string The version of the ruleset. Link to this property description: optional string An informative description of the ruleset. Link to this property

Link to this property unknown Returned when dry\_run is true. Link to this property

[Link to this property](<#(resource)%20rulesets.rules%20%3E%20(model)%20rule_create_response%20%3E%20(schema)>)

RuleEditResponse = object {id, kind, last\_updated, 5 more } or unknown A result.

One of the following:

Ruleset object {id, kind, last\_updated, 5 more } A ruleset object.

id: string The unique ID of the ruleset. Link to this property kind: Kind The kind of the ruleset. Link to this property last\_updated: string The timestamp of when the ruleset was last modified. formatdate-time Link to this property name: string The human-readable name of the ruleset. minLength1 Link to this property phase: Phase The phase of the ruleset. Link to this property

rules: array of BlockRule { last\_updated, version, id, 10 more } or object {id, action, enabled, 10 more } or CompressResponseRule { last\_updated, version, id, 10 more } or 18 more The list of rules in the ruleset.

One of the following:

BlockRule = BlockRule { last\_updated, version, id, 10 more }

id: string Link to this property action: string Link to this property enabled: boolean Link to this property expression: string Link to this property ref: string Link to this property

Link to this property

ChallengeRule object {id, action, enabled, 10 more }

id: string The unique ID of the rule. Link to this property action: "challenge" The action to perform when the rule matches. Link to this property enabled: boolean Whether the rule should be executed. Link to this property expression: string The expression defining which traffic will match the rule. minLength1 Link to this property last\_updated: string The timestamp of when the rule was last modified. formatdate-time Link to this property ref: string The reference of the rule (the rule’s ID by default). minLength1 Link to this property version: string The version of the rule. Link to this property action\_parameters: optional unknown The parameters configuring the rule’s action. Link to this property categories: optional array of string The categories of the rule. Link to this property description: optional string An informative description of the rule. Link to this property

exposed\_credential\_check: optional object {password\_expression, username\_expression } Configuration for exposed credential checking.

password\_expression: string An expression that selects the password used in the credentials check. minLength1 Link to this property username\_expression: string An expression that selects the user ID used in the credentials check. minLength1 Link to this property

Link to this property logging: optional Logging { enabled } An object configuring the rule’s logging behavior. Link to this property

ratelimit: optional object {characteristics, period, counting\_expression, 5 more } An object configuring the rule’s rate limit behavior.

characteristics: array of string Characteristics of the request on which the rate limit counter will be incremented. Link to this property period: number Period in seconds over which the counter is being incremented. minimum0 Link to this property counting\_expression: optional string An expression that defines when the rate limit counter should be incremented. It defaults to the same as the rule’s expression. minLength1 Link to this property mitigation\_timeout: optional number Period of time in seconds after which the action will be disabled following its first execution. Link to this property requests\_per\_period: optional number The threshold of requests per period after which the action will be executed for the first time. minimum1 Link to this property requests\_to\_origin: optional boolean Whether counting is only performed when an origin is reached. Link to this property score\_per\_period: optional number The score threshold per period for which the action will be executed the first time. Link to this property score\_response\_header\_name: optional string A response header name provided by the origin, which contains the score to increment rate limit counter with. minLength1 Link to this property

Link to this property

Link to this property

ResponseCompressionRule = CompressResponseRule { last\_updated, version, id, 10 more }

id: string Link to this property action: string Link to this property enabled: boolean Link to this property expression: string Link to this property ref: string Link to this property

Link to this property

DDoSDynamicRule = DDoSDynamicRule { last\_updated, version, id, 10 more }

id: string Link to this property action: string Link to this property enabled: boolean Link to this property expression: string Link to this property ref: string Link to this property

Link to this property

ExecuteRule = ExecuteRule { last\_updated, version, id, 10 more }

id: string Link to this property action: string Link to this property enabled: boolean Link to this property expression: string Link to this property ref: string Link to this property

Link to this property

ForceConnectionCloseRule = ForceConnectionCloseRule { last\_updated, version, id, 10 more }

id: string Link to this property action: string Link to this property enabled: boolean Link to this property expression: string Link to this property ref: string Link to this property

Link to this property

JavaScriptChallengeRule object {id, action, enabled, 10 more }

id: string The unique ID of the rule. Link to this property action: "js\_challenge" The action to perform when the rule matches. Link to this property enabled: boolean Whether the rule should be executed. Link to this property expression: string The expression defining which traffic will match the rule. minLength1 Link to this property last\_updated: string The timestamp of when the rule was last modified. formatdate-time Link to this property ref: string The reference of the rule (the rule’s ID by default). minLength1 Link to this property version: string The version of the rule. Link to this property action\_parameters: optional unknown The parameters configuring the rule’s action. Link to this property categories: optional array of string The categories of the rule. Link to this property description: optional string An informative description of the rule. Link to this property

exposed\_credential\_check: optional object {password\_expression, username\_expression } Configuration for exposed credential checking.

password\_expression: string An expression that selects the password used in the credentials check. minLength1 Link to this property username\_expression: string An expression that selects the user ID used in the credentials check. minLength1 Link to this property

Link to this property logging: optional Logging { enabled } An object configuring the rule’s logging behavior. Link to this property

ratelimit: optional object {characteristics, period, counting\_expression, 5 more } An object configuring the rule’s rate limit behavior.

characteristics: array of string Characteristics of the request on which the rate limit counter will be incremented. Link to this property period: number Period in seconds over which the counter is being incremented. minimum0 Link to this property counting\_expression: optional string An expression that defines when the rate limit counter should be incremented. It defaults to the same as the rule’s expression. minLength1 Link to this property mitigation\_timeout: optional number Period of time in seconds after which the action will be disabled following its first execution. Link to this property requests\_per\_period: optional number The threshold of requests per period after which the action will be executed for the first time. minimum1 Link to this property requests\_to\_origin: optional boolean Whether counting is only performed when an origin is reached. Link to this property score\_per\_period: optional number The score threshold per period for which the action will be executed the first time. Link to this property score\_response\_header\_name: optional string A response header name provided by the origin, which contains the score to increment rate limit counter with. minLength1 Link to this property

Link to this property

Link to this property

LogRule = LogRule { last\_updated, version, id, 10 more }

id: string Link to this property action: string Link to this property enabled: boolean Link to this property expression: string Link to this property ref: string Link to this property

Link to this property

LogCustomFieldRule = LogCustomFieldRule { last\_updated, version, id, 10 more }

id: string Link to this property action: string Link to this property enabled: boolean Link to this property expression: string Link to this property ref: string Link to this property

Link to this property

ManagedChallengeRule = ManagedChallengeRule { last\_updated, version, id, 10 more }

id: string Link to this property action: string Link to this property enabled: boolean Link to this property expression: string Link to this property ref: string Link to this property

Link to this property

RedirectRule = RedirectRule { last\_updated, version, id, 10 more }

id: string Link to this property action: string Link to this property enabled: boolean Link to this property expression: string Link to this property ref: string Link to this property

Link to this property

RewriteRule = RewriteRule { last\_updated, version, id, 10 more }

id: string Link to this property action: string Link to this property enabled: boolean Link to this property expression: string Link to this property ref: string Link to this property

Link to this property

RouteRule = RouteRule { last\_updated, version, id, 10 more }

id: string Link to this property action: string Link to this property enabled: boolean Link to this property expression: string Link to this property ref: string Link to this property

Link to this property

ScoreRule = ScoreRule { last\_updated, version, id, 10 more }

id: string Link to this property action: string Link to this property enabled: boolean Link to this property expression: string Link to this property ref: string Link to this property

Link to this property

ServeErrorRule = ServeErrorRule { last\_updated, version, id, 10 more }

id: string Link to this property action: string Link to this property enabled: boolean Link to this property expression: string Link to this property ref: string Link to this property

Link to this property

SetCacheControlRule object {id, action, enabled, 10 more }

id: string The unique ID of the rule. Link to this property action: "set\_cache\_control" The action to perform when the rule matches. Link to this property enabled: boolean Link to this property expression: string The expression defining which traffic will match the rule. minLength1 Link to this property last\_updated: string The timestamp of when the rule was last modified. formatdate-time Link to this property ref: string The reference of the rule (the rule’s ID by default). minLength1 Link to this property version: string The version of the rule. Link to this property

action\_parameters: optional object {immutable, "max-age", "must-revalidate", 10 more } The parameters configuring the rule’s action.

immutable: optional object {operation, cloudflare\_only } or object {operation, cloudflare\_only } A cache-control directive configuration.

One of the following:

SetDirective object {operation, cloudflare\_only } Set the directive.

operation: "set"or "remove" The operation to perform on the cache-control directive.

One of the following: "set" Link to this property "remove" Link to this property

Link to this property cloudflare\_only: optional boolean Whether the directive should only be applied to the Cloudflare CDN cache. Link to this property

Link to this property

RemoveDirective object {operation, cloudflare\_only } Remove the directive.

operation: "set"or "remove" The operation to perform on the cache-control directive.

One of the following: "set" Link to this property "remove" Link to this property

Link to this property cloudflare\_only: optional boolean Whether the directive should only be applied to the Cloudflare CDN cache. Link to this property

Link to this property

Link to this property

"max-age": optional object {operation, value, cloudflare\_only } or object {operation, cloudflare\_only } A cache-control directive configuration that accepts a duration value in seconds.

One of the following:

SetDirective object {operation, value, cloudflare\_only } Set the directive with a duration value in seconds.

operation: "set"or "remove" The operation to perform on the cache-control directive.

One of the following: "set" Link to this property "remove" Link to this property

Link to this property value: number The duration value in seconds for the directive. minimum0 Link to this property cloudflare\_only: optional boolean Whether the directive should only be applied to the Cloudflare CDN cache. Link to this property

Link to this property

RemoveDirective object {operation, cloudflare\_only } Remove the directive.

operation: "set"or "remove" The operation to perform on the cache-control directive.

One of the following: "set" Link to this property "remove" Link to this property

Link to this property cloudflare\_only: optional boolean Whether the directive should only be applied to the Cloudflare CDN cache. Link to this property

Link to this property

Link to this property

"must-revalidate": optional object {operation, cloudflare\_only } or object {operation, cloudflare\_only } A cache-control directive configuration.

One of the following:

SetDirective object {operation, cloudflare\_only } Set the directive.

operation: "set"or "remove" The operation to perform on the cache-control directive.

One of the following: "set" Link to this property "remove" Link to this property

Link to this property cloudflare\_only: optional boolean Whether the directive should only be applied to the Cloudflare CDN cache. Link to this property

Link to this property

RemoveDirective object {operation, cloudflare\_only } Remove the directive.

operation: "set"or "remove" The operation to perform on the cache-control directive.

One of the following: "set" Link to this property "remove" Link to this property

Link to this property cloudflare\_only: optional boolean Whether the directive should only be applied to the Cloudflare CDN cache. Link to this property

Link to this property

Link to this property

"must-understand": optional object {operation, cloudflare\_only } or object {operation, cloudflare\_only } A cache-control directive configuration.

One of the following:

SetDirective object {operation, cloudflare\_only } Set the directive.

operation: "set"or "remove" The operation to perform on the cache-control directive.

One of the following: "set" Link to this property "remove" Link to this property

Link to this property cloudflare\_only: optional boolean Whether the directive should only be applied to the Cloudflare CDN cache. Link to this property

Link to this property

RemoveDirective object {operation, cloudflare\_only } Remove the directive.

operation: "set"or "remove" The operation to perform on the cache-control directive.

One of the following: "set" Link to this property "remove" Link to this property

Link to this property cloudflare\_only: optional boolean Whether the directive should only be applied to the Cloudflare CDN cache. Link to this property

Link to this property

Link to this property

"no-cache": optional object {operation, cloudflare\_only, qualifiers } or object {operation, cloudflare\_only } A cache-control directive configuration that accepts optional qualifiers (header names).

One of the following:

SetDirective object {operation, cloudflare\_only, qualifiers } Set the directive with optional qualifiers.

operation: "set"or "remove" The operation to perform on the cache-control directive.

One of the following: "set" Link to this property "remove" Link to this property

Link to this property cloudflare\_only: optional boolean Whether the directive should only be applied to the Cloudflare CDN cache. Link to this property qualifiers: optional array of string Optional list of header names to qualify the directive (e.g., for “private” or “no-cache” directives). Link to this property

Link to this property

RemoveDirective object {operation, cloudflare\_only } Remove the directive.

operation: "set"or "remove" The operation to perform on the cache-control directive.

One of the following: "set" Link to this property "remove" Link to this property

Link to this property cloudflare\_only: optional boolean Whether the directive should only be applied to the Cloudflare CDN cache. Link to this property

Link to this property

Link to this property

"no-store": optional object {operation, cloudflare\_only } or object {operation, cloudflare\_only } A cache-control directive configuration.

One of the following:

SetDirective object {operation, cloudflare\_only } Set the directive.

operation: "set"or "remove" The operation to perform on the cache-control directive.

One of the following: "set" Link to this property "remove" Link to this property

Link to this property cloudflare\_only: optional boolean Whether the directive should only be applied to the Cloudflare CDN cache. Link to this property

Link to this property

RemoveDirective object {operation, cloudflare\_only } Remove the directive.

operation: "set"or "remove" The operation to perform on the cache-control directive.

One of the following: "set" Link to this property "remove" Link to this property

Link to this property cloudflare\_only: optional boolean Whether the directive should only be applied to the Cloudflare CDN cache. Link to this property

Link to this property

Link to this property

"no-transform": optional object {operation, cloudflare\_only } or object {operation, cloudflare\_only } A cache-control directive configuration.

One of the following:

SetDirective object {operation, cloudflare\_only } Set the directive.

operation: "set"or "remove" The operation to perform on the cache-control directive.

One of the following: "set" Link to this property "remove" Link to this property

Link to this property cloudflare\_only: optional boolean Whether the directive should only be applied to the Cloudflare CDN cache. Link to this property

Link to this property

RemoveDirective object {operation, cloudflare\_only } Remove the directive.

operation: "set"or "remove" The operation to perform on the cache-control directive.

One of the following: "set" Link to this property "remove" Link to this property

Link to this property cloudflare\_only: optional boolean Whether the directive should only be applied to the Cloudflare CDN cache. Link to this property

Link to this property

Link to this property

private: optional object {operation, cloudflare\_only, qualifiers } or object {operation, cloudflare\_only } A cache-control directive configuration that accepts optional qualifiers (header names).

One of the following:

SetDirective object {operation, cloudflare\_only, qualifiers } Set the directive with optional qualifiers.

operation: "set"or "remove" The operation to perform on the cache-control directive.

One of the following: "set" Link to this property "remove" Link to this property

Link to this property cloudflare\_only: optional boolean Whether the directive should only be applied to the Cloudflare CDN cache. Link to this property qualifiers: optional array of string Optional list of header names to qualify the directive (e.g., for “private” or “no-cache” directives). Link to this property

Link to this property

RemoveDirective object {operation, cloudflare\_only } Remove the directive.

operation: "set"or "remove" The operation to perform on the cache-control directive.

One of the following: "set" Link to this property "remove" Link to this property

Link to this property cloudflare\_only: optional boolean Whether the directive should only be applied to the Cloudflare CDN cache. Link to this property

Link to this property

Link to this property

"proxy-revalidate": optional object {operation, cloudflare\_only } or object {operation, cloudflare\_only } A cache-control directive configuration.

One of the following:

SetDirective object {operation, cloudflare\_only } Set the directive.

operation: "set"or "remove" The operation to perform on the cache-control directive.

One of the following: "set" Link to this property "remove" Link to this property

Link to this property cloudflare\_only: optional boolean Whether the directive should only be applied to the Cloudflare CDN cache. Link to this property

Link to this property

RemoveDirective object {operation, cloudflare\_only } Remove the directive.

operation: "set"or "remove" The operation to perform on the cache-control directive.

One of the following: "set" Link to this property "remove" Link to this property

Link to this property cloudflare\_only: optional boolean Whether the directive should only be applied to the Cloudflare CDN cache. Link to this property

Link to this property

Link to this property

public: optional object {operation, cloudflare\_only } or object {operation, cloudflare\_only } A cache-control directive configuration.

One of the following:

SetDirective object {operation, cloudflare\_only } Set the directive.

operation: "set"or "remove" The operation to perform on the cache-control directive.

One of the following: "set" Link to this property "remove" Link to this property

Link to this property cloudflare\_only: optional boolean Whether the directive should only be applied to the Cloudflare CDN cache. Link to this property

Link to this property

RemoveDirective object {operation, cloudflare\_only } Remove the directive.

operation: "set"or "remove" The operation to perform on the cache-control directive.

One of the following: "set" Link to this property "remove" Link to this property

Link to this property cloudflare\_only: optional boolean Whether the directive should only be applied to the Cloudflare CDN cache. Link to this property

Link to this property

Link to this property

"s-maxage": optional object {operation, value, cloudflare\_only } or object {operation, cloudflare\_only } A cache-control directive configuration that accepts a duration value in seconds.

One of the following:

SetDirective object {operation, value, cloudflare\_only } Set the directive with a duration value in seconds.

operation: "set"or "remove" The operation to perform on the cache-control directive.

One of the following: "set" Link to this property "remove" Link to this property

Link to this property value: number The duration value in seconds for the directive. minimum0 Link to this property cloudflare\_only: optional boolean Whether the directive should only be applied to the Cloudflare CDN cache. Link to this property

Link to this property

RemoveDirective object {operation, cloudflare\_only } Remove the directive.

operation: "set"or "remove" The operation to perform on the cache-control directive.

One of the following: "set" Link to this property "remove" Link to this property

Link to this property cloudflare\_only: optional boolean Whether the directive should only be applied to the Cloudflare CDN cache. Link to this property

Link to this property

Link to this property

"stale-if-error": optional object {operation, value, cloudflare\_only } or object {operation, cloudflare\_only } A cache-control directive configuration that accepts a duration value in seconds.

One of the following:

SetDirective object {operation, value, cloudflare\_only } Set the directive with a duration value in seconds.

operation: "set"or "remove" The operation to perform on the cache-control directive.

One of the following: "set" Link to this property "remove" Link to this property

Link to this property value: number The duration value in seconds for the directive. minimum0 Link to this property cloudflare\_only: optional boolean Whether the directive should only be applied to the Cloudflare CDN cache. Link to this property

Link to this property

RemoveDirective object {operation, cloudflare\_only } Remove the directive.

operation: "set"or "remove" The operation to perform on the cache-control directive.

One of the following: "set" Link to this property "remove" Link to this property

Link to this property cloudflare\_only: optional boolean Whether the directive should only be applied to the Cloudflare CDN cache. Link to this property

Link to this property

Link to this property

"stale-while-revalidate": optional object {operation, value, cloudflare\_only } or object {operation, cloudflare\_only } A cache-control directive configuration that accepts a duration value in seconds.

One of the following:

SetDirective object {operation, value, cloudflare\_only } Set the directive with a duration value in seconds.

operation: "set"or "remove" The operation to perform on the cache-control directive.

One of the following: "set" Link to this property "remove" Link to this property

Link to this property value: number The duration value in seconds for the directive. minimum0 Link to this property cloudflare\_only: optional boolean Whether the directive should only be applied to the Cloudflare CDN cache. Link to this property

Link to this property

RemoveDirective object {operation, cloudflare\_only } Remove the directive.

operation: "set"or "remove" The operation to perform on the cache-control directive.

One of the following: "set" Link to this property "remove" Link to this property

Link to this property cloudflare\_only: optional boolean Whether the directive should only be applied to the Cloudflare CDN cache. Link to this property

Link to this property

Link to this property

Link to this property categories: optional array of string The categories of the rule. Link to this property description: optional string An informative description of the rule. Link to this property

exposed\_credential\_check: optional object {password\_expression, username\_expression } Configuration for exposed credential checking.

password\_expression: string An expression that selects the password used in the credentials check. minLength1 Link to this property username\_expression: string An expression that selects the user ID used in the credentials check. minLength1 Link to this property

Link to this property logging: optional Logging { enabled } An object configuring the rule’s logging behavior. Link to this property

ratelimit: optional object {characteristics, period, counting\_expression, 5 more } An object configuring the rule’s rate limit behavior.

characteristics: array of string Characteristics of the request on which the rate limit counter will be incremented. Link to this property period: number Period in seconds over which the counter is being incremented. minimum0 Link to this property counting\_expression: optional string An expression that defines when the rate limit counter should be incremented. It defaults to the same as the rule’s expression. minLength1 Link to this property mitigation\_timeout: optional number Period of time in seconds after which the action will be disabled following its first execution. Link to this property requests\_per\_period: optional number The threshold of requests per period after which the action will be executed for the first time. minimum1 Link to this property requests\_to\_origin: optional boolean Whether counting is only performed when an origin is reached. Link to this property score\_per\_period: optional number The score threshold per period for which the action will be executed the first time. Link to this property score\_response\_header\_name: optional string A response header name provided by the origin, which contains the score to increment rate limit counter with. minLength1 Link to this property

Link to this property

Link to this property

SetCacheSettingsRule = SetCacheSettingsRule { last\_updated, version, id, 10 more }

id: string Link to this property action: string Link to this property enabled: boolean Link to this property expression: string Link to this property ref: string Link to this property

Link to this property

SetCacheTagsRule object {id, action, enabled, 10 more }

id: string The unique ID of the rule. Link to this property action: "set\_cache\_tags" The action to perform when the rule matches. Link to this property enabled: boolean Link to this property expression: string The expression defining which traffic will match the rule. minLength1 Link to this property last\_updated: string The timestamp of when the rule was last modified. formatdate-time Link to this property ref: string The reference of the rule (the rule’s ID by default). minLength1 Link to this property version: string The version of the rule. Link to this property

action\_parameters: optional object {operation, values } or object {expression, operation } or object {operation, values } or 3 more The parameters configuring the rule’s action.

One of the following:

AddCacheTagsValues object {operation, values } Add cache tags using a list of values.

operation: "add"or "remove"or "set" The operation to perform on the cache tags.

One of the following: "add" Link to this property "remove" Link to this property "set" Link to this property

Link to this property values: array of string A list of cache tag values. Link to this property

Link to this property

AddCacheTagsExpression object {expression, operation } Add cache tags using an expression.

expression: string An expression that evaluates to an array of cache tag values. minLength1 Link to this property

operation: "add"or "remove"or "set" The operation to perform on the cache tags.

One of the following: "add" Link to this property "remove" Link to this property "set" Link to this property

Link to this property

Link to this property

RemoveCacheTagsValues object {operation, values } Remove cache tags using a list of values.

operation: "add"or "remove"or "set" The operation to perform on the cache tags.

One of the following: "add" Link to this property "remove" Link to this property "set" Link to this property

Link to this property values: array of string A list of cache tag values. Link to this property

Link to this property

RemoveCacheTagsExpression object {expression, operation } Remove cache tags using an expression.

expression: string An expression that evaluates to an array of cache tag values. minLength1 Link to this property

operation: "add"or "remove"or "set" The operation to perform on the cache tags.

One of the following: "add" Link to this property "remove" Link to this property "set" Link to this property

Link to this property

Link to this property

SetCacheTagsValues object {operation, values } Set cache tags using a list of values.

operation: "add"or "remove"or "set" The operation to perform on the cache tags.

One of the following: "add" Link to this property "remove" Link to this property "set" Link to this property

Link to this property values: array of string A list of cache tag values. Link to this property

Link to this property

SetCacheTagsExpression object {expression, operation } Set cache tags using an expression.

expression: string An expression that evaluates to an array of cache tag values. minLength1 Link to this property

operation: "add"or "remove"or "set" The operation to perform on the cache tags.

One of the following: "add" Link to this property "remove" Link to this property "set" Link to this property

Link to this property

Link to this property

Link to this property categories: optional array of string The categories of the rule. Link to this property description: optional string An informative description of the rule. Link to this property

exposed\_credential\_check: optional object {password\_expression, username\_expression } Configuration for exposed credential checking.

password\_expression: string An expression that selects the password used in the credentials check. minLength1 Link to this property username\_expression: string An expression that selects the user ID used in the credentials check. minLength1 Link to this property

Link to this property logging: optional Logging { enabled } An object configuring the rule’s logging behavior. Link to this property

ratelimit: optional object {characteristics, period, counting\_expression, 5 more } An object configuring the rule’s rate limit behavior.

characteristics: array of string Characteristics of the request on which the rate limit counter will be incremented. Link to this property period: number Period in seconds over which the counter is being incremented. minimum0 Link to this property counting\_expression: optional string An expression that defines when the rate limit counter should be incremented. It defaults to the same as the rule’s expression. minLength1 Link to this property mitigation\_timeout: optional number Period of time in seconds after which the action will be disabled following its first execution. Link to this property requests\_per\_period: optional number The threshold of requests per period after which the action will be executed for the first time. minimum1 Link to this property requests\_to\_origin: optional boolean Whether counting is only performed when an origin is reached. Link to this property score\_per\_period: optional number The score threshold per period for which the action will be executed the first time. Link to this property score\_response\_header\_name: optional string A response header name provided by the origin, which contains the score to increment rate limit counter with. minLength1 Link to this property

Link to this property

Link to this property

SetConfigurationRule = SetConfigRule { last\_updated, version, id, 10 more }

id: string Link to this property action: string Link to this property enabled: boolean Link to this property expression: string Link to this property ref: string Link to this property

Link to this property

SkipRule = SkipRule { last\_updated, version, id, 10 more }

id: string Link to this property action: string Link to this property enabled: boolean Link to this property expression: string Link to this property ref: string Link to this property

Link to this property

TransformResponseHTMLRule object {id, action, enabled, 10 more }

id: string The unique ID of the rule. Link to this property action: "transform\_response\_html" The action to perform when the rule matches. Link to this property enabled: boolean Link to this property expression: string The expression defining which traffic will match the rule. minLength1 Link to this property last\_updated: string The timestamp of when the rule was last modified. formatdate-time Link to this property ref: string The reference of the rule (the rule’s ID by default). minLength1 Link to this property version: string The version of the rule. Link to this property

action\_parameters: optional object {link\_maze } The parameters configuring the rule’s action.

link\_maze: unknown Enables the link maze transformation on the response. Link to this property

Link to this property categories: optional array of string The categories of the rule. Link to this property description: optional string An informative description of the rule. Link to this property

exposed\_credential\_check: optional object {password\_expression, username\_expression } Configuration for exposed credential checking.

password\_expression: string An expression that selects the password used in the credentials check. minLength1 Link to this property username\_expression: string An expression that selects the user ID used in the credentials check. minLength1 Link to this property

Link to this property logging: optional Logging { enabled } An object configuring the rule’s logging behavior. Link to this property

ratelimit: optional object {characteristics, period, counting\_expression, 5 more } An object configuring the rule’s rate limit behavior.

characteristics: array of string Characteristics of the request on which the rate limit counter will be incremented. Link to this property period: number Period in seconds over which the counter is being incremented. minimum0 Link to this property counting\_expression: optional string An expression that defines when the rate limit counter should be incremented. It defaults to the same as the rule’s expression. minLength1 Link to this property mitigation\_timeout: optional number Period of time in seconds after which the action will be disabled following its first execution. Link to this property requests\_per\_period: optional number The threshold of requests per period after which the action will be executed for the first time. minimum1 Link to this property requests\_to\_origin: optional boolean Whether counting is only performed when an origin is reached. Link to this property score\_per\_period: optional number The score threshold per period for which the action will be executed the first time. Link to this property score\_response\_header\_name: optional string A response header name provided by the origin, which contains the score to increment rate limit counter with. minLength1 Link to this property

Link to this property

Link to this property

Link to this property version: string The version of the ruleset. Link to this property description: optional string An informative description of the ruleset. Link to this property

Link to this property unknown Returned when dry\_run is true. Link to this property

[Link to this property](<#(resource)%20rulesets.rules%20%3E%20(model)%20rule_edit_response%20%3E%20(schema)>)

RuleDeleteResponse = object {id, kind, last\_updated, 5 more } or unknown A result.

One of the following:

Ruleset object {id, kind, last\_updated, 5 more } A ruleset object.

id: string The unique ID of the ruleset. Link to this property kind: Kind The kind of the ruleset. Link to this property last\_updated: string The timestamp of when the ruleset was last modified. formatdate-time Link to this property name: string The human-readable name of the ruleset. minLength1 Link to this property phase: Phase The phase of the ruleset. Link to this property

rules: array of BlockRule { last\_updated, version, id, 10 more } or object {id, action, enabled, 10 more } or CompressResponseRule { last\_updated, version, id, 10 more } or 18 more The list of rules in the ruleset.

One of the following:

BlockRule = BlockRule { last\_updated, version, id, 10 more }

id: string Link to this property action: string Link to this property enabled: boolean Link to this property expression: string Link to this property ref: string Link to this property

Link to this property

ChallengeRule object {id, action, enabled, 10 more }

id: string The unique ID of the rule. Link to this property action: "challenge" The action to perform when the rule matches. Link to this property enabled: boolean Whether the rule should be executed. Link to this property expression: string The expression defining which traffic will match the rule. minLength1 Link to this property last\_updated: string The timestamp of when the rule was last modified. formatdate-time Link to this property ref: string The reference of the rule (the rule’s ID by default). minLength1 Link to this property version: string The version of the rule. Link to this property action\_parameters: optional unknown The parameters configuring the rule’s action. Link to this property categories: optional array of string The categories of the rule. Link to this property description: optional string An informative description of the rule. Link to this property

exposed\_credential\_check: optional object {password\_expression, username\_expression } Configuration for exposed credential checking.

password\_expression: string An expression that selects the password used in the credentials check. minLength1 Link to this property username\_expression: string An expression that selects the user ID used in the credentials check. minLength1 Link to this property

Link to this property logging: optional Logging { enabled } An object configuring the rule’s logging behavior. Link to this property

ratelimit: optional object {characteristics, period, counting\_expression, 5 more } An object configuring the rule’s rate limit behavior.

characteristics: array of string Characteristics of the request on which the rate limit counter will be incremented. Link to this property period: number Period in seconds over which the counter is being incremented. minimum0 Link to this property counting\_expression: optional string An expression that defines when the rate limit counter should be incremented. It defaults to the same as the rule’s expression. minLength1 Link to this property mitigation\_timeout: optional number Period of time in seconds after which the action will be disabled following its first execution. Link to this property requests\_per\_period: optional number The threshold of requests per period after which the action will be executed for the first time. minimum1 Link to this property requests\_to\_origin: optional boolean Whether counting is only performed when an origin is reached. Link to this property score\_per\_period: optional number The score threshold per period for which the action will be executed the first time. Link to this property score\_response\_header\_name: optional string A response header name provided by the origin, which contains the score to increment rate limit counter with. minLength1 Link to this property

Link to this property

Link to this property

ResponseCompressionRule = CompressResponseRule { last\_updated, version, id, 10 more }

id: string Link to this property action: string Link to this property enabled: boolean Link to this property expression: string Link to this property ref: string Link to this property

Link to this property

DDoSDynamicRule = DDoSDynamicRule { last\_updated, version, id, 10 more }

id: string Link to this property action: string Link to this property enabled: boolean Link to this property expression: string Link to this property ref: string Link to this property

Link to this property

ExecuteRule = ExecuteRule { last\_updated, version, id, 10 more }

id: string Link to this property action: string Link to this property enabled: boolean Link to this property expression: string Link to this property ref: string Link to this property

Link to this property

ForceConnectionCloseRule = ForceConnectionCloseRule { last\_updated, version, id, 10 more }

id: string Link to this property action: string Link to this property enabled: boolean Link to this property expression: string Link to this property ref: string Link to this property

Link to this property

JavaScriptChallengeRule object {id, action, enabled, 10 more }

id: string The unique ID of the rule. Link to this property action: "js\_challenge" The action to perform when the rule matches. Link to this property enabled: boolean Whether the rule should be executed. Link to this property expression: string The expression defining which traffic will match the rule. minLength1 Link to this property last\_updated: string The timestamp of when the rule was last modified. formatdate-time Link to this property ref: string The reference of the rule (the rule’s ID by default). minLength1 Link to this property version: string The version of the rule. Link to this property action\_parameters: optional unknown The parameters configuring the rule’s action. Link to this property categories: optional array of string The categories of the rule. Link to this property description: optional string An informative description of the rule. Link to this property

exposed\_credential\_check: optional object {password\_expression, username\_expression } Configuration for exposed credential checking.

password\_expression: string An expression that selects the password used in the credentials check. minLength1 Link to this property username\_expression: string An expression that selects the user ID used in the credentials check. minLength1 Link to this property

Link to this property logging: optional Logging { enabled } An object configuring the rule’s logging behavior. Link to this property

ratelimit: optional object {characteristics, period, counting\_expression, 5 more } An object configuring the rule’s rate limit behavior.

characteristics: array of string Characteristics of the request on which the rate limit counter will be incremented. Link to this property period: number Period in seconds over which the counter is being incremented. minimum0 Link to this property counting\_expression: optional string An expression that defines when the rate limit counter should be incremented. It defaults to the same as the rule’s expression. minLength1 Link to this property mitigation\_timeout: optional number Period of time in seconds after which the action will be disabled following its first execution. Link to this property requests\_per\_period: optional number The threshold of requests per period after which the action will be executed for the first time. minimum1 Link to this property requests\_to\_origin: optional boolean Whether counting is only performed when an origin is reached. Link to this property score\_per\_period: optional number The score threshold per period for which the action will be executed the first time. Link to this property score\_response\_header\_name: optional string A response header name provided by the origin, which contains the score to increment rate limit counter with. minLength1 Link to this property

Link to this property

Link to this property

LogRule = LogRule { last\_updated, version, id, 10 more }

id: string Link to this property action: string Link to this property enabled: boolean Link to this property expression: string Link to this property ref: string Link to this property

Link to this property

LogCustomFieldRule = LogCustomFieldRule { last\_updated, version, id, 10 more }

id: string Link to this property action: string Link to this property enabled: boolean Link to this property expression: string Link to this property ref: string Link to this property

Link to this property

ManagedChallengeRule = ManagedChallengeRule { last\_updated, version, id, 10 more }

id: string Link to this property action: string Link to this property enabled: boolean Link to this property expression: string Link to this property ref: string Link to this property

Link to this property

RedirectRule = RedirectRule { last\_updated, version, id, 10 more }

id: string Link to this property action: string Link to this property enabled: boolean Link to this property expression: string Link to this property ref: string Link to this property

Link to this property

RewriteRule = RewriteRule { last\_updated, version, id, 10 more }

id: string Link to this property action: string Link to this property enabled: boolean Link to this property expression: string Link to this property ref: string Link to this property

Link to this property

RouteRule = RouteRule { last\_updated, version, id, 10 more }

id: string Link to this property action: string Link to this property enabled: boolean Link to this property expression: string Link to this property ref: string Link to this property

Link to this property

ScoreRule = ScoreRule { last\_updated, version, id, 10 more }

id: string Link to this property action: string Link to this property enabled: boolean Link to this property expression: string Link to this property ref: string Link to this property

Link to this property

ServeErrorRule = ServeErrorRule { last\_updated, version, id, 10 more }

id: string Link to this property action: string Link to this property enabled: boolean Link to this property expression: string Link to this property ref: string Link to this property

Link to this property

SetCacheControlRule object {id, action, enabled, 10 more }

id: string The unique ID of the rule. Link to this property action: "set\_cache\_control" The action to perform when the rule matches. Link to this property enabled: boolean Link to this property expression: string The expression defining which traffic will match the rule. minLength1 Link to this property last\_updated: string The timestamp of when the rule was last modified. formatdate-time Link to this property ref: string The reference of the rule (the rule’s ID by default). minLength1 Link to this property version: string The version of the rule. Link to this property

action\_parameters: optional object {immutable, "max-age", "must-revalidate", 10 more } The parameters configuring the rule’s action.

immutable: optional object {operation, cloudflare\_only } or object {operation, cloudflare\_only } A cache-control directive configuration.

One of the following:

SetDirective object {operation, cloudflare\_only } Set the directive.

operation: "set"or "remove" The operation to perform on the cache-control directive.

One of the following: "set" Link to this property "remove" Link to this property

Link to this property cloudflare\_only: optional boolean Whether the directive should only be applied to the Cloudflare CDN cache. Link to this property

Link to this property

RemoveDirective object {operation, cloudflare\_only } Remove the directive.

operation: "set"or "remove" The operation to perform on the cache-control directive.

One of the following: "set" Link to this property "remove" Link to this property

Link to this property cloudflare\_only: optional boolean Whether the directive should only be applied to the Cloudflare CDN cache. Link to this property

Link to this property

Link to this property

"max-age": optional object {operation, value, cloudflare\_only } or object {operation, cloudflare\_only } A cache-control directive configuration that accepts a duration value in seconds.

One of the following:

SetDirective object {operation, value, cloudflare\_only } Set the directive with a duration value in seconds.

operation: "set"or "remove" The operation to perform on the cache-control directive.

One of the following: "set" Link to this property "remove" Link to this property

Link to this property value: number The duration value in seconds for the directive. minimum0 Link to this property cloudflare\_only: optional boolean Whether the directive should only be applied to the Cloudflare CDN cache. Link to this property

Link to this property

RemoveDirective object {operation, cloudflare\_only } Remove the directive.

operation: "set"or "remove" The operation to perform on the cache-control directive.

One of the following: "set" Link to this property "remove" Link to this property

Link to this property cloudflare\_only: optional boolean Whether the directive should only be applied to the Cloudflare CDN cache. Link to this property

Link to this property

Link to this property

"must-revalidate": optional object {operation, cloudflare\_only } or object {operation, cloudflare\_only } A cache-control directive configuration.

One of the following:

SetDirective object {operation, cloudflare\_only } Set the directive.

operation: "set"or "remove" The operation to perform on the cache-control directive.

One of the following: "set" Link to this property "remove" Link to this property

Link to this property cloudflare\_only: optional boolean Whether the directive should only be applied to the Cloudflare CDN cache. Link to this property

Link to this property

RemoveDirective object {operation, cloudflare\_only } Remove the directive.

operation: "set"or "remove" The operation to perform on the cache-control directive.

One of the following: "set" Link to this property "remove" Link to this property

Link to this property cloudflare\_only: optional boolean Whether the directive should only be applied to the Cloudflare CDN cache. Link to this property

Link to this property

Link to this property

"must-understand": optional object {operation, cloudflare\_only } or object {operation, cloudflare\_only } A cache-control directive configuration.

One of the following:

SetDirective object {operation, cloudflare\_only } Set the directive.

operation: "set"or "remove" The operation to perform on the cache-control directive.

One of the following: "set" Link to this property "remove" Link to this property

Link to this property cloudflare\_only: optional boolean Whether the directive should only be applied to the Cloudflare CDN cache. Link to this property

Link to this property

RemoveDirective object {operation, cloudflare\_only } Remove the directive.

operation: "set"or "remove" The operation to perform on the cache-control directive.

One of the following: "set" Link to this property "remove" Link to this property

Link to this property cloudflare\_only: optional boolean Whether the directive should only be applied to the Cloudflare CDN cache. Link to this property

Link to this property

Link to this property

"no-cache": optional object {operation, cloudflare\_only, qualifiers } or object {operation, cloudflare\_only } A cache-control directive configuration that accepts optional qualifiers (header names).

One of the following:

SetDirective object {operation, cloudflare\_only, qualifiers } Set the directive with optional qualifiers.

operation: "set"or "remove" The operation to perform on the cache-control directive.

One of the following: "set" Link to this property "remove" Link to this property

Link to this property cloudflare\_only: optional boolean Whether the directive should only be applied to the Cloudflare CDN cache. Link to this property qualifiers: optional array of string Optional list of header names to qualify the directive (e.g., for “private” or “no-cache” directives). Link to this property

Link to this property

RemoveDirective object {operation, cloudflare\_only } Remove the directive.

operation: "set"or "remove" The operation to perform on the cache-control directive.

One of the following: "set" Link to this property "remove" Link to this property

Link to this property cloudflare\_only: optional boolean Whether the directive should only be applied to the Cloudflare CDN cache. Link to this property

Link to this property

Link to this property

"no-store": optional object {operation, cloudflare\_only } or object {operation, cloudflare\_only } A cache-control directive configuration.

One of the following:

SetDirective object {operation, cloudflare\_only } Set the directive.

operation: "set"or "remove" The operation to perform on the cache-control directive.

One of the following: "set" Link to this property "remove" Link to this property

Link to this property cloudflare\_only: optional boolean Whether the directive should only be applied to the Cloudflare CDN cache. Link to this property

Link to this property

RemoveDirective object {operation, cloudflare\_only } Remove the directive.

operation: "set"or "remove" The operation to perform on the cache-control directive.

One of the following: "set" Link to this property "remove" Link to this property

Link to this property cloudflare\_only: optional boolean Whether the directive should only be applied to the Cloudflare CDN cache. Link to this property

Link to this property

Link to this property

"no-transform": optional object {operation, cloudflare\_only } or object {operation, cloudflare\_only } A cache-control directive configuration.

One of the following:

SetDirective object {operation, cloudflare\_only } Set the directive.

operation: "set"or "remove" The operation to perform on the cache-control directive.

One of the following: "set" Link to this property "remove" Link to this property

Link to this property cloudflare\_only: optional boolean Whether the directive should only be applied to the Cloudflare CDN cache. Link to this property

Link to this property

RemoveDirective object {operation, cloudflare\_only } Remove the directive.

operation: "set"or "remove" The operation to perform on the cache-control directive.

One of the following: "set" Link to this property "remove" Link to this property

Link to this property cloudflare\_only: optional boolean Whether the directive should only be applied to the Cloudflare CDN cache. Link to this property

Link to this property

Link to this property

private: optional object {operation, cloudflare\_only, qualifiers } or object {operation, cloudflare\_only } A cache-control directive configuration that accepts optional qualifiers (header names).

One of the following:

SetDirective object {operation, cloudflare\_only, qualifiers } Set the directive with optional qualifiers.

operation: "set"or "remove" The operation to perform on the cache-control directive.

One of the following: "set" Link to this property "remove" Link to this property

Link to this property cloudflare\_only: optional boolean Whether the directive should only be applied to the Cloudflare CDN cache. Link to this property qualifiers: optional array of string Optional list of header names to qualify the directive (e.g., for “private” or “no-cache” directives). Link to this property

Link to this property

RemoveDirective object {operation, cloudflare\_only } Remove the directive.

operation: "set"or "remove" The operation to perform on the cache-control directive.

One of the following: "set" Link to this property "remove" Link to this property

Link to this property cloudflare\_only: optional boolean Whether the directive should only be applied to the Cloudflare CDN cache. Link to this property

Link to this property

Link to this property

"proxy-revalidate": optional object {operation, cloudflare\_only } or object {operation, cloudflare\_only } A cache-control directive configuration.

One of the following:

SetDirective object {operation, cloudflare\_only } Set the directive.

operation: "set"or "remove" The operation to perform on the cache-control directive.

One of the following: "set" Link to this property "remove" Link to this property

Link to this property cloudflare\_only: optional boolean Whether the directive should only be applied to the Cloudflare CDN cache. Link to this property

Link to this property

RemoveDirective object {operation, cloudflare\_only } Remove the directive.

operation: "set"or "remove" The operation to perform on the cache-control directive.

One of the following: "set" Link to this property "remove" Link to this property

Link to this property cloudflare\_only: optional boolean Whether the directive should only be applied to the Cloudflare CDN cache. Link to this property

Link to this property

Link to this property

public: optional object {operation, cloudflare\_only } or object {operation, cloudflare\_only } A cache-control directive configuration.

One of the following:

SetDirective object {operation, cloudflare\_only } Set the directive.

operation: "set"or "remove" The operation to perform on the cache-control directive.

One of the following: "set" Link to this property "remove" Link to this property

Link to this property cloudflare\_only: optional boolean Whether the directive should only be applied to the Cloudflare CDN cache. Link to this property

Link to this property

RemoveDirective object {operation, cloudflare\_only } Remove the directive.

operation: "set"or "remove" The operation to perform on the cache-control directive.

One of the following: "set" Link to this property "remove" Link to this property

Link to this property cloudflare\_only: optional boolean Whether the directive should only be applied to the Cloudflare CDN cache. Link to this property

Link to this property

Link to this property

"s-maxage": optional object {operation, value, cloudflare\_only } or object {operation, cloudflare\_only } A cache-control directive configuration that accepts a duration value in seconds.

One of the following:

SetDirective object {operation, value, cloudflare\_only } Set the directive with a duration value in seconds.

operation: "set"or "remove" The operation to perform on the cache-control directive.

One of the following: "set" Link to this property "remove" Link to this property

Link to this property value: number The duration value in seconds for the directive. minimum0 Link to this property cloudflare\_only: optional boolean Whether the directive should only be applied to the Cloudflare CDN cache. Link to this property

Link to this property

RemoveDirective object {operation, cloudflare\_only } Remove the directive.

operation: "set"or "remove" The operation to perform on the cache-control directive.

One of the following: "set" Link to this property "remove" Link to this property

Link to this property cloudflare\_only: optional boolean Whether the directive should only be applied to the Cloudflare CDN cache. Link to this property

Link to this property

Link to this property

"stale-if-error": optional object {operation, value, cloudflare\_only } or object {operation, cloudflare\_only } A cache-control directive configuration that accepts a duration value in seconds.

One of the following:

SetDirective object {operation, value, cloudflare\_only } Set the directive with a duration value in seconds.

operation: "set"or "remove" The operation to perform on the cache-control directive.

One of the following: "set" Link to this property "remove" Link to this property

Link to this property value: number The duration value in seconds for the directive. minimum0 Link to this property cloudflare\_only: optional boolean Whether the directive should only be applied to the Cloudflare CDN cache. Link to this property

Link to this property

RemoveDirective object {operation, cloudflare\_only } Remove the directive.

operation: "set"or "remove" The operation to perform on the cache-control directive.

One of the following: "set" Link to this property "remove" Link to this property

Link to this property cloudflare\_only: optional boolean Whether the directive should only be applied to the Cloudflare CDN cache. Link to this property

Link to this property

Link to this property

"stale-while-revalidate": optional object {operation, value, cloudflare\_only } or object {operation, cloudflare\_only } A cache-control directive configuration that accepts a duration value in seconds.

One of the following:

SetDirective object {operation, value, cloudflare\_only } Set the directive with a duration value in seconds.

operation: "set"or "remove" The operation to perform on the cache-control directive.

One of the following: "set" Link to this property "remove" Link to this property

Link to this property value: number The duration value in seconds for the directive. minimum0 Link to this property cloudflare\_only: optional boolean Whether the directive should only be applied to the Cloudflare CDN cache. Link to this property

Link to this property

RemoveDirective object {operation, cloudflare\_only } Remove the directive.

operation: "set"or "remove" The operation to perform on the cache-control directive.

One of the following: "set" Link to this property "remove" Link to this property

Link to this property cloudflare\_only: optional boolean Whether the directive should only be applied to the Cloudflare CDN cache. Link to this property

Link to this property

Link to this property

Link to this property categories: optional array of string The categories of the rule. Link to this property description: optional string An informative description of the rule. Link to this property

exposed\_credential\_check: optional object {password\_expression, username\_expression } Configuration for exposed credential checking.

password\_expression: string An expression that selects the password used in the credentials check. minLength1 Link to this property username\_expression: string An expression that selects the user ID used in the credentials check. minLength1 Link to this property

Link to this property logging: optional Logging { enabled } An object configuring the rule’s logging behavior. Link to this property

ratelimit: optional object {characteristics, period, counting\_expression, 5 more } An object configuring the rule’s rate limit behavior.

characteristics: array of string Characteristics of the request on which the rate limit counter will be incremented. Link to this property period: number Period in seconds over which the counter is being incremented. minimum0 Link to this property counting\_expression: optional string An expression that defines when the rate limit counter should be incremented. It defaults to the same as the rule’s expression. minLength1 Link to this property mitigation\_timeout: optional number Period of time in seconds after which the action will be disabled following its first execution. Link to this property requests\_per\_period: optional number The threshold of requests per period after which the action will be executed for the first time. minimum1 Link to this property requests\_to\_origin: optional boolean Whether counting is only performed when an origin is reached. Link to this property score\_per\_period: optional number The score threshold per period for which the action will be executed the first time. Link to this property score\_response\_header\_name: optional string A response header name provided by the origin, which contains the score to increment rate limit counter with. minLength1 Link to this property

Link to this property

Link to this property

SetCacheSettingsRule = SetCacheSettingsRule { last\_updated, version, id, 10 more }

id: string Link to this property action: string Link to this property enabled: boolean Link to this property expression: string Link to this property ref: string Link to this property

Link to this property

SetCacheTagsRule object {id, action, enabled, 10 more }

id: string The unique ID of the rule. Link to this property action: "set\_cache\_tags" The action to perform when the rule matches. Link to this property enabled: boolean Link to this property expression: string The expression defining which traffic will match the rule. minLength1 Link to this property last\_updated: string The timestamp of when the rule was last modified. formatdate-time Link to this property ref: string The reference of the rule (the rule’s ID by default). minLength1 Link to this property version: string The version of the rule. Link to this property

action\_parameters: optional object {operation, values } or object {expression, operation } or object {operation, values } or 3 more The parameters configuring the rule’s action.

One of the following:

AddCacheTagsValues object {operation, values } Add cache tags using a list of values.

operation: "add"or "remove"or "set" The operation to perform on the cache tags.

One of the following: "add" Link to this property "remove" Link to this property "set" Link to this property

Link to this property values: array of string A list of cache tag values. Link to this property

Link to this property

AddCacheTagsExpression object {expression, operation } Add cache tags using an expression.

expression: string An expression that evaluates to an array of cache tag values. minLength1 Link to this property

operation: "add"or "remove"or "set" The operation to perform on the cache tags.

One of the following: "add" Link to this property "remove" Link to this property "set" Link to this property

Link to this property

Link to this property

RemoveCacheTagsValues object {operation, values } Remove cache tags using a list of values.

operation: "add"or "remove"or "set" The operation to perform on the cache tags.

One of the following: "add" Link to this property "remove" Link to this property "set" Link to this property

Link to this property values: array of string A list of cache tag values. Link to this property

Link to this property

RemoveCacheTagsExpression object {expression, operation } Remove cache tags using an expression.

expression: string An expression that evaluates to an array of cache tag values. minLength1 Link to this property

operation: "add"or "remove"or "set" The operation to perform on the cache tags.

One of the following: "add" Link to this property "remove" Link to this property "set" Link to this property

Link to this property

Link to this property

SetCacheTagsValues object {operation, values } Set cache tags using a list of values.

operation: "add"or "remove"or "set" The operation to perform on the cache tags.

One of the following: "add" Link to this property "remove" Link to this property "set" Link to this property

Link to this property values: array of string A list of cache tag values. Link to this property

Link to this property

SetCacheTagsExpression object {expression, operation } Set cache tags using an expression.

expression: string An expression that evaluates to an array of cache tag values. minLength1 Link to this property

operation: "add"or "remove"or "set" The operation to perform on the cache tags.

One of the following: "add" Link to this property "remove" Link to this property "set" Link to this property

Link to this property

Link to this property

Link to this property categories: optional array of string The categories of the rule. Link to this property description: optional string An informative description of the rule. Link to this property

exposed\_credential\_check: optional object {password\_expression, username\_expression } Configuration for exposed credential checking.

password\_expression: string An expression that selects the password used in the credentials check. minLength1 Link to this property username\_expression: string An expression that selects the user ID used in the credentials check. minLength1 Link to this property

Link to this property logging: optional Logging { enabled } An object configuring the rule’s logging behavior. Link to this property

ratelimit: optional object {characteristics, period, counting\_expression, 5 more } An object configuring the rule’s rate limit behavior.

characteristics: array of string Characteristics of the request on which the rate limit counter will be incremented. Link to this property period: number Period in seconds over which the counter is being incremented. minimum0 Link to this property counting\_expression: optional string An expression that defines when the rate limit counter should be incremented. It defaults to the same as the rule’s expression. minLength1 Link to this property mitigation\_timeout: optional number Period of time in seconds after which the action will be disabled following its first execution. Link to this property requests\_per\_period: optional number The threshold of requests per period after which the action will be executed for the first time. minimum1 Link to this property requests\_to\_origin: optional boolean Whether counting is only performed when an origin is reached. Link to this property score\_per\_period: optional number The score threshold per period for which the action will be executed the first time. Link to this property score\_response\_header\_name: optional string A response header name provided by the origin, which contains the score to increment rate limit counter with. minLength1 Link to this property

Link to this property

Link to this property

SetConfigurationRule = SetConfigRule { last\_updated, version, id, 10 more }

id: string Link to this property action: string Link to this property enabled: boolean Link to this property expression: string Link to this property ref: string Link to this property

Link to this property

SkipRule = SkipRule { last\_updated, version, id, 10 more }

id: string Link to this property action: string Link to this property enabled: boolean Link to this property expression: string Link to this property ref: string Link to this property

Link to this property

TransformResponseHTMLRule object {id, action, enabled, 10 more }

id: string The unique ID of the rule. Link to this property action: "transform\_response\_html" The action to perform when the rule matches. Link to this property enabled: boolean Link to this property expression: string The expression defining which traffic will match the rule. minLength1 Link to this property last\_updated: string The timestamp of when the rule was last modified. formatdate-time Link to this property ref: string The reference of the rule (the rule’s ID by default). minLength1 Link to this property version: string The version of the rule. Link to this property

action\_parameters: optional object {link\_maze } The parameters configuring the rule’s action.

link\_maze: unknown Enables the link maze transformation on the response. Link to this property

Link to this property categories: optional array of string The categories of the rule. Link to this property description: optional string An informative description of the rule. Link to this property

exposed\_credential\_check: optional object {password\_expression, username\_expression } Configuration for exposed credential checking.

password\_expression: string An expression that selects the password used in the credentials check. minLength1 Link to this property username\_expression: string An expression that selects the user ID used in the credentials check. minLength1 Link to this property

Link to this property logging: optional Logging { enabled } An object configuring the rule’s logging behavior. Link to this property

ratelimit: optional object {characteristics, period, counting\_expression, 5 more } An object configuring the rule’s rate limit behavior.

characteristics: array of string Characteristics of the request on which the rate limit counter will be incremented. Link to this property period: number Period in seconds over which the counter is being incremented. minimum0 Link to this property counting\_expression: optional string An expression that defines when the rate limit counter should be incremented. It defaults to the same as the rule’s expression. minLength1 Link to this property mitigation\_timeout: optional number Period of time in seconds after which the action will be disabled following its first execution. Link to this property requests\_per\_period: optional number The threshold of requests per period after which the action will be executed for the first time. minimum1 Link to this property requests\_to\_origin: optional boolean Whether counting is only performed when an origin is reached. Link to this property score\_per\_period: optional number The score threshold per period for which the action will be executed the first time. Link to this property score\_response\_header\_name: optional string A response header name provided by the origin, which contains the score to increment rate limit counter with. minLength1 Link to this property

Link to this property

Link to this property

Link to this property version: string The version of the ruleset. Link to this property description: optional string An informative description of the ruleset. Link to this property

Link to this property unknown Returned when dry\_run is true. Link to this property

[Link to this property](<#(resource)%20rulesets.rules%20%3E%20(model)%20rule_delete_response%20%3E%20(schema)>)