--- title: Create an account or zone ruleset --- [Skip to content](#_top) [API Reference](https://developers.cloudflare.com/api/typescript) [Rulesets](https://developers.cloudflare.com/api/typescript/resources/rulesets) Copy Markdown Open in **Claude**Open in **ChatGPT**Open in **Cursor** --- **Copy Markdown****View as Markdown** # Create an account or zone ruleset client.rulesets.create(RulesetCreateParams {account\_id, zone\_id, dry\_run, 5 more } params, RequestOptionsoptions?): [RulesetCreateResponse]() POST/{accounts\_or\_zones}/{account\_or\_zone\_id}/rulesets Creates a ruleset. ##### Security
API Token The preferred authorization scheme for interacting with the Cloudflare API. Create a token. **Example:**Authorization: Bearer Sn3lZJTBX6kkg7OdcBUAxOO963GEIyGQqnFTOFYY
API Email + API Key The previous authorization scheme for interacting with the Cloudflare API, used in conjunction with a Global API key. **Example:**X-Auth-Email: user@example.com The previous authorization scheme for interacting with the Cloudflare API. When possible, use API tokens instead of Global API keys. **Example:**X-Auth-Key: 144c9defac04969c7bfad8efaa8ea194
##### Accepted Permissions (at least one required) `Mass URL Redirects Write``Magic Firewall Write``L4 DDoS Managed Ruleset Write``Transform Rules Write``Select Configuration Write``Account WAF Write``Account Rulesets Write``Logs Write` ##### ParametersExpand Collapse
params: RulesetCreateParams {account\_id, zone\_id, dry\_run, 5 more } account\_id?: string Path param: The Account ID to use for this endpoint. Mutually exclusive with the Zone ID. Link to this property zone\_id?: string Path param: The Zone ID to use for this endpoint. Mutually exclusive with the Account ID. Link to this property dry\_run?: boolean Query param: Validates the request without persisting changes when set to true. Responses that normally return 200 return result: null; endpoints that normally return 204 continue to return 204. Link to this property description?: string Body param: An informative description of the ruleset. Link to this property
kind?: Kind Body param: The kind of the ruleset. One of the following: "managed" Link to this property "custom" Link to this property "root" Link to this property "zone" Link to this property
Link to this property name?: string Body param: The human-readable name of the ruleset. minLength1 Link to this property
phase?: Phase Body param: The phase of the ruleset. 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
rules?: Array<BlockRule {last\_updated, version, id, 10 more } | RulesetsChallengeRule {last\_updated, version, id, 10 more } | CompressResponseRule {last\_updated, version, id, 10 more } | 18 more> Body param: The list of rules in the ruleset. One of the following:
BlockRule {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?: string The unique ID of the rule. Link to this property action?: "block" The action to perform when the rule matches. Link to this property
action\_parameters?: ActionParameters {response } The parameters configuring the rule’s action.
response?: Response {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?: Array<string> The categories of the rule. Link to this property description?: string An informative description of the rule. Link to this property enabled?: boolean Whether the rule should be executed. Link to this property
exposed\_credential\_check?: ExposedCredentialCheck {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?: string The expression defining which traffic will match the rule. minLength1 Link to this property
logging?: Logging {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
ratelimit?: Ratelimit {characteristics, period, counting\_expression, 5 more } An object configuring the rule’s rate limit behavior. characteristics: Array<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?: 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?: number Period of time in seconds after which the action will be disabled following its first execution. Link to this property requests\_per\_period?: 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?: boolean Whether counting is only performed when an origin is reached. Link to this property score\_per\_period?: number The score threshold per period for which the action will be executed the first time. Link to this property score\_response\_header\_name?: 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?: string The reference of the rule (the rule’s ID by default). minLength1 Link to this property
Link to this property
RulesetsChallengeRule {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?: 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 action\_parameters?: unknown The parameters configuring the rule’s action. Link to this property categories?: Array<string> The categories of the rule. Link to this property description?: string An informative description of the rule. Link to this property enabled?: boolean Whether the rule should be executed. Link to this property
exposed\_credential\_check?: ExposedCredentialCheck {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?: string The expression defining which traffic will match the rule. minLength1 Link to this property
logging?: Logging {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
ratelimit?: Ratelimit {characteristics, period, counting\_expression, 5 more } An object configuring the rule’s rate limit behavior. characteristics: Array<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?: 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?: number Period of time in seconds after which the action will be disabled following its first execution. Link to this property requests\_per\_period?: 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?: boolean Whether counting is only performed when an origin is reached. Link to this property score\_per\_period?: number The score threshold per period for which the action will be executed the first time. Link to this property score\_response\_header\_name?: 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?: string The reference of the rule (the rule’s ID by default). minLength1 Link to this property
Link to this property
CompressResponseRule {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?: string The unique ID of the rule. Link to this property action?: "compress\_response" The action to perform when the rule matches. Link to this property
action\_parameters?: ActionParameters {algorithms } The parameters configuring the rule’s action.
algorithms: Array<Algorithm> Custom order for compression algorithms.
name?: "none"| "auto"| "default"| 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?: Array<string> The categories of the rule. Link to this property description?: string An informative description of the rule. Link to this property enabled?: boolean Whether the rule should be executed. Link to this property
exposed\_credential\_check?: ExposedCredentialCheck {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?: string The expression defining which traffic will match the rule. minLength1 Link to this property
logging?: Logging {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
ratelimit?: Ratelimit {characteristics, period, counting\_expression, 5 more } An object configuring the rule’s rate limit behavior. characteristics: Array<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?: 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?: number Period of time in seconds after which the action will be disabled following its first execution. Link to this property requests\_per\_period?: 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?: boolean Whether counting is only performed when an origin is reached. Link to this property score\_per\_period?: number The score threshold per period for which the action will be executed the first time. Link to this property score\_response\_header\_name?: 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?: string The reference of the rule (the rule’s ID by default). minLength1 Link to this property
Link to this property
DDoSDynamicRule {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?: string The unique ID of the rule. Link to this property action?: "ddos\_dynamic" The action to perform when the rule matches. Link to this property action\_parameters?: unknown The parameters configuring the rule’s action. Link to this property categories?: Array<string> The categories of the rule. Link to this property description?: string An informative description of the rule. Link to this property enabled?: boolean Whether the rule should be executed. Link to this property
exposed\_credential\_check?: ExposedCredentialCheck {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?: string The expression defining which traffic will match the rule. minLength1 Link to this property
logging?: Logging {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
ratelimit?: Ratelimit {characteristics, period, counting\_expression, 5 more } An object configuring the rule’s rate limit behavior. characteristics: Array<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?: 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?: number Period of time in seconds after which the action will be disabled following its first execution. Link to this property requests\_per\_period?: 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?: boolean Whether counting is only performed when an origin is reached. Link to this property score\_per\_period?: number The score threshold per period for which the action will be executed the first time. Link to this property score\_response\_header\_name?: 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?: string The reference of the rule (the rule’s ID by default). minLength1 Link to this property
Link to this property
ExecuteRule {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?: string The unique ID of the rule. Link to this property action?: "execute" The action to perform when the rule matches. Link to this property
action\_parameters?: ActionParameters {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?: MatchedData {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?: Overrides {action, categories, enabled, 2 more } A set of overrides to apply to the target ruleset. action?: string An action to override all rules with. This option has lower precedence than rule and category overrides. Link to this property
categories?: Array<Category> 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?: string The action to override rules in the category with. Link to this property enabled?: boolean Whether to enable execution of rules in the category. Link to this property
sensitivity\_level?: "default"| "medium"| "low"| "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?: boolean Whether to enable execution of all rules. This option has lower precedence than rule and category overrides. Link to this property
rules?: Array<Rule> 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?: string The action to override the rule with. Link to this property enabled?: boolean Whether to enable execution of the rule. Link to this property score\_threshold?: number The score threshold to use for the rule. Link to this property
sensitivity\_level?: "default"| "medium"| "low"| "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?: "default"| "medium"| "low"| "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?: Array<string> The categories of the rule. Link to this property description?: string An informative description of the rule. Link to this property enabled?: boolean Whether the rule should be executed. Link to this property
exposed\_credential\_check?: ExposedCredentialCheck {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?: string The expression defining which traffic will match the rule. minLength1 Link to this property
logging?: Logging {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
ratelimit?: Ratelimit {characteristics, period, counting\_expression, 5 more } An object configuring the rule’s rate limit behavior. characteristics: Array<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?: 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?: number Period of time in seconds after which the action will be disabled following its first execution. Link to this property requests\_per\_period?: 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?: boolean Whether counting is only performed when an origin is reached. Link to this property score\_per\_period?: number The score threshold per period for which the action will be executed the first time. Link to this property score\_response\_header\_name?: 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?: string The reference of the rule (the rule’s ID by default). minLength1 Link to this property
Link to this property
ForceConnectionCloseRule {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?: string The unique ID of the rule. Link to this property action?: "force\_connection\_close" The action to perform when the rule matches. Link to this property action\_parameters?: unknown The parameters configuring the rule’s action. Link to this property categories?: Array<string> The categories of the rule. Link to this property description?: string An informative description of the rule. Link to this property enabled?: boolean Whether the rule should be executed. Link to this property
exposed\_credential\_check?: ExposedCredentialCheck {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?: string The expression defining which traffic will match the rule. minLength1 Link to this property
logging?: Logging {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
ratelimit?: Ratelimit {characteristics, period, counting\_expression, 5 more } An object configuring the rule’s rate limit behavior. characteristics: Array<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?: 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?: number Period of time in seconds after which the action will be disabled following its first execution. Link to this property requests\_per\_period?: 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?: boolean Whether counting is only performed when an origin is reached. Link to this property score\_per\_period?: number The score threshold per period for which the action will be executed the first time. Link to this property score\_response\_header\_name?: 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?: string The reference of the rule (the rule’s ID by default). minLength1 Link to this property
Link to this property
RulesetsJSChallengeRule {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?: 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 action\_parameters?: unknown The parameters configuring the rule’s action. Link to this property categories?: Array<string> The categories of the rule. Link to this property description?: string An informative description of the rule. Link to this property enabled?: boolean Whether the rule should be executed. Link to this property
exposed\_credential\_check?: ExposedCredentialCheck {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?: string The expression defining which traffic will match the rule. minLength1 Link to this property
logging?: Logging {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
ratelimit?: Ratelimit {characteristics, period, counting\_expression, 5 more } An object configuring the rule’s rate limit behavior. characteristics: Array<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?: 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?: number Period of time in seconds after which the action will be disabled following its first execution. Link to this property requests\_per\_period?: 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?: boolean Whether counting is only performed when an origin is reached. Link to this property score\_per\_period?: number The score threshold per period for which the action will be executed the first time. Link to this property score\_response\_header\_name?: 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?: string The reference of the rule (the rule’s ID by default). minLength1 Link to this property
Link to this property
LogRule {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?: string The unique ID of the rule. Link to this property action?: "log" The action to perform when the rule matches. Link to this property action\_parameters?: unknown The parameters configuring the rule’s action. Link to this property categories?: Array<string> The categories of the rule. Link to this property description?: string An informative description of the rule. Link to this property enabled?: boolean Whether the rule should be executed. Link to this property
exposed\_credential\_check?: ExposedCredentialCheck {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?: string The expression defining which traffic will match the rule. minLength1 Link to this property
logging?: Logging {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
ratelimit?: Ratelimit {characteristics, period, counting\_expression, 5 more } An object configuring the rule’s rate limit behavior. characteristics: Array<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?: 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?: number Period of time in seconds after which the action will be disabled following its first execution. Link to this property requests\_per\_period?: 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?: boolean Whether counting is only performed when an origin is reached. Link to this property score\_per\_period?: number The score threshold per period for which the action will be executed the first time. Link to this property score\_response\_header\_name?: 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?: string The reference of the rule (the rule’s ID by default). minLength1 Link to this property
Link to this property
LogCustomFieldRule {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?: string The unique ID of the rule. Link to this property action?: "log\_custom\_field" The action to perform when the rule matches. Link to this property
action\_parameters?: ActionParameters {cookie\_fields, raw\_response\_fields, request\_fields, 2 more } The parameters configuring the rule’s action.
cookie\_fields?: Array<CookieField> The cookie fields to log. name: string The name of the cookie. minLength1 Link to this property
Link to this property
raw\_response\_fields?: Array<RawResponseField> The raw response fields to log. name: string The name of the response header. minLength1 Link to this property preserve\_duplicates?: boolean Whether to log duplicate values of the same header. Link to this property
Link to this property
request\_fields?: Array<RequestField> The raw request fields to log. name: string The name of the header. minLength1 Link to this property
Link to this property
response\_fields?: Array<ResponseField> The transformed response fields to log. name: string The name of the response header. minLength1 Link to this property preserve\_duplicates?: boolean Whether to log duplicate values of the same header. Link to this property
Link to this property
transformed\_request\_fields?: Array<TransformedRequestField> 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?: Array<string> The categories of the rule. Link to this property description?: string An informative description of the rule. Link to this property enabled?: boolean Whether the rule should be executed. Link to this property
exposed\_credential\_check?: ExposedCredentialCheck {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?: string The expression defining which traffic will match the rule. minLength1 Link to this property
logging?: Logging {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
ratelimit?: Ratelimit {characteristics, period, counting\_expression, 5 more } An object configuring the rule’s rate limit behavior. characteristics: Array<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?: 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?: number Period of time in seconds after which the action will be disabled following its first execution. Link to this property requests\_per\_period?: 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?: boolean Whether counting is only performed when an origin is reached. Link to this property score\_per\_period?: number The score threshold per period for which the action will be executed the first time. Link to this property score\_response\_header\_name?: 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?: string The reference of the rule (the rule’s ID by default). minLength1 Link to this property
Link to this property
ManagedChallengeRule {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?: string The unique ID of the rule. Link to this property action?: "managed\_challenge" The action to perform when the rule matches. Link to this property action\_parameters?: unknown The parameters configuring the rule’s action. Link to this property categories?: Array<string> The categories of the rule. Link to this property description?: string An informative description of the rule. Link to this property enabled?: boolean Whether the rule should be executed. Link to this property
exposed\_credential\_check?: ExposedCredentialCheck {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?: string The expression defining which traffic will match the rule. minLength1 Link to this property
logging?: Logging {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
ratelimit?: Ratelimit {characteristics, period, counting\_expression, 5 more } An object configuring the rule’s rate limit behavior. characteristics: Array<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?: 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?: number Period of time in seconds after which the action will be disabled following its first execution. Link to this property requests\_per\_period?: 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?: boolean Whether counting is only performed when an origin is reached. Link to this property score\_per\_period?: number The score threshold per period for which the action will be executed the first time. Link to this property score\_response\_header\_name?: 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?: string The reference of the rule (the rule’s ID by default). minLength1 Link to this property
Link to this property
RedirectRule {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?: string The unique ID of the rule. Link to this property action?: "redirect" The action to perform when the rule matches. Link to this property
action\_parameters?: ActionParameters {from\_list, from\_value } The parameters configuring the rule’s action.
from\_list?: FromList {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?: FromValue {target\_url, preserve\_query\_string, status\_code } A redirect based on the request properties.
target\_url: TargetURL {expression, value } A URL to redirect the request to. expression?: string An expression that evaluates to a URL to redirect the request to. minLength1 Link to this property value?: string A URL to redirect the request to. minLength1 Link to this property
Link to this property preserve\_query\_string?: boolean Whether to keep the query string of the original request. Link to this property
status\_code?: 301| 302| 303| 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?: Array<string> The categories of the rule. Link to this property description?: string An informative description of the rule. Link to this property enabled?: boolean Whether the rule should be executed. Link to this property
exposed\_credential\_check?: ExposedCredentialCheck {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?: string The expression defining which traffic will match the rule. minLength1 Link to this property
logging?: Logging {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
ratelimit?: Ratelimit {characteristics, period, counting\_expression, 5 more } An object configuring the rule’s rate limit behavior. characteristics: Array<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?: 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?: number Period of time in seconds after which the action will be disabled following its first execution. Link to this property requests\_per\_period?: 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?: boolean Whether counting is only performed when an origin is reached. Link to this property score\_per\_period?: number The score threshold per period for which the action will be executed the first time. Link to this property score\_response\_header\_name?: 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?: string The reference of the rule (the rule’s ID by default). minLength1 Link to this property
Link to this property
RewriteRule {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?: string The unique ID of the rule. Link to this property action?: "rewrite" The action to perform when the rule matches. Link to this property
action\_parameters?: ActionParameters {headers, uri } The parameters configuring the rule’s action.
headers?: Record<string, AddStaticHeader {operation, value } | AddDynamicHeader {expression, operation } | SetStaticHeader {operation, value } | 2 more> A map of headers to rewrite. One of the following:
AddStaticHeader {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 {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 {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 {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 {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?: URIPath {path, origin } | URIQuery {query, origin } A URI path rewrite. One of the following:
URIPath {path, origin } A URI path rewrite.
path: Path {expression, value } A URI path rewrite. expression?: string An expression that evaluates to a value to rewrite the URI path to. minLength1 Link to this property value?: string A value to rewrite the URI path to. minLength1 Link to this property
Link to this property origin?: boolean Whether to propagate the rewritten URI to origin. Link to this property
Link to this property
URIQuery {query, origin } A URI query rewrite.
query: Query {expression, value } A URI query rewrite. expression?: string An expression that evaluates to a value to rewrite the URI query to. minLength1 Link to this property value?: string A value to rewrite the URI query to. Link to this property
Link to this property origin?: 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?: Array<string> The categories of the rule. Link to this property description?: string An informative description of the rule. Link to this property enabled?: boolean Whether the rule should be executed. Link to this property
exposed\_credential\_check?: ExposedCredentialCheck {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?: string The expression defining which traffic will match the rule. minLength1 Link to this property
logging?: Logging {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
ratelimit?: Ratelimit {characteristics, period, counting\_expression, 5 more } An object configuring the rule’s rate limit behavior. characteristics: Array<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?: 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?: number Period of time in seconds after which the action will be disabled following its first execution. Link to this property requests\_per\_period?: 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?: boolean Whether counting is only performed when an origin is reached. Link to this property score\_per\_period?: number The score threshold per period for which the action will be executed the first time. Link to this property score\_response\_header\_name?: 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?: string The reference of the rule (the rule’s ID by default). minLength1 Link to this property
Link to this property
RouteRule {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?: string The unique ID of the rule. Link to this property action?: "route" The action to perform when the rule matches. Link to this property
action\_parameters?: ActionParameters {host\_header, origin, sni } The parameters configuring the rule’s action. host\_header?: string A value to rewrite the HTTP host header to. minLength1 Link to this property
origin?: Origin {host, port } An origin to route to. host?: string A resolved host to route to. minLength1 Link to this property port?: number A destination port to route to. maximum65535 minimum1 Link to this property
Link to this property
sni?: SNI {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?: Array<string> The categories of the rule. Link to this property description?: string An informative description of the rule. Link to this property enabled?: boolean Whether the rule should be executed. Link to this property
exposed\_credential\_check?: ExposedCredentialCheck {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?: string The expression defining which traffic will match the rule. minLength1 Link to this property
logging?: Logging {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
ratelimit?: Ratelimit {characteristics, period, counting\_expression, 5 more } An object configuring the rule’s rate limit behavior. characteristics: Array<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?: 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?: number Period of time in seconds after which the action will be disabled following its first execution. Link to this property requests\_per\_period?: 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?: boolean Whether counting is only performed when an origin is reached. Link to this property score\_per\_period?: number The score threshold per period for which the action will be executed the first time. Link to this property score\_response\_header\_name?: 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?: string The reference of the rule (the rule’s ID by default). minLength1 Link to this property
Link to this property
ScoreRule {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?: string The unique ID of the rule. Link to this property action?: "score" The action to perform when the rule matches. Link to this property
action\_parameters?: ActionParameters {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?: Array<string> The categories of the rule. Link to this property description?: string An informative description of the rule. Link to this property enabled?: boolean Link to this property
exposed\_credential\_check?: ExposedCredentialCheck {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?: string The expression defining which traffic will match the rule. minLength1 Link to this property
logging?: Logging {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
ratelimit?: Ratelimit {characteristics, period, counting\_expression, 5 more } An object configuring the rule’s rate limit behavior. characteristics: Array<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?: 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?: number Period of time in seconds after which the action will be disabled following its first execution. Link to this property requests\_per\_period?: 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?: boolean Whether counting is only performed when an origin is reached. Link to this property score\_per\_period?: number The score threshold per period for which the action will be executed the first time. Link to this property score\_response\_header\_name?: 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?: string The reference of the rule (the rule’s ID by default). minLength1 Link to this property
Link to this property
ServeErrorRule {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?: string The unique ID of the rule. Link to this property action?: "serve\_error" The action to perform when the rule matches. Link to this property
action\_parameters?: ActionParametersContent {content, content\_type, status\_code } | ActionParametersAsset {asset\_name, content\_type, status\_code } The parameters configuring the rule’s action. One of the following:
ActionParametersContent {content, content\_type, status\_code } content: string The response content. minLength1 Link to this property
content\_type?: "application/json"| "text/html"| "text/plain"| "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?: number The status code to use for the error. maximum999 minimum400 Link to this property
Link to this property
ActionParametersAsset {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?: "application/json"| "text/html"| "text/plain"| "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?: number The status code to use for the error. maximum999 minimum400 Link to this property
Link to this property
Link to this property categories?: Array<string> The categories of the rule. Link to this property description?: string An informative description of the rule. Link to this property enabled?: boolean Link to this property
exposed\_credential\_check?: ExposedCredentialCheck {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?: string The expression defining which traffic will match the rule. minLength1 Link to this property
logging?: Logging {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
ratelimit?: Ratelimit {characteristics, period, counting\_expression, 5 more } An object configuring the rule’s rate limit behavior. characteristics: Array<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?: 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?: number Period of time in seconds after which the action will be disabled following its first execution. Link to this property requests\_per\_period?: 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?: boolean Whether counting is only performed when an origin is reached. Link to this property score\_per\_period?: number The score threshold per period for which the action will be executed the first time. Link to this property score\_response\_header\_name?: 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?: string The reference of the rule (the rule’s ID by default). minLength1 Link to this property
Link to this property
RulesetsSetCacheControlRule {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?: 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
action\_parameters?: ActionParameters {immutable, max-age, must-revalidate, 10 more } The parameters configuring the rule’s action.
immutable?: SetDirective {operation, cloudflare\_only } | RemoveDirective {operation, cloudflare\_only } A cache-control directive configuration. One of the following:
SetDirective {operation, cloudflare\_only } Set the directive.
operation: "set"| "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?: boolean Whether the directive should only be applied to the Cloudflare CDN cache. Link to this property
Link to this property
RemoveDirective {operation, cloudflare\_only } Remove the directive.
operation: "set"| "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?: 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"?: SetDirective {operation, value, cloudflare\_only } | RemoveDirective {operation, cloudflare\_only } A cache-control directive configuration that accepts a duration value in seconds. One of the following:
SetDirective {operation, value, cloudflare\_only } Set the directive with a duration value in seconds.
operation: "set"| "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?: boolean Whether the directive should only be applied to the Cloudflare CDN cache. Link to this property
Link to this property
RemoveDirective {operation, cloudflare\_only } Remove the directive.
operation: "set"| "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?: 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"?: SetDirective {operation, cloudflare\_only } | RemoveDirective {operation, cloudflare\_only } A cache-control directive configuration. One of the following:
SetDirective {operation, cloudflare\_only } Set the directive.
operation: "set"| "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?: boolean Whether the directive should only be applied to the Cloudflare CDN cache. Link to this property
Link to this property
RemoveDirective {operation, cloudflare\_only } Remove the directive.
operation: "set"| "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?: 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"?: SetDirective {operation, cloudflare\_only } | RemoveDirective {operation, cloudflare\_only } A cache-control directive configuration. One of the following:
SetDirective {operation, cloudflare\_only } Set the directive.
operation: "set"| "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?: boolean Whether the directive should only be applied to the Cloudflare CDN cache. Link to this property
Link to this property
RemoveDirective {operation, cloudflare\_only } Remove the directive.
operation: "set"| "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?: 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"?: SetDirective {operation, cloudflare\_only, qualifiers } | RemoveDirective {operation, cloudflare\_only } A cache-control directive configuration that accepts optional qualifiers (header names). One of the following:
SetDirective {operation, cloudflare\_only, qualifiers } Set the directive with optional qualifiers.
operation: "set"| "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?: boolean Whether the directive should only be applied to the Cloudflare CDN cache. Link to this property qualifiers?: Array<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 {operation, cloudflare\_only } Remove the directive.
operation: "set"| "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?: 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"?: SetDirective {operation, cloudflare\_only } | RemoveDirective {operation, cloudflare\_only } A cache-control directive configuration. One of the following:
SetDirective {operation, cloudflare\_only } Set the directive.
operation: "set"| "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?: boolean Whether the directive should only be applied to the Cloudflare CDN cache. Link to this property
Link to this property
RemoveDirective {operation, cloudflare\_only } Remove the directive.
operation: "set"| "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?: 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"?: SetDirective {operation, cloudflare\_only } | RemoveDirective {operation, cloudflare\_only } A cache-control directive configuration. One of the following:
SetDirective {operation, cloudflare\_only } Set the directive.
operation: "set"| "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?: boolean Whether the directive should only be applied to the Cloudflare CDN cache. Link to this property
Link to this property
RemoveDirective {operation, cloudflare\_only } Remove the directive.
operation: "set"| "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?: 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?: SetDirective {operation, cloudflare\_only, qualifiers } | RemoveDirective {operation, cloudflare\_only } A cache-control directive configuration that accepts optional qualifiers (header names). One of the following:
SetDirective {operation, cloudflare\_only, qualifiers } Set the directive with optional qualifiers.
operation: "set"| "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?: boolean Whether the directive should only be applied to the Cloudflare CDN cache. Link to this property qualifiers?: Array<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 {operation, cloudflare\_only } Remove the directive.
operation: "set"| "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?: 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"?: SetDirective {operation, cloudflare\_only } | RemoveDirective {operation, cloudflare\_only } A cache-control directive configuration. One of the following:
SetDirective {operation, cloudflare\_only } Set the directive.
operation: "set"| "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?: boolean Whether the directive should only be applied to the Cloudflare CDN cache. Link to this property
Link to this property
RemoveDirective {operation, cloudflare\_only } Remove the directive.
operation: "set"| "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?: 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?: SetDirective {operation, cloudflare\_only } | RemoveDirective {operation, cloudflare\_only } A cache-control directive configuration. One of the following:
SetDirective {operation, cloudflare\_only } Set the directive.
operation: "set"| "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?: boolean Whether the directive should only be applied to the Cloudflare CDN cache. Link to this property
Link to this property
RemoveDirective {operation, cloudflare\_only } Remove the directive.
operation: "set"| "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?: 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"?: SetDirective {operation, value, cloudflare\_only } | RemoveDirective {operation, cloudflare\_only } A cache-control directive configuration that accepts a duration value in seconds. One of the following:
SetDirective {operation, value, cloudflare\_only } Set the directive with a duration value in seconds.
operation: "set"| "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?: boolean Whether the directive should only be applied to the Cloudflare CDN cache. Link to this property
Link to this property
RemoveDirective {operation, cloudflare\_only } Remove the directive.
operation: "set"| "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?: 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"?: SetDirective {operation, value, cloudflare\_only } | RemoveDirective {operation, cloudflare\_only } A cache-control directive configuration that accepts a duration value in seconds. One of the following:
SetDirective {operation, value, cloudflare\_only } Set the directive with a duration value in seconds.
operation: "set"| "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?: boolean Whether the directive should only be applied to the Cloudflare CDN cache. Link to this property
Link to this property
RemoveDirective {operation, cloudflare\_only } Remove the directive.
operation: "set"| "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?: 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"?: SetDirective {operation, value, cloudflare\_only } | RemoveDirective {operation, cloudflare\_only } A cache-control directive configuration that accepts a duration value in seconds. One of the following:
SetDirective {operation, value, cloudflare\_only } Set the directive with a duration value in seconds.
operation: "set"| "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?: boolean Whether the directive should only be applied to the Cloudflare CDN cache. Link to this property
Link to this property
RemoveDirective {operation, cloudflare\_only } Remove the directive.
operation: "set"| "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?: 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?: Array<string> The categories of the rule. Link to this property description?: string An informative description of the rule. Link to this property enabled?: boolean Link to this property
exposed\_credential\_check?: ExposedCredentialCheck {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?: string The expression defining which traffic will match the rule. minLength1 Link to this property
logging?: Logging {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
ratelimit?: Ratelimit {characteristics, period, counting\_expression, 5 more } An object configuring the rule’s rate limit behavior. characteristics: Array<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?: 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?: number Period of time in seconds after which the action will be disabled following its first execution. Link to this property requests\_per\_period?: 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?: boolean Whether counting is only performed when an origin is reached. Link to this property score\_per\_period?: number The score threshold per period for which the action will be executed the first time. Link to this property score\_response\_header\_name?: 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?: string The reference of the rule (the rule’s ID by default). minLength1 Link to this property
Link to this property
SetCacheSettingsRule {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?: string The unique ID of the rule. Link to this property action?: "set\_cache\_settings" The action to perform when the rule matches. Link to this property
action\_parameters?: ActionParameters {additional\_cacheable\_ports, browser\_ttl, cache, 14 more } The parameters configuring the rule’s action. additional\_cacheable\_ports?: Array<number> A list of additional ports that caching should be enabled on. Link to this property
browser\_ttl?: BrowserTTL {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"| "bypass\_by\_default"| "override\_origin"| "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?: number The browser TTL (in seconds) if you choose the “override\_origin” mode. minimum0 Link to this property
Link to this property cache?: 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?: CacheKey {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?: boolean Whether to separate cached content based on the visitor’s device type. Link to this property cache\_deception\_armor?: boolean Whether to protect from web cache deception attacks, while allowing static assets to be cached. Link to this property
custom\_key?: CustomKey {cookie, header, host, 2 more } Which components of the request are included or excluded from the cache key.
cookie?: Cookie {check\_presence, include } Which cookies to include in the cache key. check\_presence?: Array<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?: Array<string> A list of cookies to include in the cache key. Link to this property
Link to this property
header?: Header {check\_presence, contains, exclude\_origin, include } Which headers to include in the cache key. check\_presence?: Array<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?: Record<string, Array<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?: boolean Whether to exclude the origin header in the cache key. Link to this property include?: Array<string> A list of headers to include in the cache key. Link to this property
Link to this property
host?: Host {resolved } How to use the host in the cache key. resolved?: boolean Whether to use the resolved host in the cache key. Link to this property
Link to this property
query\_string?: QueryString {exclude, include } Which query string parameters to include in or exclude from the cache key.
exclude?: Exclude {all, list } Which query string parameters to exclude from the cache key. all?: true Whether to exclude all query string parameters from the cache key. Link to this property list?: Array<string> A list of query string parameters to exclude from the cache key. Link to this property
Link to this property
include?: Include {all, list } Which query string parameters to include in the cache key. all?: true Whether to include all query string parameters in the cache key. Link to this property list?: Array<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?: User {device\_type, geo, lang } How to use characteristics of the request user agent in the cache key. device\_type?: boolean Whether to use the user agent’s device type in the cache key. Link to this property geo?: boolean Whether to use the user agents’s country in the cache key. Link to this property lang?: 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?: 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?: CacheReserve {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?: number The minimum file size eligible for storage in Cache Reserve. minimum0 Link to this property
Link to this property
edge\_ttl?: EdgeTTL {mode, default, status\_code\_ttl } How long the Cloudflare edge network should cache the response.
mode: "respect\_origin"| "bypass\_by\_default"| "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?: number The edge TTL (in seconds) if you choose the “override\_origin” mode. minimum0 Link to this property
status\_code\_ttl?: Array<StatusCodeTTL> 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?: number A single status code to apply the TTL to. maximum999 minimum100 Link to this property
status\_code\_range?: StatusCodeRange {from, to } A range of status codes to apply the TTL to. from?: number The lower bound of the range. maximum999 minimum100 Link to this property to?: 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?: boolean Whether Cloudflare will aim to strictly adhere to RFC 7234. Link to this property origin\_error\_page\_passthru?: boolean Whether to generate Cloudflare error pages for issues from the origin server. Link to this property
origin\_range\_requests?: OriginRangeRequests {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"| "off"| "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?: 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?: 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?: ServeStale {disable\_stale\_while\_updating } When to serve stale content from cache. disable\_stale\_while\_updating?: 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?: SharedDictionary {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?: boolean Whether to strip ETag headers from the origin response before caching. Link to this property strip\_last\_modified?: boolean Whether to strip Last-Modified headers from the origin response before caching. Link to this property strip\_set\_cookie?: boolean Whether to strip Set-Cookie headers from the origin response before caching. Link to this property
vary?: Vary {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?: Default {action } Controls how response Vary headers without a per-header override contribute to the cache key.
action: "bypass"| "passthrough"| "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?: Record<string, Headers> A mapping of lowercase request header names to their vary configuration.
action: "bypass"| "passthrough"| "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?: Array<string> The set of languages to normalize against. Only valid for the accept-language header. Link to this property media\_types?: Array<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?: Array<string> The categories of the rule. Link to this property description?: string An informative description of the rule. Link to this property enabled?: boolean Link to this property
exposed\_credential\_check?: ExposedCredentialCheck {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?: string The expression defining which traffic will match the rule. minLength1 Link to this property
logging?: Logging {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
ratelimit?: Ratelimit {characteristics, period, counting\_expression, 5 more } An object configuring the rule’s rate limit behavior. characteristics: Array<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?: 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?: number Period of time in seconds after which the action will be disabled following its first execution. Link to this property requests\_per\_period?: 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?: boolean Whether counting is only performed when an origin is reached. Link to this property score\_per\_period?: number The score threshold per period for which the action will be executed the first time. Link to this property score\_response\_header\_name?: 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?: string The reference of the rule (the rule’s ID by default). minLength1 Link to this property
Link to this property
RulesetsSetCacheTagsRule {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?: 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
action\_parameters?: AddCacheTagsValues {operation, values } | AddCacheTagsExpression {expression, operation } | RemoveCacheTagsValues {operation, values } | 3 more The parameters configuring the rule’s action. One of the following:
AddCacheTagsValues {operation, values } Add cache tags using a list of values.
operation: "add"| "remove"| "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<string> A list of cache tag values. Link to this property
Link to this property
AddCacheTagsExpression {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"| "remove"| "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 {operation, values } Remove cache tags using a list of values.
operation: "add"| "remove"| "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<string> A list of cache tag values. Link to this property
Link to this property
RemoveCacheTagsExpression {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"| "remove"| "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 {operation, values } Set cache tags using a list of values.
operation: "add"| "remove"| "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<string> A list of cache tag values. Link to this property
Link to this property
SetCacheTagsExpression {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"| "remove"| "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?: Array<string> The categories of the rule. Link to this property description?: string An informative description of the rule. Link to this property enabled?: boolean Link to this property
exposed\_credential\_check?: ExposedCredentialCheck {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?: string The expression defining which traffic will match the rule. minLength1 Link to this property
logging?: Logging {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
ratelimit?: Ratelimit {characteristics, period, counting\_expression, 5 more } An object configuring the rule’s rate limit behavior. characteristics: Array<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?: 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?: number Period of time in seconds after which the action will be disabled following its first execution. Link to this property requests\_per\_period?: 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?: boolean Whether counting is only performed when an origin is reached. Link to this property score\_per\_period?: number The score threshold per period for which the action will be executed the first time. Link to this property score\_response\_header\_name?: 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?: string The reference of the rule (the rule’s ID by default). minLength1 Link to this property
Link to this property
SetConfigRule {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?: string The unique ID of the rule. Link to this property action?: "set\_config" The action to perform when the rule matches. Link to this property
action\_parameters?: ActionParameters {automatic\_https\_rewrites, autominify, bic, 21 more } The parameters configuring the rule’s action. automatic\_https\_rewrites?: boolean Whether to enable Automatic HTTPS Rewrites. Link to this property
autominify?: Autominify {css, html, js } Which file extensions to minify automatically. css?: boolean Whether to minify CSS files. Link to this property html?: boolean Whether to minify HTML files. Link to this property js?: boolean Whether to minify JavaScript files. Link to this property
Link to this property bic?: boolean Whether to enable Browser Integrity Check (BIC). Link to this property content\_converter?: boolean Whether to enable content conversion (e.g., HTML to Markdown). Link to this property Deprecateddisable\_apps?: true Cloudflare Apps are deprected. Whether to disable Cloudflare Apps. Link to this property disable\_pay\_per\_crawl?: true Whether to disable Pay Per Crawl. Link to this property disable\_rum?: true Whether to disable Real User Monitoring (RUM). Link to this property disable\_zaraz?: true Whether to disable Zaraz. Link to this property email\_obfuscation?: boolean Whether to enable Email Obfuscation. Link to this property fonts?: boolean Whether to enable Cloudflare Fonts. Link to this property hotlink\_protection?: boolean Whether to enable Hotlink Protection. Link to this property Deprecatedmirage?: 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?: boolean Whether to enable Opportunistic Encryption. Link to this property
polish?: "off"| "lossless"| "lossy"| "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?: boolean Whether to redirect verified AI training crawlers to canonical URLs found in the HTML response. Link to this property
request\_body\_buffering?: "none"| "standard"| "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?: "none"| "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?: boolean Whether to enable Rocket Loader. Link to this property
security\_level?: "off"| "essentially\_off"| "low"| 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?: boolean Whether to enable Server-Side Excludes. Link to this property
ssl?: "off"| "flexible"| "full"| 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?: boolean Signed Exchanges (SXG) is deprecated. Whether to enable Signed Exchanges (SXG). Link to this property webmcp\_enabled?: boolean Whether to serve the WebMCP bridge script, which exposes the page’s tools to browser AI agents. Link to this property webmcp\_packs?: Array<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?: Array<string> The categories of the rule. Link to this property description?: string An informative description of the rule. Link to this property enabled?: boolean Link to this property
exposed\_credential\_check?: ExposedCredentialCheck {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?: string The expression defining which traffic will match the rule. minLength1 Link to this property
logging?: Logging {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
ratelimit?: Ratelimit {characteristics, period, counting\_expression, 5 more } An object configuring the rule’s rate limit behavior. characteristics: Array<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?: 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?: number Period of time in seconds after which the action will be disabled following its first execution. Link to this property requests\_per\_period?: 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?: boolean Whether counting is only performed when an origin is reached. Link to this property score\_per\_period?: number The score threshold per period for which the action will be executed the first time. Link to this property score\_response\_header\_name?: 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?: string The reference of the rule (the rule’s ID by default). minLength1 Link to this property
Link to this property
SkipRule {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?: string The unique ID of the rule. Link to this property action?: "skip" The action to perform when the rule matches. Link to this property
action\_parameters?: ActionParameters {phase, phases, products, 3 more } The parameters configuring the rule’s action. phase?: "current" A phase to skip the execution of. This option is only compatible with the products option. Link to this property
phases?: Array<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?: Array<"bic"| "hot"| "rateLimit"| 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?: Record<string, Array<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?: "current" A ruleset to skip the execution of. This option is incompatible with the rulesets option. Link to this property rulesets?: Array<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?: Array<string> The categories of the rule. Link to this property description?: string An informative description of the rule. Link to this property enabled?: boolean Link to this property
exposed\_credential\_check?: ExposedCredentialCheck {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?: string The expression defining which traffic will match the rule. minLength1 Link to this property
logging?: Logging {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
ratelimit?: Ratelimit {characteristics, period, counting\_expression, 5 more } An object configuring the rule’s rate limit behavior. characteristics: Array<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?: 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?: number Period of time in seconds after which the action will be disabled following its first execution. Link to this property requests\_per\_period?: 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?: boolean Whether counting is only performed when an origin is reached. Link to this property score\_per\_period?: number The score threshold per period for which the action will be executed the first time. Link to this property score\_response\_header\_name?: 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?: string The reference of the rule (the rule’s ID by default). minLength1 Link to this property
Link to this property
RulesetsTransformResponseHTMLRule {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?: 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
action\_parameters?: ActionParameters {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?: Array<string> The categories of the rule. Link to this property description?: string An informative description of the rule. Link to this property enabled?: boolean Link to this property
exposed\_credential\_check?: ExposedCredentialCheck {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?: string The expression defining which traffic will match the rule. minLength1 Link to this property
logging?: Logging {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
ratelimit?: Ratelimit {characteristics, period, counting\_expression, 5 more } An object configuring the rule’s rate limit behavior. characteristics: Array<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?: 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?: number Period of time in seconds after which the action will be disabled following its first execution. Link to this property requests\_per\_period?: 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?: boolean Whether counting is only performed when an origin is reached. Link to this property score\_per\_period?: number The score threshold per period for which the action will be executed the first time. Link to this property score\_response\_header\_name?: 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?: string The reference of the rule (the rule’s ID by default). minLength1 Link to this property
Link to this property
Link to this property
[Link to this property](<#(resource)%20rulesets%20%3E%20(method)%20create%20%3E%20(params)%20default>) ##### ReturnsExpand Collapse
RulesetCreateResponse = Ruleset {id, kind, last\_updated, 5 more } | unknown A result. One of the following:
Ruleset {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. One of the following: "managed" Link to this property "custom" Link to this property "root" Link to this property "zone" Link to this property
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. 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
rules: Array<BlockRule {id, action, enabled, 2 more } | ChallengeRule {id, action, enabled, 10 more } | ResponseCompressionRule {id, action, enabled, 2 more } | 18 more> The list of rules in the ruleset. One of the following:
BlockRule extends BlockRule {last\_updated, version, id, 10 more } {id, action, enabled, 2 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 {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?: unknown The parameters configuring the rule’s action. Link to this property categories?: Array<string> The categories of the rule. Link to this property description?: string An informative description of the rule. Link to this property
exposed\_credential\_check?: ExposedCredentialCheck {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?: Logging {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
ratelimit?: Ratelimit {characteristics, period, counting\_expression, 5 more } An object configuring the rule’s rate limit behavior. characteristics: Array<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?: 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?: number Period of time in seconds after which the action will be disabled following its first execution. Link to this property requests\_per\_period?: 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?: boolean Whether counting is only performed when an origin is reached. Link to this property score\_per\_period?: number The score threshold per period for which the action will be executed the first time. Link to this property score\_response\_header\_name?: 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 extends CompressResponseRule {last\_updated, version, id, 10 more } {id, action, enabled, 2 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 extends DDoSDynamicRule {last\_updated, version, id, 10 more } {id, action, enabled, 2 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 extends ExecuteRule {last\_updated, version, id, 10 more } {id, action, enabled, 2 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 extends ForceConnectionCloseRule {last\_updated, version, id, 10 more } {id, action, enabled, 2 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 {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?: unknown The parameters configuring the rule’s action. Link to this property categories?: Array<string> The categories of the rule. Link to this property description?: string An informative description of the rule. Link to this property
exposed\_credential\_check?: ExposedCredentialCheck {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?: Logging {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
ratelimit?: Ratelimit {characteristics, period, counting\_expression, 5 more } An object configuring the rule’s rate limit behavior. characteristics: Array<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?: 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?: number Period of time in seconds after which the action will be disabled following its first execution. Link to this property requests\_per\_period?: 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?: boolean Whether counting is only performed when an origin is reached. Link to this property score\_per\_period?: number The score threshold per period for which the action will be executed the first time. Link to this property score\_response\_header\_name?: 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 extends LogRule {last\_updated, version, id, 10 more } {id, action, enabled, 2 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 extends LogCustomFieldRule {last\_updated, version, id, 10 more } {id, action, enabled, 2 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 extends ManagedChallengeRule {last\_updated, version, id, 10 more } {id, action, enabled, 2 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 extends RedirectRule {last\_updated, version, id, 10 more } {id, action, enabled, 2 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 extends RewriteRule {last\_updated, version, id, 10 more } {id, action, enabled, 2 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 extends RouteRule {last\_updated, version, id, 10 more } {id, action, enabled, 2 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 extends ScoreRule {last\_updated, version, id, 10 more } {id, action, enabled, 2 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 extends ServeErrorRule {last\_updated, version, id, 10 more } {id, action, enabled, 2 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 {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?: ActionParameters {immutable, max-age, must-revalidate, 10 more } The parameters configuring the rule’s action.
immutable?: SetDirective {operation, cloudflare\_only } | RemoveDirective {operation, cloudflare\_only } A cache-control directive configuration. One of the following:
SetDirective {operation, cloudflare\_only } Set the directive.
operation: "set"| "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?: boolean Whether the directive should only be applied to the Cloudflare CDN cache. Link to this property
Link to this property
RemoveDirective {operation, cloudflare\_only } Remove the directive.
operation: "set"| "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?: 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"?: SetDirective {operation, value, cloudflare\_only } | RemoveDirective {operation, cloudflare\_only } A cache-control directive configuration that accepts a duration value in seconds. One of the following:
SetDirective {operation, value, cloudflare\_only } Set the directive with a duration value in seconds.
operation: "set"| "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?: boolean Whether the directive should only be applied to the Cloudflare CDN cache. Link to this property
Link to this property
RemoveDirective {operation, cloudflare\_only } Remove the directive.
operation: "set"| "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?: 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"?: SetDirective {operation, cloudflare\_only } | RemoveDirective {operation, cloudflare\_only } A cache-control directive configuration. One of the following:
SetDirective {operation, cloudflare\_only } Set the directive.
operation: "set"| "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?: boolean Whether the directive should only be applied to the Cloudflare CDN cache. Link to this property
Link to this property
RemoveDirective {operation, cloudflare\_only } Remove the directive.
operation: "set"| "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?: 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"?: SetDirective {operation, cloudflare\_only } | RemoveDirective {operation, cloudflare\_only } A cache-control directive configuration. One of the following:
SetDirective {operation, cloudflare\_only } Set the directive.
operation: "set"| "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?: boolean Whether the directive should only be applied to the Cloudflare CDN cache. Link to this property
Link to this property
RemoveDirective {operation, cloudflare\_only } Remove the directive.
operation: "set"| "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?: 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"?: SetDirective {operation, cloudflare\_only, qualifiers } | RemoveDirective {operation, cloudflare\_only } A cache-control directive configuration that accepts optional qualifiers (header names). One of the following:
SetDirective {operation, cloudflare\_only, qualifiers } Set the directive with optional qualifiers.
operation: "set"| "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?: boolean Whether the directive should only be applied to the Cloudflare CDN cache. Link to this property qualifiers?: Array<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 {operation, cloudflare\_only } Remove the directive.
operation: "set"| "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?: 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"?: SetDirective {operation, cloudflare\_only } | RemoveDirective {operation, cloudflare\_only } A cache-control directive configuration. One of the following:
SetDirective {operation, cloudflare\_only } Set the directive.
operation: "set"| "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?: boolean Whether the directive should only be applied to the Cloudflare CDN cache. Link to this property
Link to this property
RemoveDirective {operation, cloudflare\_only } Remove the directive.
operation: "set"| "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?: 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"?: SetDirective {operation, cloudflare\_only } | RemoveDirective {operation, cloudflare\_only } A cache-control directive configuration. One of the following:
SetDirective {operation, cloudflare\_only } Set the directive.
operation: "set"| "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?: boolean Whether the directive should only be applied to the Cloudflare CDN cache. Link to this property
Link to this property
RemoveDirective {operation, cloudflare\_only } Remove the directive.
operation: "set"| "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?: 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?: SetDirective {operation, cloudflare\_only, qualifiers } | RemoveDirective {operation, cloudflare\_only } A cache-control directive configuration that accepts optional qualifiers (header names). One of the following:
SetDirective {operation, cloudflare\_only, qualifiers } Set the directive with optional qualifiers.
operation: "set"| "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?: boolean Whether the directive should only be applied to the Cloudflare CDN cache. Link to this property qualifiers?: Array<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 {operation, cloudflare\_only } Remove the directive.
operation: "set"| "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?: 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"?: SetDirective {operation, cloudflare\_only } | RemoveDirective {operation, cloudflare\_only } A cache-control directive configuration. One of the following:
SetDirective {operation, cloudflare\_only } Set the directive.
operation: "set"| "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?: boolean Whether the directive should only be applied to the Cloudflare CDN cache. Link to this property
Link to this property
RemoveDirective {operation, cloudflare\_only } Remove the directive.
operation: "set"| "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?: 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?: SetDirective {operation, cloudflare\_only } | RemoveDirective {operation, cloudflare\_only } A cache-control directive configuration. One of the following:
SetDirective {operation, cloudflare\_only } Set the directive.
operation: "set"| "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?: boolean Whether the directive should only be applied to the Cloudflare CDN cache. Link to this property
Link to this property
RemoveDirective {operation, cloudflare\_only } Remove the directive.
operation: "set"| "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?: 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"?: SetDirective {operation, value, cloudflare\_only } | RemoveDirective {operation, cloudflare\_only } A cache-control directive configuration that accepts a duration value in seconds. One of the following:
SetDirective {operation, value, cloudflare\_only } Set the directive with a duration value in seconds.
operation: "set"| "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?: boolean Whether the directive should only be applied to the Cloudflare CDN cache. Link to this property
Link to this property
RemoveDirective {operation, cloudflare\_only } Remove the directive.
operation: "set"| "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?: 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"?: SetDirective {operation, value, cloudflare\_only } | RemoveDirective {operation, cloudflare\_only } A cache-control directive configuration that accepts a duration value in seconds. One of the following:
SetDirective {operation, value, cloudflare\_only } Set the directive with a duration value in seconds.
operation: "set"| "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?: boolean Whether the directive should only be applied to the Cloudflare CDN cache. Link to this property
Link to this property
RemoveDirective {operation, cloudflare\_only } Remove the directive.
operation: "set"| "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?: 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"?: SetDirective {operation, value, cloudflare\_only } | RemoveDirective {operation, cloudflare\_only } A cache-control directive configuration that accepts a duration value in seconds. One of the following:
SetDirective {operation, value, cloudflare\_only } Set the directive with a duration value in seconds.
operation: "set"| "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?: boolean Whether the directive should only be applied to the Cloudflare CDN cache. Link to this property
Link to this property
RemoveDirective {operation, cloudflare\_only } Remove the directive.
operation: "set"| "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?: 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?: Array<string> The categories of the rule. Link to this property description?: string An informative description of the rule. Link to this property
exposed\_credential\_check?: ExposedCredentialCheck {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?: Logging {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
ratelimit?: Ratelimit {characteristics, period, counting\_expression, 5 more } An object configuring the rule’s rate limit behavior. characteristics: Array<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?: 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?: number Period of time in seconds after which the action will be disabled following its first execution. Link to this property requests\_per\_period?: 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?: boolean Whether counting is only performed when an origin is reached. Link to this property score\_per\_period?: number The score threshold per period for which the action will be executed the first time. Link to this property score\_response\_header\_name?: 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 extends SetCacheSettingsRule {last\_updated, version, id, 10 more } {id, action, enabled, 2 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 {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?: AddCacheTagsValues {operation, values } | AddCacheTagsExpression {expression, operation } | RemoveCacheTagsValues {operation, values } | 3 more The parameters configuring the rule’s action. One of the following:
AddCacheTagsValues {operation, values } Add cache tags using a list of values.
operation: "add"| "remove"| "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<string> A list of cache tag values. Link to this property
Link to this property
AddCacheTagsExpression {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"| "remove"| "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 {operation, values } Remove cache tags using a list of values.
operation: "add"| "remove"| "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<string> A list of cache tag values. Link to this property
Link to this property
RemoveCacheTagsExpression {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"| "remove"| "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 {operation, values } Set cache tags using a list of values.
operation: "add"| "remove"| "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<string> A list of cache tag values. Link to this property
Link to this property
SetCacheTagsExpression {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"| "remove"| "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?: Array<string> The categories of the rule. Link to this property description?: string An informative description of the rule. Link to this property
exposed\_credential\_check?: ExposedCredentialCheck {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?: Logging {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
ratelimit?: Ratelimit {characteristics, period, counting\_expression, 5 more } An object configuring the rule’s rate limit behavior. characteristics: Array<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?: 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?: number Period of time in seconds after which the action will be disabled following its first execution. Link to this property requests\_per\_period?: 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?: boolean Whether counting is only performed when an origin is reached. Link to this property score\_per\_period?: number The score threshold per period for which the action will be executed the first time. Link to this property score\_response\_header\_name?: 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 extends SetConfigRule {last\_updated, version, id, 10 more } {id, action, enabled, 2 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 extends SkipRule {last\_updated, version, id, 10 more } {id, action, enabled, 2 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 {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?: ActionParameters {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?: Array<string> The categories of the rule. Link to this property description?: string An informative description of the rule. Link to this property
exposed\_credential\_check?: ExposedCredentialCheck {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?: Logging {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
ratelimit?: Ratelimit {characteristics, period, counting\_expression, 5 more } An object configuring the rule’s rate limit behavior. characteristics: Array<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?: 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?: number Period of time in seconds after which the action will be disabled following its first execution. Link to this property requests\_per\_period?: 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?: boolean Whether counting is only performed when an origin is reached. Link to this property score\_per\_period?: number The score threshold per period for which the action will be executed the first time. Link to this property score\_response\_header\_name?: 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?: string An informative description of the ruleset. Link to this property
Link to this property unknown Link to this property
[Link to this property](<#(resource)%20rulesets%20%3E%20(model)%20ruleset_create_response%20%3E%20(schema)>) ### Create an account or zone ruleset TypeScript HTTPTypeScriptPythonGoTerraform ``` import Cloudflare from 'cloudflare'; const client = new Cloudflare({ apiToken: process.env['CLOUDFLARE_API_TOKEN'], // This is the default and can be omitted }); const ruleset = await client.rulesets.create({ account_id: 'account_id' }); console.log(ruleset); ``` 200 example ``` { "errors": [ { "message": "something bad happened", "code": 10000, "source": { "pointer": "/rules/0/action" } } ], "messages": [ { "message": "something bad happened", "code": 10000, "source": { "pointer": "/rules/0/action" } } ], "result": { "id": "2f2feab2026849078ba485f918791bdc", "kind": "root", "last_updated": "2000-01-01T00:00:00Z", "name": "My ruleset", "phase": "http_request_firewall_custom", "rules": [ { "last_updated": "2000-01-01T00:00:00Z", "version": "1", "id": "id", "action": "action", "action_parameters": { "response": { "content": "{\n \"success\": false,\n \"error\": \"you have been blocked\"\n}", "content_type": "application/json", "status_code": 400 } }, "categories": [ "directory-traversal" ], "description": "Block the request.", "enabled": true, "exposed_credential_check": { "password_expression": "url_decode(http.request.body.form[\\\"password\\\"][0])", "username_expression": "url_decode(http.request.body.form[\\\"username\\\"][0])" }, "expression": "expression", "logging": { "enabled": true }, "ratelimit": { "characteristics": [ "cf.colo.id" ], "period": 60, "counting_expression": "http.request.body.raw eq \"abcd\"", "mitigation_timeout": 600, "requests_per_period": 1000, "requests_to_origin": true, "score_per_period": 400, "score_response_header_name": "my-score" }, "ref": "ref" } ], "version": "1", "description": "A description for my ruleset." }, "success": true } ``` ##### Returns Examples 200 example ``` { "errors": [ { "message": "something bad happened", "code": 10000, "source": { "pointer": "/rules/0/action" } } ], "messages": [ { "message": "something bad happened", "code": 10000, "source": { "pointer": "/rules/0/action" } } ], "result": { "id": "2f2feab2026849078ba485f918791bdc", "kind": "root", "last_updated": "2000-01-01T00:00:00Z", "name": "My ruleset", "phase": "http_request_firewall_custom", "rules": [ { "last_updated": "2000-01-01T00:00:00Z", "version": "1", "id": "id", "action": "action", "action_parameters": { "response": { "content": "{\n \"success\": false,\n \"error\": \"you have been blocked\"\n}", "content_type": "application/json", "status_code": 400 } }, "categories": [ "directory-traversal" ], "description": "Block the request.", "enabled": true, "exposed_credential_check": { "password_expression": "url_decode(http.request.body.form[\\\"password\\\"][0])", "username_expression": "url_decode(http.request.body.form[\\\"username\\\"][0])" }, "expression": "expression", "logging": { "enabled": true }, "ratelimit": { "characteristics": [ "cf.colo.id" ], "period": 60, "counting_expression": "http.request.body.raw eq \"abcd\"", "mitigation_timeout": 600, "requests_per_period": 1000, "requests_to_origin": true, "score_per_period": 400, "score_response_header_name": "my-score" }, "ref": "ref" } ], "version": "1", "description": "A description for my ruleset." }, "success": true } ```