--- title: Versions --- [Skip to content](#_top) [API Reference](https://developers.cloudflare.com/api) [Rulesets](https://developers.cloudflare.com/api/resources/rulesets) Copy Markdown Open in **Claude**Open in **ChatGPT**Open in **Cursor** --- **Copy Markdown****View as Markdown** # Versions ##### [List an account or zone ruleset's versions](https://developers.cloudflare.com/api/resources/rulesets/subresources/versions/methods/list) GET/{accounts\_or\_zones}/{account\_or\_zone\_id}/rulesets/{ruleset\_id}/versions ##### [Get an account or zone ruleset version](https://developers.cloudflare.com/api/resources/rulesets/subresources/versions/methods/get) GET/{accounts\_or\_zones}/{account\_or\_zone\_id}/rulesets/{ruleset\_id}/versions/{ruleset\_version} ##### [Delete an account or zone ruleset version](https://developers.cloudflare.com/api/resources/rulesets/subresources/versions/methods/delete) DELETE/{accounts\_or\_zones}/{account\_or\_zone\_id}/rulesets/{ruleset\_id}/versions/{ruleset\_version} ##### ModelsExpand Collapse
VersionListResponse object {id, kind, last\_updated, 4 more } A ruleset object. id: string The unique ID of the ruleset. Link to this property kind: Kind The kind of the ruleset. Link to this property last\_updated: string The timestamp of when the ruleset was last modified. formatdate-time Link to this property name: string The human-readable name of the ruleset. minLength1 Link to this property phase: Phase The phase of the ruleset. Link to this property 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](<#(resource)%20rulesets.versions%20%3E%20(model)%20version_list_response%20%3E%20(schema)>)
VersionGetResponse object {id, kind, last\_updated, 5 more } A ruleset object. id: string The unique ID of the ruleset. Link to this property kind: Kind The kind of the ruleset. Link to this property last\_updated: string The timestamp of when the ruleset was last modified. formatdate-time Link to this property name: string The human-readable name of the ruleset. minLength1 Link to this property phase: Phase The phase of the ruleset. Link to this property
rules: array of BlockRule { last\_updated, version, id, 10 more } or object {id, action, enabled, 10 more } or CompressResponseRule { last\_updated, version, id, 10 more } or 18 more The list of rules in the ruleset. One of the following:
BlockRule = BlockRule { last\_updated, version, id, 10 more } id: string Link to this property action: string Link to this property enabled: boolean Link to this property expression: string Link to this property ref: string Link to this property
Link to this property
ChallengeRule object {id, action, enabled, 10 more } id: string The unique ID of the rule. Link to this property action: "challenge" The action to perform when the rule matches. Link to this property enabled: boolean Whether the rule should be executed. Link to this property expression: string The expression defining which traffic will match the rule. minLength1 Link to this property last\_updated: string The timestamp of when the rule was last modified. formatdate-time Link to this property ref: string The reference of the rule (the rule’s ID by default). minLength1 Link to this property version: string The version of the rule. Link to this property action\_parameters: optional unknown The parameters configuring the rule’s action. Link to this property categories: optional array of string The categories of the rule. Link to this property description: optional string An informative description of the rule. Link to this property
exposed\_credential\_check: optional object {password\_expression, username\_expression } Configuration for exposed credential checking. password\_expression: string An expression that selects the password used in the credentials check. minLength1 Link to this property username\_expression: string An expression that selects the user ID used in the credentials check. minLength1 Link to this property
Link to this property logging: optional Logging { enabled } An object configuring the rule’s logging behavior. Link to this property
ratelimit: optional object {characteristics, period, counting\_expression, 5 more } An object configuring the rule’s rate limit behavior. characteristics: array of string Characteristics of the request on which the rate limit counter will be incremented. Link to this property period: number Period in seconds over which the counter is being incremented. minimum0 Link to this property counting\_expression: optional string An expression that defines when the rate limit counter should be incremented. It defaults to the same as the rule’s expression. minLength1 Link to this property mitigation\_timeout: optional number Period of time in seconds after which the action will be disabled following its first execution. Link to this property requests\_per\_period: optional number The threshold of requests per period after which the action will be executed for the first time. minimum1 Link to this property requests\_to\_origin: optional boolean Whether counting is only performed when an origin is reached. Link to this property score\_per\_period: optional number The score threshold per period for which the action will be executed the first time. Link to this property score\_response\_header\_name: optional string A response header name provided by the origin, which contains the score to increment rate limit counter with. minLength1 Link to this property
Link to this property
Link to this property
ResponseCompressionRule = CompressResponseRule { last\_updated, version, id, 10 more } id: string Link to this property action: string Link to this property enabled: boolean Link to this property expression: string Link to this property ref: string Link to this property
Link to this property
DDoSDynamicRule = DDoSDynamicRule { last\_updated, version, id, 10 more } id: string Link to this property action: string Link to this property enabled: boolean Link to this property expression: string Link to this property ref: string Link to this property
Link to this property
ExecuteRule = ExecuteRule { last\_updated, version, id, 10 more } id: string Link to this property action: string Link to this property enabled: boolean Link to this property expression: string Link to this property ref: string Link to this property
Link to this property
ForceConnectionCloseRule = ForceConnectionCloseRule { last\_updated, version, id, 10 more } id: string Link to this property action: string Link to this property enabled: boolean Link to this property expression: string Link to this property ref: string Link to this property
Link to this property
JavaScriptChallengeRule object {id, action, enabled, 10 more } id: string The unique ID of the rule. Link to this property action: "js\_challenge" The action to perform when the rule matches. Link to this property enabled: boolean Whether the rule should be executed. Link to this property expression: string The expression defining which traffic will match the rule. minLength1 Link to this property last\_updated: string The timestamp of when the rule was last modified. formatdate-time Link to this property ref: string The reference of the rule (the rule’s ID by default). minLength1 Link to this property version: string The version of the rule. Link to this property action\_parameters: optional unknown The parameters configuring the rule’s action. Link to this property categories: optional array of string The categories of the rule. Link to this property description: optional string An informative description of the rule. Link to this property
exposed\_credential\_check: optional object {password\_expression, username\_expression } Configuration for exposed credential checking. password\_expression: string An expression that selects the password used in the credentials check. minLength1 Link to this property username\_expression: string An expression that selects the user ID used in the credentials check. minLength1 Link to this property
Link to this property logging: optional Logging { enabled } An object configuring the rule’s logging behavior. Link to this property
ratelimit: optional object {characteristics, period, counting\_expression, 5 more } An object configuring the rule’s rate limit behavior. characteristics: array of string Characteristics of the request on which the rate limit counter will be incremented. Link to this property period: number Period in seconds over which the counter is being incremented. minimum0 Link to this property counting\_expression: optional string An expression that defines when the rate limit counter should be incremented. It defaults to the same as the rule’s expression. minLength1 Link to this property mitigation\_timeout: optional number Period of time in seconds after which the action will be disabled following its first execution. Link to this property requests\_per\_period: optional number The threshold of requests per period after which the action will be executed for the first time. minimum1 Link to this property requests\_to\_origin: optional boolean Whether counting is only performed when an origin is reached. Link to this property score\_per\_period: optional number The score threshold per period for which the action will be executed the first time. Link to this property score\_response\_header\_name: optional string A response header name provided by the origin, which contains the score to increment rate limit counter with. minLength1 Link to this property
Link to this property
Link to this property
LogRule = LogRule { last\_updated, version, id, 10 more } id: string Link to this property action: string Link to this property enabled: boolean Link to this property expression: string Link to this property ref: string Link to this property
Link to this property
LogCustomFieldRule = LogCustomFieldRule { last\_updated, version, id, 10 more } id: string Link to this property action: string Link to this property enabled: boolean Link to this property expression: string Link to this property ref: string Link to this property
Link to this property
ManagedChallengeRule = ManagedChallengeRule { last\_updated, version, id, 10 more } id: string Link to this property action: string Link to this property enabled: boolean Link to this property expression: string Link to this property ref: string Link to this property
Link to this property
RedirectRule = RedirectRule { last\_updated, version, id, 10 more } id: string Link to this property action: string Link to this property enabled: boolean Link to this property expression: string Link to this property ref: string Link to this property
Link to this property
RewriteRule = RewriteRule { last\_updated, version, id, 10 more } id: string Link to this property action: string Link to this property enabled: boolean Link to this property expression: string Link to this property ref: string Link to this property
Link to this property
RouteRule = RouteRule { last\_updated, version, id, 10 more } id: string Link to this property action: string Link to this property enabled: boolean Link to this property expression: string Link to this property ref: string Link to this property
Link to this property
ScoreRule = ScoreRule { last\_updated, version, id, 10 more } id: string Link to this property action: string Link to this property enabled: boolean Link to this property expression: string Link to this property ref: string Link to this property
Link to this property
ServeErrorRule = ServeErrorRule { last\_updated, version, id, 10 more } id: string Link to this property action: string Link to this property enabled: boolean Link to this property expression: string Link to this property ref: string Link to this property
Link to this property
SetCacheControlRule object {id, action, enabled, 10 more } id: string The unique ID of the rule. Link to this property action: "set\_cache\_control" The action to perform when the rule matches. Link to this property enabled: boolean Link to this property expression: string The expression defining which traffic will match the rule. minLength1 Link to this property last\_updated: string The timestamp of when the rule was last modified. formatdate-time Link to this property ref: string The reference of the rule (the rule’s ID by default). minLength1 Link to this property version: string The version of the rule. Link to this property
action\_parameters: optional object {immutable, "max-age", "must-revalidate", 10 more } The parameters configuring the rule’s action.
immutable: optional object {operation, cloudflare\_only } or object {operation, cloudflare\_only } A cache-control directive configuration. One of the following:
SetDirective object {operation, cloudflare\_only } Set the directive.
operation: "set"or "remove" The operation to perform on the cache-control directive. One of the following: "set" Link to this property "remove" Link to this property
Link to this property cloudflare\_only: optional boolean Whether the directive should only be applied to the Cloudflare CDN cache. Link to this property
Link to this property
RemoveDirective object {operation, cloudflare\_only } Remove the directive.
operation: "set"or "remove" The operation to perform on the cache-control directive. One of the following: "set" Link to this property "remove" Link to this property
Link to this property cloudflare\_only: optional boolean Whether the directive should only be applied to the Cloudflare CDN cache. Link to this property
Link to this property
Link to this property
"max-age": optional object {operation, value, cloudflare\_only } or object {operation, cloudflare\_only } A cache-control directive configuration that accepts a duration value in seconds. One of the following:
SetDirective object {operation, value, cloudflare\_only } Set the directive with a duration value in seconds.
operation: "set"or "remove" The operation to perform on the cache-control directive. One of the following: "set" Link to this property "remove" Link to this property
Link to this property value: number The duration value in seconds for the directive. minimum0 Link to this property cloudflare\_only: optional boolean Whether the directive should only be applied to the Cloudflare CDN cache. Link to this property
Link to this property
RemoveDirective object {operation, cloudflare\_only } Remove the directive.
operation: "set"or "remove" The operation to perform on the cache-control directive. One of the following: "set" Link to this property "remove" Link to this property
Link to this property cloudflare\_only: optional boolean Whether the directive should only be applied to the Cloudflare CDN cache. Link to this property
Link to this property
Link to this property
"must-revalidate": optional object {operation, cloudflare\_only } or object {operation, cloudflare\_only } A cache-control directive configuration. One of the following:
SetDirective object {operation, cloudflare\_only } Set the directive.
operation: "set"or "remove" The operation to perform on the cache-control directive. One of the following: "set" Link to this property "remove" Link to this property
Link to this property cloudflare\_only: optional boolean Whether the directive should only be applied to the Cloudflare CDN cache. Link to this property
Link to this property
RemoveDirective object {operation, cloudflare\_only } Remove the directive.
operation: "set"or "remove" The operation to perform on the cache-control directive. One of the following: "set" Link to this property "remove" Link to this property
Link to this property cloudflare\_only: optional boolean Whether the directive should only be applied to the Cloudflare CDN cache. Link to this property
Link to this property
Link to this property
"must-understand": optional object {operation, cloudflare\_only } or object {operation, cloudflare\_only } A cache-control directive configuration. One of the following:
SetDirective object {operation, cloudflare\_only } Set the directive.
operation: "set"or "remove" The operation to perform on the cache-control directive. One of the following: "set" Link to this property "remove" Link to this property
Link to this property cloudflare\_only: optional boolean Whether the directive should only be applied to the Cloudflare CDN cache. Link to this property
Link to this property
RemoveDirective object {operation, cloudflare\_only } Remove the directive.
operation: "set"or "remove" The operation to perform on the cache-control directive. One of the following: "set" Link to this property "remove" Link to this property
Link to this property cloudflare\_only: optional boolean Whether the directive should only be applied to the Cloudflare CDN cache. Link to this property
Link to this property
Link to this property
"no-cache": optional object {operation, cloudflare\_only, qualifiers } or object {operation, cloudflare\_only } A cache-control directive configuration that accepts optional qualifiers (header names). One of the following:
SetDirective object {operation, cloudflare\_only, qualifiers } Set the directive with optional qualifiers.
operation: "set"or "remove" The operation to perform on the cache-control directive. One of the following: "set" Link to this property "remove" Link to this property
Link to this property cloudflare\_only: optional boolean Whether the directive should only be applied to the Cloudflare CDN cache. Link to this property qualifiers: optional array of string Optional list of header names to qualify the directive (e.g., for “private” or “no-cache” directives). Link to this property
Link to this property
RemoveDirective object {operation, cloudflare\_only } Remove the directive.
operation: "set"or "remove" The operation to perform on the cache-control directive. One of the following: "set" Link to this property "remove" Link to this property
Link to this property cloudflare\_only: optional boolean Whether the directive should only be applied to the Cloudflare CDN cache. Link to this property
Link to this property
Link to this property
"no-store": optional object {operation, cloudflare\_only } or object {operation, cloudflare\_only } A cache-control directive configuration. One of the following:
SetDirective object {operation, cloudflare\_only } Set the directive.
operation: "set"or "remove" The operation to perform on the cache-control directive. One of the following: "set" Link to this property "remove" Link to this property
Link to this property cloudflare\_only: optional boolean Whether the directive should only be applied to the Cloudflare CDN cache. Link to this property
Link to this property
RemoveDirective object {operation, cloudflare\_only } Remove the directive.
operation: "set"or "remove" The operation to perform on the cache-control directive. One of the following: "set" Link to this property "remove" Link to this property
Link to this property cloudflare\_only: optional boolean Whether the directive should only be applied to the Cloudflare CDN cache. Link to this property
Link to this property
Link to this property
"no-transform": optional object {operation, cloudflare\_only } or object {operation, cloudflare\_only } A cache-control directive configuration. One of the following:
SetDirective object {operation, cloudflare\_only } Set the directive.
operation: "set"or "remove" The operation to perform on the cache-control directive. One of the following: "set" Link to this property "remove" Link to this property
Link to this property cloudflare\_only: optional boolean Whether the directive should only be applied to the Cloudflare CDN cache. Link to this property
Link to this property
RemoveDirective object {operation, cloudflare\_only } Remove the directive.
operation: "set"or "remove" The operation to perform on the cache-control directive. One of the following: "set" Link to this property "remove" Link to this property
Link to this property cloudflare\_only: optional boolean Whether the directive should only be applied to the Cloudflare CDN cache. Link to this property
Link to this property
Link to this property
private: optional object {operation, cloudflare\_only, qualifiers } or object {operation, cloudflare\_only } A cache-control directive configuration that accepts optional qualifiers (header names). One of the following:
SetDirective object {operation, cloudflare\_only, qualifiers } Set the directive with optional qualifiers.
operation: "set"or "remove" The operation to perform on the cache-control directive. One of the following: "set" Link to this property "remove" Link to this property
Link to this property cloudflare\_only: optional boolean Whether the directive should only be applied to the Cloudflare CDN cache. Link to this property qualifiers: optional array of string Optional list of header names to qualify the directive (e.g., for “private” or “no-cache” directives). Link to this property
Link to this property
RemoveDirective object {operation, cloudflare\_only } Remove the directive.
operation: "set"or "remove" The operation to perform on the cache-control directive. One of the following: "set" Link to this property "remove" Link to this property
Link to this property cloudflare\_only: optional boolean Whether the directive should only be applied to the Cloudflare CDN cache. Link to this property
Link to this property
Link to this property
"proxy-revalidate": optional object {operation, cloudflare\_only } or object {operation, cloudflare\_only } A cache-control directive configuration. One of the following:
SetDirective object {operation, cloudflare\_only } Set the directive.
operation: "set"or "remove" The operation to perform on the cache-control directive. One of the following: "set" Link to this property "remove" Link to this property
Link to this property cloudflare\_only: optional boolean Whether the directive should only be applied to the Cloudflare CDN cache. Link to this property
Link to this property
RemoveDirective object {operation, cloudflare\_only } Remove the directive.
operation: "set"or "remove" The operation to perform on the cache-control directive. One of the following: "set" Link to this property "remove" Link to this property
Link to this property cloudflare\_only: optional boolean Whether the directive should only be applied to the Cloudflare CDN cache. Link to this property
Link to this property
Link to this property
public: optional object {operation, cloudflare\_only } or object {operation, cloudflare\_only } A cache-control directive configuration. One of the following:
SetDirective object {operation, cloudflare\_only } Set the directive.
operation: "set"or "remove" The operation to perform on the cache-control directive. One of the following: "set" Link to this property "remove" Link to this property
Link to this property cloudflare\_only: optional boolean Whether the directive should only be applied to the Cloudflare CDN cache. Link to this property
Link to this property
RemoveDirective object {operation, cloudflare\_only } Remove the directive.
operation: "set"or "remove" The operation to perform on the cache-control directive. One of the following: "set" Link to this property "remove" Link to this property
Link to this property cloudflare\_only: optional boolean Whether the directive should only be applied to the Cloudflare CDN cache. Link to this property
Link to this property
Link to this property
"s-maxage": optional object {operation, value, cloudflare\_only } or object {operation, cloudflare\_only } A cache-control directive configuration that accepts a duration value in seconds. One of the following:
SetDirective object {operation, value, cloudflare\_only } Set the directive with a duration value in seconds.
operation: "set"or "remove" The operation to perform on the cache-control directive. One of the following: "set" Link to this property "remove" Link to this property
Link to this property value: number The duration value in seconds for the directive. minimum0 Link to this property cloudflare\_only: optional boolean Whether the directive should only be applied to the Cloudflare CDN cache. Link to this property
Link to this property
RemoveDirective object {operation, cloudflare\_only } Remove the directive.
operation: "set"or "remove" The operation to perform on the cache-control directive. One of the following: "set" Link to this property "remove" Link to this property
Link to this property cloudflare\_only: optional boolean Whether the directive should only be applied to the Cloudflare CDN cache. Link to this property
Link to this property
Link to this property
"stale-if-error": optional object {operation, value, cloudflare\_only } or object {operation, cloudflare\_only } A cache-control directive configuration that accepts a duration value in seconds. One of the following:
SetDirective object {operation, value, cloudflare\_only } Set the directive with a duration value in seconds.
operation: "set"or "remove" The operation to perform on the cache-control directive. One of the following: "set" Link to this property "remove" Link to this property
Link to this property value: number The duration value in seconds for the directive. minimum0 Link to this property cloudflare\_only: optional boolean Whether the directive should only be applied to the Cloudflare CDN cache. Link to this property
Link to this property
RemoveDirective object {operation, cloudflare\_only } Remove the directive.
operation: "set"or "remove" The operation to perform on the cache-control directive. One of the following: "set" Link to this property "remove" Link to this property
Link to this property cloudflare\_only: optional boolean Whether the directive should only be applied to the Cloudflare CDN cache. Link to this property
Link to this property
Link to this property
"stale-while-revalidate": optional object {operation, value, cloudflare\_only } or object {operation, cloudflare\_only } A cache-control directive configuration that accepts a duration value in seconds. One of the following:
SetDirective object {operation, value, cloudflare\_only } Set the directive with a duration value in seconds.
operation: "set"or "remove" The operation to perform on the cache-control directive. One of the following: "set" Link to this property "remove" Link to this property
Link to this property value: number The duration value in seconds for the directive. minimum0 Link to this property cloudflare\_only: optional boolean Whether the directive should only be applied to the Cloudflare CDN cache. Link to this property
Link to this property
RemoveDirective object {operation, cloudflare\_only } Remove the directive.
operation: "set"or "remove" The operation to perform on the cache-control directive. One of the following: "set" Link to this property "remove" Link to this property
Link to this property cloudflare\_only: optional boolean Whether the directive should only be applied to the Cloudflare CDN cache. Link to this property
Link to this property
Link to this property
Link to this property categories: optional array of string The categories of the rule. Link to this property description: optional string An informative description of the rule. Link to this property
exposed\_credential\_check: optional object {password\_expression, username\_expression } Configuration for exposed credential checking. password\_expression: string An expression that selects the password used in the credentials check. minLength1 Link to this property username\_expression: string An expression that selects the user ID used in the credentials check. minLength1 Link to this property
Link to this property logging: optional Logging { enabled } An object configuring the rule’s logging behavior. Link to this property
ratelimit: optional object {characteristics, period, counting\_expression, 5 more } An object configuring the rule’s rate limit behavior. characteristics: array of string Characteristics of the request on which the rate limit counter will be incremented. Link to this property period: number Period in seconds over which the counter is being incremented. minimum0 Link to this property counting\_expression: optional string An expression that defines when the rate limit counter should be incremented. It defaults to the same as the rule’s expression. minLength1 Link to this property mitigation\_timeout: optional number Period of time in seconds after which the action will be disabled following its first execution. Link to this property requests\_per\_period: optional number The threshold of requests per period after which the action will be executed for the first time. minimum1 Link to this property requests\_to\_origin: optional boolean Whether counting is only performed when an origin is reached. Link to this property score\_per\_period: optional number The score threshold per period for which the action will be executed the first time. Link to this property score\_response\_header\_name: optional string A response header name provided by the origin, which contains the score to increment rate limit counter with. minLength1 Link to this property
Link to this property
Link to this property
SetCacheSettingsRule = SetCacheSettingsRule { last\_updated, version, id, 10 more } id: string Link to this property action: string Link to this property enabled: boolean Link to this property expression: string Link to this property ref: string Link to this property
Link to this property
SetCacheTagsRule object {id, action, enabled, 10 more } id: string The unique ID of the rule. Link to this property action: "set\_cache\_tags" The action to perform when the rule matches. Link to this property enabled: boolean Link to this property expression: string The expression defining which traffic will match the rule. minLength1 Link to this property last\_updated: string The timestamp of when the rule was last modified. formatdate-time Link to this property ref: string The reference of the rule (the rule’s ID by default). minLength1 Link to this property version: string The version of the rule. Link to this property
action\_parameters: optional object {operation, values } or object {expression, operation } or object {operation, values } or 3 more The parameters configuring the rule’s action. One of the following:
AddCacheTagsValues object {operation, values } Add cache tags using a list of values.
operation: "add"or "remove"or "set" The operation to perform on the cache tags. One of the following: "add" Link to this property "remove" Link to this property "set" Link to this property
Link to this property values: array of string A list of cache tag values. Link to this property
Link to this property
AddCacheTagsExpression object {expression, operation } Add cache tags using an expression. expression: string An expression that evaluates to an array of cache tag values. minLength1 Link to this property
operation: "add"or "remove"or "set" The operation to perform on the cache tags. One of the following: "add" Link to this property "remove" Link to this property "set" Link to this property
Link to this property
Link to this property
RemoveCacheTagsValues object {operation, values } Remove cache tags using a list of values.
operation: "add"or "remove"or "set" The operation to perform on the cache tags. One of the following: "add" Link to this property "remove" Link to this property "set" Link to this property
Link to this property values: array of string A list of cache tag values. Link to this property
Link to this property
RemoveCacheTagsExpression object {expression, operation } Remove cache tags using an expression. expression: string An expression that evaluates to an array of cache tag values. minLength1 Link to this property
operation: "add"or "remove"or "set" The operation to perform on the cache tags. One of the following: "add" Link to this property "remove" Link to this property "set" Link to this property
Link to this property
Link to this property
SetCacheTagsValues object {operation, values } Set cache tags using a list of values.
operation: "add"or "remove"or "set" The operation to perform on the cache tags. One of the following: "add" Link to this property "remove" Link to this property "set" Link to this property
Link to this property values: array of string A list of cache tag values. Link to this property
Link to this property
SetCacheTagsExpression object {expression, operation } Set cache tags using an expression. expression: string An expression that evaluates to an array of cache tag values. minLength1 Link to this property
operation: "add"or "remove"or "set" The operation to perform on the cache tags. One of the following: "add" Link to this property "remove" Link to this property "set" Link to this property
Link to this property
Link to this property
Link to this property categories: optional array of string The categories of the rule. Link to this property description: optional string An informative description of the rule. Link to this property
exposed\_credential\_check: optional object {password\_expression, username\_expression } Configuration for exposed credential checking. password\_expression: string An expression that selects the password used in the credentials check. minLength1 Link to this property username\_expression: string An expression that selects the user ID used in the credentials check. minLength1 Link to this property
Link to this property logging: optional Logging { enabled } An object configuring the rule’s logging behavior. Link to this property
ratelimit: optional object {characteristics, period, counting\_expression, 5 more } An object configuring the rule’s rate limit behavior. characteristics: array of string Characteristics of the request on which the rate limit counter will be incremented. Link to this property period: number Period in seconds over which the counter is being incremented. minimum0 Link to this property counting\_expression: optional string An expression that defines when the rate limit counter should be incremented. It defaults to the same as the rule’s expression. minLength1 Link to this property mitigation\_timeout: optional number Period of time in seconds after which the action will be disabled following its first execution. Link to this property requests\_per\_period: optional number The threshold of requests per period after which the action will be executed for the first time. minimum1 Link to this property requests\_to\_origin: optional boolean Whether counting is only performed when an origin is reached. Link to this property score\_per\_period: optional number The score threshold per period for which the action will be executed the first time. Link to this property score\_response\_header\_name: optional string A response header name provided by the origin, which contains the score to increment rate limit counter with. minLength1 Link to this property
Link to this property
Link to this property
SetConfigurationRule = SetConfigRule { last\_updated, version, id, 10 more } id: string Link to this property action: string Link to this property enabled: boolean Link to this property expression: string Link to this property ref: string Link to this property
Link to this property
SkipRule = SkipRule { last\_updated, version, id, 10 more } id: string Link to this property action: string Link to this property enabled: boolean Link to this property expression: string Link to this property ref: string Link to this property
Link to this property
TransformResponseHTMLRule object {id, action, enabled, 10 more } id: string The unique ID of the rule. Link to this property action: "transform\_response\_html" The action to perform when the rule matches. Link to this property enabled: boolean Link to this property expression: string The expression defining which traffic will match the rule. minLength1 Link to this property last\_updated: string The timestamp of when the rule was last modified. formatdate-time Link to this property ref: string The reference of the rule (the rule’s ID by default). minLength1 Link to this property version: string The version of the rule. Link to this property
action\_parameters: optional object {link\_maze } The parameters configuring the rule’s action. link\_maze: unknown Enables the link maze transformation on the response. Link to this property
Link to this property categories: optional array of string The categories of the rule. Link to this property description: optional string An informative description of the rule. Link to this property
exposed\_credential\_check: optional object {password\_expression, username\_expression } Configuration for exposed credential checking. password\_expression: string An expression that selects the password used in the credentials check. minLength1 Link to this property username\_expression: string An expression that selects the user ID used in the credentials check. minLength1 Link to this property
Link to this property logging: optional Logging { enabled } An object configuring the rule’s logging behavior. Link to this property
ratelimit: optional object {characteristics, period, counting\_expression, 5 more } An object configuring the rule’s rate limit behavior. characteristics: array of string Characteristics of the request on which the rate limit counter will be incremented. Link to this property period: number Period in seconds over which the counter is being incremented. minimum0 Link to this property counting\_expression: optional string An expression that defines when the rate limit counter should be incremented. It defaults to the same as the rule’s expression. minLength1 Link to this property mitigation\_timeout: optional number Period of time in seconds after which the action will be disabled following its first execution. Link to this property requests\_per\_period: optional number The threshold of requests per period after which the action will be executed for the first time. minimum1 Link to this property requests\_to\_origin: optional boolean Whether counting is only performed when an origin is reached. Link to this property score\_per\_period: optional number The score threshold per period for which the action will be executed the first time. Link to this property score\_response\_header\_name: optional string A response header name provided by the origin, which contains the score to increment rate limit counter with. minLength1 Link to this property
Link to this property
Link to this property
Link to this property version: string The version of the ruleset. Link to this property description: optional string An informative description of the ruleset. Link to this property
[Link to this property](<#(resource)%20rulesets.versions%20%3E%20(model)%20version_get_response%20%3E%20(schema)>)