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