--- title: Create an account or zone ruleset rule --- [Skip to content](#_top) [API Reference](https://developers.cloudflare.com/api) [Rulesets](https://developers.cloudflare.com/api/resources/rulesets) [Rules](https://developers.cloudflare.com/api/resources/rulesets/subresources/rules) Copy Markdown Open in **Claude**Open in **ChatGPT**Open in **Cursor** --- **Copy Markdown****View as Markdown** # Create an account or zone ruleset rule POST/{accounts\_or\_zones}/{account\_or\_zone\_id}/rulesets/{ruleset\_id}/rules Adds a new rule to an account or zone ruleset. The rule will be added to the end of the existing list of rules in the ruleset by default. ##### 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` ##### P ath ParametersExpand Collapse ruleset\_id: string The unique ID of the ruleset. [Link to this property](<#(resource)%20rulesets.rules%20%3E%20(method)%20create%20%3E%20(params)%200%20%3E%20(param)%20ruleset_id%20%3E%20(schema)>) account\_id: optional string The Account ID to use for this endpoint. Mutually exclusive with the Zone ID. [Link to this property](<#(resource)%20rulesets.rules%20%3E%20(method)%20create%20%3E%20(params)%200%20%3E%20(param)%20account_id%20%3E%20(schema)>) zone\_id: optional string The Zone ID to use for this endpoint. Mutually exclusive with the Account ID. [Link to this property](<#(resource)%20rulesets.rules%20%3E%20(method)%20create%20%3E%20(params)%200%20%3E%20(param)%20zone_id%20%3E%20(schema)>) ##### Q uery ParametersExpand Collapse dry\_run: optional boolean 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](<#(resource)%20rulesets.rules%20%3E%20(method)%20create%20%3E%20(params)%200%20%3E%20(param)%20dry_run%20%3E%20(schema)>) ##### Body ParametersJSONExpand Collapse

body: BlockRule { last\_updated, version, id, 10 more } or object {last\_updated, version, id, 11 more } or CompressResponseRule { last\_updated, version, id, 10 more } or 18 more

One of the following:

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

position: optional object {before } or object {after } or object {index } An object configuring where the rule will be placed.

One of the following:

BeforePosition object {before } An object configuring where the rule will be placed.

before: optional string The ID of another rule to place the rule before. An empty value causes the rule to be placed at the top. Link to this property

Link to this property

AfterPosition object {after } An object configuring where the rule will be placed.

after: optional string The ID of another rule to place the rule after. An empty value causes the rule to be placed at the bottom. Link to this property

Link to this property

IndexPosition object {index } An object configuring where the rule will be placed.

index: optional number An index at which to place the rule, where index 1 is the first rule. minimum1 Link to this property

Link to this property

ChallengeRule object {last\_updated, version, id, 11 more }

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

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

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

Link to this property expression: optional string The expression defining which traffic will match the rule. minLength1 Link to this property

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

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

Link to this property

position: optional object {before } or object {after } or object {index } An object configuring where the rule will be placed.

One of the following:

BeforePosition object {before } An object configuring where the rule will be placed.

before: optional string The ID of another rule to place the rule before. An empty value causes the rule to be placed at the top. Link to this property

Link to this property

AfterPosition object {after } An object configuring where the rule will be placed.

after: optional string The ID of another rule to place the rule after. An empty value causes the rule to be placed at the bottom. Link to this property

Link to this property

IndexPosition object {index } An object configuring where the rule will be placed.

index: optional number An index at which to place the rule, where index 1 is the first rule. minimum1 Link to this property

Link to this property

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

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

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

Link to this property

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

position: optional object {before } or object {after } or object {index } An object configuring where the rule will be placed.

One of the following:

BeforePosition object {before } An object configuring where the rule will be placed.

before: optional string The ID of another rule to place the rule before. An empty value causes the rule to be placed at the top. Link to this property

Link to this property

AfterPosition object {after } An object configuring where the rule will be placed.

after: optional string The ID of another rule to place the rule after. An empty value causes the rule to be placed at the bottom. Link to this property

Link to this property

IndexPosition object {index } An object configuring where the rule will be placed.

index: optional number An index at which to place the rule, where index 1 is the first rule. minimum1 Link to this property

Link to this property

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

position: optional object {before } or object {after } or object {index } An object configuring where the rule will be placed.

One of the following:

BeforePosition object {before } An object configuring where the rule will be placed.

before: optional string The ID of another rule to place the rule before. An empty value causes the rule to be placed at the top. Link to this property

Link to this property

AfterPosition object {after } An object configuring where the rule will be placed.

after: optional string The ID of another rule to place the rule after. An empty value causes the rule to be placed at the bottom. Link to this property

Link to this property

IndexPosition object {index } An object configuring where the rule will be placed.

index: optional number An index at which to place the rule, where index 1 is the first rule. minimum1 Link to this property

Link to this property

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

position: optional object {before } or object {after } or object {index } An object configuring where the rule will be placed.

One of the following:

BeforePosition object {before } An object configuring where the rule will be placed.

before: optional string The ID of another rule to place the rule before. An empty value causes the rule to be placed at the top. Link to this property

Link to this property

AfterPosition object {after } An object configuring where the rule will be placed.

after: optional string The ID of another rule to place the rule after. An empty value causes the rule to be placed at the bottom. Link to this property

Link to this property

IndexPosition object {index } An object configuring where the rule will be placed.

index: optional number An index at which to place the rule, where index 1 is the first rule. minimum1 Link to this property

Link to this property

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

position: optional object {before } or object {after } or object {index } An object configuring where the rule will be placed.

One of the following:

BeforePosition object {before } An object configuring where the rule will be placed.

before: optional string The ID of another rule to place the rule before. An empty value causes the rule to be placed at the top. Link to this property

Link to this property

AfterPosition object {after } An object configuring where the rule will be placed.

after: optional string The ID of another rule to place the rule after. An empty value causes the rule to be placed at the bottom. Link to this property

Link to this property

IndexPosition object {index } An object configuring where the rule will be placed.

index: optional number An index at which to place the rule, where index 1 is the first rule. minimum1 Link to this property

Link to this property

JavaScriptChallengeRule object {last\_updated, version, id, 11 more }

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

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

Link to this property expression: optional string The expression defining which traffic will match the rule. minLength1 Link to this property

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

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

Link to this property

position: optional object {before } or object {after } or object {index } An object configuring where the rule will be placed.

One of the following:

BeforePosition object {before } An object configuring where the rule will be placed.

before: optional string The ID of another rule to place the rule before. An empty value causes the rule to be placed at the top. Link to this property

Link to this property

AfterPosition object {after } An object configuring where the rule will be placed.

after: optional string The ID of another rule to place the rule after. An empty value causes the rule to be placed at the bottom. Link to this property

Link to this property

IndexPosition object {index } An object configuring where the rule will be placed.

index: optional number An index at which to place the rule, where index 1 is the first rule. minimum1 Link to this property

Link to this property

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

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

Link to this property

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

position: optional object {before } or object {after } or object {index } An object configuring where the rule will be placed.

One of the following:

BeforePosition object {before } An object configuring where the rule will be placed.

before: optional string The ID of another rule to place the rule before. An empty value causes the rule to be placed at the top. Link to this property

Link to this property

AfterPosition object {after } An object configuring where the rule will be placed.

after: optional string The ID of another rule to place the rule after. An empty value causes the rule to be placed at the bottom. Link to this property

Link to this property

IndexPosition object {index } An object configuring where the rule will be placed.

index: optional number An index at which to place the rule, where index 1 is the first rule. minimum1 Link to this property

Link to this property

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

position: optional object {before } or object {after } or object {index } An object configuring where the rule will be placed.

One of the following:

BeforePosition object {before } An object configuring where the rule will be placed.

before: optional string The ID of another rule to place the rule before. An empty value causes the rule to be placed at the top. Link to this property

Link to this property

AfterPosition object {after } An object configuring where the rule will be placed.

after: optional string The ID of another rule to place the rule after. An empty value causes the rule to be placed at the bottom. Link to this property

Link to this property

IndexPosition object {index } An object configuring where the rule will be placed.

index: optional number An index at which to place the rule, where index 1 is the first rule. minimum1 Link to this property

Link to this property

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

position: optional object {before } or object {after } or object {index } An object configuring where the rule will be placed.

One of the following:

BeforePosition object {before } An object configuring where the rule will be placed.

before: optional string The ID of another rule to place the rule before. An empty value causes the rule to be placed at the top. Link to this property

Link to this property

AfterPosition object {after } An object configuring where the rule will be placed.

after: optional string The ID of another rule to place the rule after. An empty value causes the rule to be placed at the bottom. Link to this property

Link to this property

IndexPosition object {index } An object configuring where the rule will be placed.

index: optional number An index at which to place the rule, where index 1 is the first rule. minimum1 Link to this property

Link to this property

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

position: optional object {before } or object {after } or object {index } An object configuring where the rule will be placed.

One of the following:

BeforePosition object {before } An object configuring where the rule will be placed.

before: optional string The ID of another rule to place the rule before. An empty value causes the rule to be placed at the top. Link to this property

Link to this property

AfterPosition object {after } An object configuring where the rule will be placed.

after: optional string The ID of another rule to place the rule after. An empty value causes the rule to be placed at the bottom. Link to this property

Link to this property

IndexPosition object {index } An object configuring where the rule will be placed.

index: optional number An index at which to place the rule, where index 1 is the first rule. minimum1 Link to this property

Link to this property

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

position: optional object {before } or object {after } or object {index } An object configuring where the rule will be placed.

One of the following:

BeforePosition object {before } An object configuring where the rule will be placed.

before: optional string The ID of another rule to place the rule before. An empty value causes the rule to be placed at the top. Link to this property

Link to this property

AfterPosition object {after } An object configuring where the rule will be placed.

after: optional string The ID of another rule to place the rule after. An empty value causes the rule to be placed at the bottom. Link to this property

Link to this property

IndexPosition object {index } An object configuring where the rule will be placed.

index: optional number An index at which to place the rule, where index 1 is the first rule. minimum1 Link to this property

Link to this property

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

position: optional object {before } or object {after } or object {index } An object configuring where the rule will be placed.

One of the following:

BeforePosition object {before } An object configuring where the rule will be placed.

before: optional string The ID of another rule to place the rule before. An empty value causes the rule to be placed at the top. Link to this property

Link to this property

AfterPosition object {after } An object configuring where the rule will be placed.

after: optional string The ID of another rule to place the rule after. An empty value causes the rule to be placed at the bottom. Link to this property

Link to this property

IndexPosition object {index } An object configuring where the rule will be placed.

index: optional number An index at which to place the rule, where index 1 is the first rule. minimum1 Link to this property

Link to this property

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

position: optional object {before } or object {after } or object {index } An object configuring where the rule will be placed.

One of the following:

BeforePosition object {before } An object configuring where the rule will be placed.

before: optional string The ID of another rule to place the rule before. An empty value causes the rule to be placed at the top. Link to this property

Link to this property

AfterPosition object {after } An object configuring where the rule will be placed.

after: optional string The ID of another rule to place the rule after. An empty value causes the rule to be placed at the bottom. Link to this property

Link to this property

IndexPosition object {index } An object configuring where the rule will be placed.

index: optional number An index at which to place the rule, where index 1 is the first rule. minimum1 Link to this property

Link to this property

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

position: optional object {before } or object {after } or object {index } An object configuring where the rule will be placed.

One of the following:

BeforePosition object {before } An object configuring where the rule will be placed.

before: optional string The ID of another rule to place the rule before. An empty value causes the rule to be placed at the top. Link to this property

Link to this property

AfterPosition object {after } An object configuring where the rule will be placed.

after: optional string The ID of another rule to place the rule after. An empty value causes the rule to be placed at the bottom. Link to this property

Link to this property

IndexPosition object {index } An object configuring where the rule will be placed.

index: optional number An index at which to place the rule, where index 1 is the first rule. minimum1 Link to this property

Link to this property

SetCacheControlRule object {last\_updated, version, id, 11 more }

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

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

One of the following:

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

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

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

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

Link to this property

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

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

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

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

Link to this property

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

One of the following:

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

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

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

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

Link to this property

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

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

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

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

Link to this property

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

One of the following:

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

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

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

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

Link to this property

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

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

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

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

Link to this property

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

One of the following:

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

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

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

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

Link to this property

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

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

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

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

Link to this property

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

One of the following:

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

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

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

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

Link to this property

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

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

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

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

Link to this property

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

One of the following:

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

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

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

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

Link to this property

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

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

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

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

Link to this property

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

One of the following:

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

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

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

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

Link to this property

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

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

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

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

Link to this property

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

One of the following:

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

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

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

Link to this property

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

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

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

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

Link to this property

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

One of the following:

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

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

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

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

Link to this property

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

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

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

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

Link to this property

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

One of the following:

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

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

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

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

Link to this property

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

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

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

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

Link to this property

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

One of the following:

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

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

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

Link to this property

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

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

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

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

Link to this property

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

One of the following:

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

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

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

Link to this property

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

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

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

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

Link to this property

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

One of the following:

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

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

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

Link to this property

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

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

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

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

Link to this property

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

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

Link to this property expression: optional string The expression defining which traffic will match the rule. minLength1 Link to this property

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

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

Link to this property

position: optional object {before } or object {after } or object {index } An object configuring where the rule will be placed.

One of the following:

BeforePosition object {before } An object configuring where the rule will be placed.

before: optional string The ID of another rule to place the rule before. An empty value causes the rule to be placed at the top. Link to this property

Link to this property

AfterPosition object {after } An object configuring where the rule will be placed.

after: optional string The ID of another rule to place the rule after. An empty value causes the rule to be placed at the bottom. Link to this property

Link to this property

IndexPosition object {index } An object configuring where the rule will be placed.

index: optional number An index at which to place the rule, where index 1 is the first rule. minimum1 Link to this property

Link to this property

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

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

Link to this property

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

position: optional object {before } or object {after } or object {index } An object configuring where the rule will be placed.

One of the following:

BeforePosition object {before } An object configuring where the rule will be placed.

before: optional string The ID of another rule to place the rule before. An empty value causes the rule to be placed at the top. Link to this property

Link to this property

AfterPosition object {after } An object configuring where the rule will be placed.

after: optional string The ID of another rule to place the rule after. An empty value causes the rule to be placed at the bottom. Link to this property

Link to this property

IndexPosition object {index } An object configuring where the rule will be placed.

index: optional number An index at which to place the rule, where index 1 is the first rule. minimum1 Link to this property

Link to this property

SetCacheTagsRule object {last\_updated, version, id, 11 more }

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

One of the following:

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

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

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

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

Link to this property

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

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

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

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

Link to this property

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

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

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

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

Link to this property

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

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

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

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

Link to this property

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

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

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

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

Link to this property

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

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

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

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

Link to this property

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

Link to this property expression: optional string The expression defining which traffic will match the rule. minLength1 Link to this property

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

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

Link to this property

position: optional object {before } or object {after } or object {index } An object configuring where the rule will be placed.

One of the following:

BeforePosition object {before } An object configuring where the rule will be placed.

before: optional string The ID of another rule to place the rule before. An empty value causes the rule to be placed at the top. Link to this property

Link to this property

AfterPosition object {after } An object configuring where the rule will be placed.

after: optional string The ID of another rule to place the rule after. An empty value causes the rule to be placed at the bottom. Link to this property

Link to this property

IndexPosition object {index } An object configuring where the rule will be placed.

index: optional number An index at which to place the rule, where index 1 is the first rule. minimum1 Link to this property

Link to this property

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

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

Link to this property

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

position: optional object {before } or object {after } or object {index } An object configuring where the rule will be placed.

One of the following:

BeforePosition object {before } An object configuring where the rule will be placed.

before: optional string The ID of another rule to place the rule before. An empty value causes the rule to be placed at the top. Link to this property

Link to this property

AfterPosition object {after } An object configuring where the rule will be placed.

after: optional string The ID of another rule to place the rule after. An empty value causes the rule to be placed at the bottom. Link to this property

Link to this property

IndexPosition object {index } An object configuring where the rule will be placed.

index: optional number An index at which to place the rule, where index 1 is the first rule. minimum1 Link to this property

Link to this property

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

position: optional object {before } or object {after } or object {index } An object configuring where the rule will be placed.

One of the following:

BeforePosition object {before } An object configuring where the rule will be placed.

before: optional string The ID of another rule to place the rule before. An empty value causes the rule to be placed at the top. Link to this property

Link to this property

AfterPosition object {after } An object configuring where the rule will be placed.

after: optional string The ID of another rule to place the rule after. An empty value causes the rule to be placed at the bottom. Link to this property

Link to this property

IndexPosition object {index } An object configuring where the rule will be placed.

index: optional number An index at which to place the rule, where index 1 is the first rule. minimum1 Link to this property

Link to this property

TransformResponseHTMLRule object {last\_updated, version, id, 11 more }

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

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

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

Link to this property expression: optional string The expression defining which traffic will match the rule. minLength1 Link to this property

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

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

Link to this property

position: optional object {before } or object {after } or object {index } An object configuring where the rule will be placed.

One of the following:

BeforePosition object {before } An object configuring where the rule will be placed.

before: optional string The ID of another rule to place the rule before. An empty value causes the rule to be placed at the top. Link to this property

Link to this property

AfterPosition object {after } An object configuring where the rule will be placed.

after: optional string The ID of another rule to place the rule after. An empty value causes the rule to be placed at the bottom. Link to this property

Link to this property

IndexPosition object {index } An object configuring where the rule will be placed.

index: optional number An index at which to place the rule, where index 1 is the first rule. minimum1 Link to this property

Link to this property

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

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

Link to this property

[Link to this property](<#(resource)%20rulesets.rules%20%3E%20(method)%20create%20%3E%20(params)%200%20%3E%20(param)%20body%20%3E%20(schema)>) ##### ReturnsExpand Collapse

errors: array of object {message, code, source } A list of error messages.

message: string A text description of this message. minLength1 Link to this property code: optional number A unique code for this message. Link to this property

source: optional object {pointer } The source of this message.

pointer: string A JSON pointer to the field that is the source of the message. minLength1 Link to this property

Link to this property

[Link to this property](<#(resource)%20rulesets.rules%20%3E%20(method)%20create%20%3E%20(network%20schema)%20%3E%20(property)%20errors>)

messages: array of object {message, code, source } A list of warning messages.

message: string A text description of this message. minLength1 Link to this property code: optional number A unique code for this message. Link to this property

source: optional object {pointer } The source of this message.

pointer: string A JSON pointer to the field that is the source of the message. minLength1 Link to this property

Link to this property

[Link to this property](<#(resource)%20rulesets.rules%20%3E%20(method)%20create%20%3E%20(network%20schema)%20%3E%20(property)%20messages>)

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

One of the following:

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

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

kind: Kind The kind of the ruleset.

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 of BlockRule { last\_updated, version, id, 10 more } or object {id, action, enabled, 10 more } or CompressResponseRule { last\_updated, version, id, 10 more } or 18 more The list of rules in the ruleset.

One of the following:

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

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

Link to this property

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

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

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

Link to this property

logging: optional 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: optional object {characteristics, period, counting\_expression, 5 more } An object configuring the rule’s rate limit behavior.

Link to this property

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

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

Link to this property

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

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

Link to this property

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

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

Link to this property

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

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

Link to this property

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

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

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

Link to this property

logging: optional 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: optional object {characteristics, period, counting\_expression, 5 more } An object configuring the rule’s rate limit behavior.

Link to this property

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

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

Link to this property

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

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

Link to this property

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

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

Link to this property

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

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

Link to this property

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

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

Link to this property

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

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

Link to this property

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

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

Link to this property

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

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

Link to this property

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

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

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

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

One of the following:

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

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

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

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

Link to this property

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

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

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

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

Link to this property

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

One of the following:

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

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

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

Link to this property

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

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

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

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

Link to this property

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

One of the following:

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

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

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

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

Link to this property

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

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

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

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

Link to this property

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

One of the following:

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

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

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

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

Link to this property

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

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

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

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

Link to this property

One of the following:

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

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

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

Link to this property

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

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

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

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

Link to this property

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

One of the following:

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

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

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

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

Link to this property

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

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

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

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

Link to this property

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

One of the following:

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

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

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

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

Link to this property

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

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

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

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

Link to this property

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

One of the following:

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

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

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

Link to this property

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

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

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

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

Link to this property

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

One of the following:

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

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

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

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

Link to this property

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

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

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

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

Link to this property

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

One of the following:

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

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

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

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

Link to this property

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

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

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

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

Link to this property

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

One of the following:

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

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

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

Link to this property

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

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

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

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

Link to this property

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

One of the following:

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

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

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

Link to this property

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

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

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

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

Link to this property

One of the following:

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

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

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

Link to this property

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

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

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

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

Link to this property

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

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

Link to this property

logging: optional 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: optional object {characteristics, period, counting\_expression, 5 more } An object configuring the rule’s rate limit behavior.

Link to this property

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

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

Link to this property

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

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

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

One of the following:

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

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

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

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

Link to this property

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

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

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

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

Link to this property

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

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

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

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

Link to this property

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

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

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

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

Link to this property

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

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

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

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

Link to this property

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

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

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

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

Link to this property

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

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

Link to this property

logging: optional 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: optional object {characteristics, period, counting\_expression, 5 more } An object configuring the rule’s rate limit behavior.

Link to this property

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

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

Link to this property

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

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

Link to this property

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

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

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

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

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

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

Link to this property

logging: optional 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: optional object {characteristics, period, counting\_expression, 5 more } An object configuring the rule’s rate limit behavior.

Link to this property

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

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

[Link to this property](<#(resource)%20rulesets.rules%20%3E%20(method)%20create%20%3E%20(network%20schema)%20%3E%20(property)%20result>) success: true Whether the API call was successful. [Link to this property](<#(resource)%20rulesets.rules%20%3E%20(method)%20create%20%3E%20(network%20schema)%20%3E%20(property)%20success>) ### Create an account or zone ruleset rule HTTP HTTPTypeScriptPythonGoTerraform ``` curl https://api.cloudflare.com/client/v4/$ACCOUNTS_OR_ZONES/$ACCOUNT_OR_ZONE_ID/rulesets/$RULESET_ID/rules \ -H 'Content-Type: application/json' \ -H "Authorization: Bearer $CLOUDFLARE_API_TOKEN" \ -d '{ "id": "3a03d665bac047339bb530ecb439a90d", "description": "Block the request.", "enabled": true, "expression": "ip.src eq 1.1.1.1", "ref": "my_ref" }' ``` 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 } ```