--- title: Update an account or zone entry point ruleset --- [Skip to content](#_top) [API Reference](https://developers.cloudflare.com/api/go) [Rulesets](https://developers.cloudflare.com/api/go/resources/rulesets) [Phases](https://developers.cloudflare.com/api/go/resources/rulesets/subresources/phases) Copy Markdown Open in **Claude**Open in **ChatGPT**Open in **Cursor** --- **Copy Markdown****View as Markdown** # Update an account or zone entry point ruleset client.Rulesets.Phases.Update(ctx, rulesetPhase, params) (\*PhaseUpdateResponseEnvelopeResult, error) PUT/{accounts\_or\_zones}/{account\_or\_zone\_id}/rulesets/phases/{ruleset\_phase}/entrypoint Updates an account or zone entry point ruleset, creating a new version. ##### Security
API Token The preferred authorization scheme for interacting with the Cloudflare API. Create a token. **Example:**Authorization: Bearer Sn3lZJTBX6kkg7OdcBUAxOO963GEIyGQqnFTOFYY
API Email + API Key The previous authorization scheme for interacting with the Cloudflare API, used in conjunction with a Global API key. **Example:**X-Auth-Email: user@example.com The previous authorization scheme for interacting with the Cloudflare API. When possible, use API tokens instead of Global API keys. **Example:**X-Auth-Key: 144c9defac04969c7bfad8efaa8ea194
##### Accepted Permissions (at least one required) `Mass URL Redirects Write``Magic Firewall Write``L4 DDoS Managed Ruleset Write``Transform Rules Write``Select Configuration Write``Account WAF Write``Account Rulesets Write``Logs Write` ##### ParametersExpand Collapse
RulesetPhase Phase The phase of the ruleset. One of the following: const PhaseDDoSL4 Phase = "ddos\_l4" Link to this property const PhaseDDoSL7 Phase = "ddos\_l7" Link to this property const PhaseHTTPConfigSettings Phase = "http\_config\_settings" Link to this property const PhaseHTTPCustomErrors Phase = "http\_custom\_errors" Link to this property const PhaseHTTPLogCustomFields Phase = "http\_log\_custom\_fields" Link to this property const PhaseHTTPRatelimit Phase = "http\_ratelimit" Link to this property const PhaseHTTPRequestCacheSettings Phase = "http\_request\_cache\_settings" Link to this property const PhaseHTTPRequestDynamicRedirect Phase = "http\_request\_dynamic\_redirect" Link to this property const PhaseHTTPRequestFirewallCustom Phase = "http\_request\_firewall\_custom" Link to this property const PhaseHTTPRequestFirewallManaged Phase = "http\_request\_firewall\_managed" Link to this property const PhaseHTTPRequestLateTransform Phase = "http\_request\_late\_transform" Link to this property const PhaseHTTPRequestOrigin Phase = "http\_request\_origin" Link to this property const PhaseHTTPRequestRedirect Phase = "http\_request\_redirect" Link to this property const PhaseHTTPRequestSanitize Phase = "http\_request\_sanitize" Link to this property const PhaseHTTPRequestSBFM Phase = "http\_request\_sbfm" Link to this property const PhaseHTTPRequestTransform Phase = "http\_request\_transform" Link to this property const PhaseHTTPResponseCacheSettings Phase = "http\_response\_cache\_settings" Link to this property const PhaseHTTPResponseCompression Phase = "http\_response\_compression" Link to this property const PhaseHTTPResponseFirewallManaged Phase = "http\_response\_firewall\_managed" Link to this property const PhaseHTTPResponseHeadersTransform Phase = "http\_response\_headers\_transform" Link to this property const PhaseMagicTransit Phase = "magic\_transit" Link to this property const PhaseMagicTransitIDsManaged Phase = "magic\_transit\_ids\_managed" Link to this property const PhaseMagicTransitManaged Phase = "magic\_transit\_managed" Link to this property const PhaseMagicTransitRatelimit Phase = "magic\_transit\_ratelimit" Link to this property
[Link to this property](<#(resource)%20rulesets.phases%20%3E%20(method)%20update%20%3E%20(params)%20default%20%3E%20(param)%20ruleset_phase%20%3E%20(schema)>)
params PhaseUpdateParams AccountID param.Field\[string]Optional Path param: The Account ID to use for this endpoint. Mutually exclusive with the Zone ID. Link to this property ZoneID param.Field\[string]Optional Path param: The Zone ID to use for this endpoint. Mutually exclusive with the Account ID. Link to this property DryRun param.Field\[bool]Optional Query param: Validates the request without persisting changes when set to true. Responses that normally return 200 return result: null; endpoints that normally return 204 continue to return 204. Link to this property Description param.Field\[string]Optional Body param: An informative description of the ruleset. Link to this property Name param.Field\[string]Optional Body param: The human-readable name of the ruleset. minLength1 Link to this property
Rules param.Field\[\[]PhaseUpdateParamsRule]Optional Body param: The list of rules in the ruleset.
type BlockRuleParam struct{…} LastUpdated Time The timestamp of when the rule was last modified. formatdate-time Link to this property Version string The version of the rule. Link to this property ID stringOptional The unique ID of the rule. Link to this property Action BlockRuleActionOptional The action to perform when the rule matches. Link to this property
ActionParameters BlockRuleActionParametersOptional The parameters configuring the rule’s action.
Response BlockRuleActionParametersResponseOptional The response to show when the block is applied. Content string The content to return. minLength1 Link to this property ContentType string The type of the content to return. minLength1 Link to this property StatusCode int64 The status code to return. maximum499 minimum400 Link to this property
Link to this property
Link to this property Categories \[]stringOptional The categories of the rule. Link to this property Description stringOptional An informative description of the rule. Link to this property Enabled boolOptional Whether the rule should be executed. Link to this property
ExposedCredentialCheck BlockRuleExposedCredentialCheckOptional Configuration for exposed credential checking. PasswordExpression string An expression that selects the password used in the credentials check. minLength1 Link to this property UsernameExpression string An expression that selects the user ID used in the credentials check. minLength1 Link to this property
Link to this property Expression stringOptional The expression defining which traffic will match the rule. minLength1 Link to this property
Logging LoggingOptional An object configuring the rule’s logging behavior. Enabled bool Whether to generate a log when the rule matches. Link to this property
Link to this property
Ratelimit BlockRuleRatelimitOptional An object configuring the rule’s rate limit behavior. Characteristics \[]string Characteristics of the request on which the rate limit counter will be incremented. Link to this property Period int64 Period in seconds over which the counter is being incremented. minimum0 Link to this property CountingExpression stringOptional 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 MitigationTimeout int64Optional Period of time in seconds after which the action will be disabled following its first execution. Link to this property RequestsPerPeriod int64Optional The threshold of requests per period after which the action will be executed for the first time. minimum1 Link to this property RequestsToOrigin boolOptional Whether counting is only performed when an origin is reached. Link to this property ScorePerPeriod int64Optional The score threshold per period for which the action will be executed the first time. Link to this property ScoreResponseHeaderName stringOptional A response header name provided by the origin, which contains the score to increment rate limit counter with. minLength1 Link to this property
Link to this property Ref stringOptional The reference of the rule (the rule’s ID by default). minLength1 Link to this property
Link to this property
type PhaseUpdateParamsRulesRulesetsChallengeRule struct{…} LastUpdated Time The timestamp of when the rule was last modified. formatdate-time Link to this property Version string The version of the rule. Link to this property ID stringOptional The unique ID of the rule. Link to this property Action PhaseUpdateParamsRulesRulesetsChallengeRuleActionOptional The action to perform when the rule matches. Link to this property ActionParameters unknownOptional The parameters configuring the rule’s action. Link to this property Categories \[]stringOptional The categories of the rule. Link to this property Description stringOptional An informative description of the rule. Link to this property Enabled boolOptional Whether the rule should be executed. Link to this property
ExposedCredentialCheck PhaseUpdateParamsRulesRulesetsChallengeRuleExposedCredentialCheckOptional Configuration for exposed credential checking. PasswordExpression string An expression that selects the password used in the credentials check. minLength1 Link to this property UsernameExpression string An expression that selects the user ID used in the credentials check. minLength1 Link to this property
Link to this property Expression stringOptional The expression defining which traffic will match the rule. minLength1 Link to this property
Logging LoggingOptional An object configuring the rule’s logging behavior. Enabled bool Whether to generate a log when the rule matches. Link to this property
Link to this property
Ratelimit PhaseUpdateParamsRulesRulesetsChallengeRuleRatelimitOptional An object configuring the rule’s rate limit behavior. Characteristics \[]string Characteristics of the request on which the rate limit counter will be incremented. Link to this property Period int64 Period in seconds over which the counter is being incremented. minimum0 Link to this property CountingExpression stringOptional 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 MitigationTimeout int64Optional Period of time in seconds after which the action will be disabled following its first execution. Link to this property RequestsPerPeriod int64Optional The threshold of requests per period after which the action will be executed for the first time. minimum1 Link to this property RequestsToOrigin boolOptional Whether counting is only performed when an origin is reached. Link to this property ScorePerPeriod int64Optional The score threshold per period for which the action will be executed the first time. Link to this property ScoreResponseHeaderName stringOptional A response header name provided by the origin, which contains the score to increment rate limit counter with. minLength1 Link to this property
Link to this property Ref stringOptional The reference of the rule (the rule’s ID by default). minLength1 Link to this property
Link to this property
type CompressResponseRuleParam struct{…} LastUpdated Time The timestamp of when the rule was last modified. formatdate-time Link to this property Version string The version of the rule. Link to this property ID stringOptional The unique ID of the rule. Link to this property Action CompressResponseRuleActionOptional The action to perform when the rule matches. Link to this property
ActionParameters CompressResponseRuleActionParametersOptional The parameters configuring the rule’s action.
Algorithms \[]CompressResponseRuleActionParametersAlgorithm Custom order for compression algorithms.
Name CompressResponseRuleActionParametersAlgorithmsNameOptional Name of the compression algorithm to enable. One of the following: const CompressResponseRuleActionParametersAlgorithmsNameNone CompressResponseRuleActionParametersAlgorithmsName = "none" Link to this property const CompressResponseRuleActionParametersAlgorithmsNameAuto CompressResponseRuleActionParametersAlgorithmsName = "auto" Link to this property const CompressResponseRuleActionParametersAlgorithmsNameDefault CompressResponseRuleActionParametersAlgorithmsName = "default" Link to this property const CompressResponseRuleActionParametersAlgorithmsNameGzip CompressResponseRuleActionParametersAlgorithmsName = "gzip" Link to this property const CompressResponseRuleActionParametersAlgorithmsNameBrotli CompressResponseRuleActionParametersAlgorithmsName = "brotli" Link to this property const CompressResponseRuleActionParametersAlgorithmsNameZstd CompressResponseRuleActionParametersAlgorithmsName = "zstd" Link to this property
Link to this property
Link to this property
Link to this property Categories \[]stringOptional The categories of the rule. Link to this property Description stringOptional An informative description of the rule. Link to this property Enabled boolOptional Whether the rule should be executed. Link to this property
ExposedCredentialCheck CompressResponseRuleExposedCredentialCheckOptional Configuration for exposed credential checking. PasswordExpression string An expression that selects the password used in the credentials check. minLength1 Link to this property UsernameExpression string An expression that selects the user ID used in the credentials check. minLength1 Link to this property
Link to this property Expression stringOptional The expression defining which traffic will match the rule. minLength1 Link to this property
Logging LoggingOptional An object configuring the rule’s logging behavior. Enabled bool Whether to generate a log when the rule matches. Link to this property
Link to this property
Ratelimit CompressResponseRuleRatelimitOptional An object configuring the rule’s rate limit behavior. Characteristics \[]string Characteristics of the request on which the rate limit counter will be incremented. Link to this property Period int64 Period in seconds over which the counter is being incremented. minimum0 Link to this property CountingExpression stringOptional 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 MitigationTimeout int64Optional Period of time in seconds after which the action will be disabled following its first execution. Link to this property RequestsPerPeriod int64Optional The threshold of requests per period after which the action will be executed for the first time. minimum1 Link to this property RequestsToOrigin boolOptional Whether counting is only performed when an origin is reached. Link to this property ScorePerPeriod int64Optional The score threshold per period for which the action will be executed the first time. Link to this property ScoreResponseHeaderName stringOptional A response header name provided by the origin, which contains the score to increment rate limit counter with. minLength1 Link to this property
Link to this property Ref stringOptional The reference of the rule (the rule’s ID by default). minLength1 Link to this property
Link to this property
type DDoSDynamicRuleParam struct{…} LastUpdated Time The timestamp of when the rule was last modified. formatdate-time Link to this property Version string The version of the rule. Link to this property ID stringOptional The unique ID of the rule. Link to this property Action DDoSDynamicRuleActionOptional The action to perform when the rule matches. Link to this property ActionParameters unknownOptional The parameters configuring the rule’s action. Link to this property Categories \[]stringOptional The categories of the rule. Link to this property Description stringOptional An informative description of the rule. Link to this property Enabled boolOptional Whether the rule should be executed. Link to this property
ExposedCredentialCheck DDoSDynamicRuleExposedCredentialCheckOptional Configuration for exposed credential checking. PasswordExpression string An expression that selects the password used in the credentials check. minLength1 Link to this property UsernameExpression string An expression that selects the user ID used in the credentials check. minLength1 Link to this property
Link to this property Expression stringOptional The expression defining which traffic will match the rule. minLength1 Link to this property
Logging LoggingOptional An object configuring the rule’s logging behavior. Enabled bool Whether to generate a log when the rule matches. Link to this property
Link to this property
Ratelimit DDoSDynamicRuleRatelimitOptional An object configuring the rule’s rate limit behavior. Characteristics \[]string Characteristics of the request on which the rate limit counter will be incremented. Link to this property Period int64 Period in seconds over which the counter is being incremented. minimum0 Link to this property CountingExpression stringOptional 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 MitigationTimeout int64Optional Period of time in seconds after which the action will be disabled following its first execution. Link to this property RequestsPerPeriod int64Optional The threshold of requests per period after which the action will be executed for the first time. minimum1 Link to this property RequestsToOrigin boolOptional Whether counting is only performed when an origin is reached. Link to this property ScorePerPeriod int64Optional The score threshold per period for which the action will be executed the first time. Link to this property ScoreResponseHeaderName stringOptional A response header name provided by the origin, which contains the score to increment rate limit counter with. minLength1 Link to this property
Link to this property Ref stringOptional The reference of the rule (the rule’s ID by default). minLength1 Link to this property
Link to this property
type ExecuteRuleParam struct{…} LastUpdated Time The timestamp of when the rule was last modified. formatdate-time Link to this property Version string The version of the rule. Link to this property ID stringOptional The unique ID of the rule. Link to this property Action ExecuteRuleActionOptional The action to perform when the rule matches. Link to this property
ActionParameters ExecuteRuleActionParametersOptional The parameters configuring the rule’s action. ID string The ID of the ruleset to execute. Link to this property
MatchedData ExecuteRuleActionParametersMatchedDataOptional The configuration to use for matched data logging. PublicKey string The public key to encrypt matched data logs with. minLength1 Link to this property
Link to this property
Overrides ExecuteRuleActionParametersOverridesOptional A set of overrides to apply to the target ruleset. Action stringOptional An action to override all rules with. This option has lower precedence than rule and category overrides. Link to this property
Categories \[]ExecuteRuleActionParametersOverridesCategoryOptional A list of category-level overrides. This option has the second-highest precedence after rule-level overrides. Category string The name of the category to override. minLength1 Link to this property Action stringOptional The action to override rules in the category with. Link to this property Enabled boolOptional Whether to enable execution of rules in the category. Link to this property
SensitivityLevel ExecuteRuleActionParametersOverridesCategoriesSensitivityLevelOptional The sensitivity level to use for rules in the category. This option is only applicable for DDoS phases. One of the following: const ExecuteRuleActionParametersOverridesCategoriesSensitivityLevelDefault ExecuteRuleActionParametersOverridesCategoriesSensitivityLevel = "default" Link to this property const ExecuteRuleActionParametersOverridesCategoriesSensitivityLevelMedium ExecuteRuleActionParametersOverridesCategoriesSensitivityLevel = "medium" Link to this property const ExecuteRuleActionParametersOverridesCategoriesSensitivityLevelLow ExecuteRuleActionParametersOverridesCategoriesSensitivityLevel = "low" Link to this property const ExecuteRuleActionParametersOverridesCategoriesSensitivityLevelEoff ExecuteRuleActionParametersOverridesCategoriesSensitivityLevel = "eoff" Link to this property
Link to this property
Link to this property Enabled boolOptional Whether to enable execution of all rules. This option has lower precedence than rule and category overrides. Link to this property
Rules \[]ExecuteRuleActionParametersOverridesRuleOptional A list of rule-level overrides. This option has the highest precedence. ID string The ID of the rule to override. Link to this property Action stringOptional The action to override the rule with. Link to this property Enabled boolOptional Whether to enable execution of the rule. Link to this property ScoreThreshold int64Optional The score threshold to use for the rule. Link to this property
SensitivityLevel ExecuteRuleActionParametersOverridesRulesSensitivityLevelOptional The sensitivity level to use for the rule. This option is only applicable for DDoS phases. One of the following: const ExecuteRuleActionParametersOverridesRulesSensitivityLevelDefault ExecuteRuleActionParametersOverridesRulesSensitivityLevel = "default" Link to this property const ExecuteRuleActionParametersOverridesRulesSensitivityLevelMedium ExecuteRuleActionParametersOverridesRulesSensitivityLevel = "medium" Link to this property const ExecuteRuleActionParametersOverridesRulesSensitivityLevelLow ExecuteRuleActionParametersOverridesRulesSensitivityLevel = "low" Link to this property const ExecuteRuleActionParametersOverridesRulesSensitivityLevelEoff ExecuteRuleActionParametersOverridesRulesSensitivityLevel = "eoff" Link to this property
Link to this property
Link to this property
SensitivityLevel ExecuteRuleActionParametersOverridesSensitivityLevelOptional A sensitivity level to set for all rules. This option has lower precedence than rule and category overrides and is only applicable for DDoS phases. One of the following: const ExecuteRuleActionParametersOverridesSensitivityLevelDefault ExecuteRuleActionParametersOverridesSensitivityLevel = "default" Link to this property const ExecuteRuleActionParametersOverridesSensitivityLevelMedium ExecuteRuleActionParametersOverridesSensitivityLevel = "medium" Link to this property const ExecuteRuleActionParametersOverridesSensitivityLevelLow ExecuteRuleActionParametersOverridesSensitivityLevel = "low" Link to this property const ExecuteRuleActionParametersOverridesSensitivityLevelEoff ExecuteRuleActionParametersOverridesSensitivityLevel = "eoff" Link to this property
Link to this property
Link to this property
Link to this property Categories \[]stringOptional The categories of the rule. Link to this property Description stringOptional An informative description of the rule. Link to this property Enabled boolOptional Whether the rule should be executed. Link to this property
ExposedCredentialCheck ExecuteRuleExposedCredentialCheckOptional Configuration for exposed credential checking. PasswordExpression string An expression that selects the password used in the credentials check. minLength1 Link to this property UsernameExpression string An expression that selects the user ID used in the credentials check. minLength1 Link to this property
Link to this property Expression stringOptional The expression defining which traffic will match the rule. minLength1 Link to this property
Logging LoggingOptional An object configuring the rule’s logging behavior. Enabled bool Whether to generate a log when the rule matches. Link to this property
Link to this property
Ratelimit ExecuteRuleRatelimitOptional An object configuring the rule’s rate limit behavior. Characteristics \[]string Characteristics of the request on which the rate limit counter will be incremented. Link to this property Period int64 Period in seconds over which the counter is being incremented. minimum0 Link to this property CountingExpression stringOptional 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 MitigationTimeout int64Optional Period of time in seconds after which the action will be disabled following its first execution. Link to this property RequestsPerPeriod int64Optional The threshold of requests per period after which the action will be executed for the first time. minimum1 Link to this property RequestsToOrigin boolOptional Whether counting is only performed when an origin is reached. Link to this property ScorePerPeriod int64Optional The score threshold per period for which the action will be executed the first time. Link to this property ScoreResponseHeaderName stringOptional A response header name provided by the origin, which contains the score to increment rate limit counter with. minLength1 Link to this property
Link to this property Ref stringOptional The reference of the rule (the rule’s ID by default). minLength1 Link to this property
Link to this property
type ForceConnectionCloseRuleParam struct{…} LastUpdated Time The timestamp of when the rule was last modified. formatdate-time Link to this property Version string The version of the rule. Link to this property ID stringOptional The unique ID of the rule. Link to this property Action ForceConnectionCloseRuleActionOptional The action to perform when the rule matches. Link to this property ActionParameters unknownOptional The parameters configuring the rule’s action. Link to this property Categories \[]stringOptional The categories of the rule. Link to this property Description stringOptional An informative description of the rule. Link to this property Enabled boolOptional Whether the rule should be executed. Link to this property
ExposedCredentialCheck ForceConnectionCloseRuleExposedCredentialCheckOptional Configuration for exposed credential checking. PasswordExpression string An expression that selects the password used in the credentials check. minLength1 Link to this property UsernameExpression string An expression that selects the user ID used in the credentials check. minLength1 Link to this property
Link to this property Expression stringOptional The expression defining which traffic will match the rule. minLength1 Link to this property
Logging LoggingOptional An object configuring the rule’s logging behavior. Enabled bool Whether to generate a log when the rule matches. Link to this property
Link to this property
Ratelimit ForceConnectionCloseRuleRatelimitOptional An object configuring the rule’s rate limit behavior. Characteristics \[]string Characteristics of the request on which the rate limit counter will be incremented. Link to this property Period int64 Period in seconds over which the counter is being incremented. minimum0 Link to this property CountingExpression stringOptional 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 MitigationTimeout int64Optional Period of time in seconds after which the action will be disabled following its first execution. Link to this property RequestsPerPeriod int64Optional The threshold of requests per period after which the action will be executed for the first time. minimum1 Link to this property RequestsToOrigin boolOptional Whether counting is only performed when an origin is reached. Link to this property ScorePerPeriod int64Optional The score threshold per period for which the action will be executed the first time. Link to this property ScoreResponseHeaderName stringOptional A response header name provided by the origin, which contains the score to increment rate limit counter with. minLength1 Link to this property
Link to this property Ref stringOptional The reference of the rule (the rule’s ID by default). minLength1 Link to this property
Link to this property
type PhaseUpdateParamsRulesRulesetsJSChallengeRule struct{…} LastUpdated Time The timestamp of when the rule was last modified. formatdate-time Link to this property Version string The version of the rule. Link to this property ID stringOptional The unique ID of the rule. Link to this property Action PhaseUpdateParamsRulesRulesetsJSChallengeRuleActionOptional The action to perform when the rule matches. Link to this property ActionParameters unknownOptional The parameters configuring the rule’s action. Link to this property Categories \[]stringOptional The categories of the rule. Link to this property Description stringOptional An informative description of the rule. Link to this property Enabled boolOptional Whether the rule should be executed. Link to this property
ExposedCredentialCheck PhaseUpdateParamsRulesRulesetsJSChallengeRuleExposedCredentialCheckOptional Configuration for exposed credential checking. PasswordExpression string An expression that selects the password used in the credentials check. minLength1 Link to this property UsernameExpression string An expression that selects the user ID used in the credentials check. minLength1 Link to this property
Link to this property Expression stringOptional The expression defining which traffic will match the rule. minLength1 Link to this property
Logging LoggingOptional An object configuring the rule’s logging behavior. Enabled bool Whether to generate a log when the rule matches. Link to this property
Link to this property
Ratelimit PhaseUpdateParamsRulesRulesetsJSChallengeRuleRatelimitOptional An object configuring the rule’s rate limit behavior. Characteristics \[]string Characteristics of the request on which the rate limit counter will be incremented. Link to this property Period int64 Period in seconds over which the counter is being incremented. minimum0 Link to this property CountingExpression stringOptional 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 MitigationTimeout int64Optional Period of time in seconds after which the action will be disabled following its first execution. Link to this property RequestsPerPeriod int64Optional The threshold of requests per period after which the action will be executed for the first time. minimum1 Link to this property RequestsToOrigin boolOptional Whether counting is only performed when an origin is reached. Link to this property ScorePerPeriod int64Optional The score threshold per period for which the action will be executed the first time. Link to this property ScoreResponseHeaderName stringOptional A response header name provided by the origin, which contains the score to increment rate limit counter with. minLength1 Link to this property
Link to this property Ref stringOptional The reference of the rule (the rule’s ID by default). minLength1 Link to this property
Link to this property
type LogRuleParam struct{…} LastUpdated Time The timestamp of when the rule was last modified. formatdate-time Link to this property Version string The version of the rule. Link to this property ID stringOptional The unique ID of the rule. Link to this property Action LogRuleActionOptional The action to perform when the rule matches. Link to this property ActionParameters unknownOptional The parameters configuring the rule’s action. Link to this property Categories \[]stringOptional The categories of the rule. Link to this property Description stringOptional An informative description of the rule. Link to this property Enabled boolOptional Whether the rule should be executed. Link to this property
ExposedCredentialCheck LogRuleExposedCredentialCheckOptional Configuration for exposed credential checking. PasswordExpression string An expression that selects the password used in the credentials check. minLength1 Link to this property UsernameExpression string An expression that selects the user ID used in the credentials check. minLength1 Link to this property
Link to this property Expression stringOptional The expression defining which traffic will match the rule. minLength1 Link to this property
Logging LoggingOptional An object configuring the rule’s logging behavior. Enabled bool Whether to generate a log when the rule matches. Link to this property
Link to this property
Ratelimit LogRuleRatelimitOptional An object configuring the rule’s rate limit behavior. Characteristics \[]string Characteristics of the request on which the rate limit counter will be incremented. Link to this property Period int64 Period in seconds over which the counter is being incremented. minimum0 Link to this property CountingExpression stringOptional 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 MitigationTimeout int64Optional Period of time in seconds after which the action will be disabled following its first execution. Link to this property RequestsPerPeriod int64Optional The threshold of requests per period after which the action will be executed for the first time. minimum1 Link to this property RequestsToOrigin boolOptional Whether counting is only performed when an origin is reached. Link to this property ScorePerPeriod int64Optional The score threshold per period for which the action will be executed the first time. Link to this property ScoreResponseHeaderName stringOptional A response header name provided by the origin, which contains the score to increment rate limit counter with. minLength1 Link to this property
Link to this property Ref stringOptional The reference of the rule (the rule’s ID by default). minLength1 Link to this property
Link to this property
type LogCustomFieldRuleParam struct{…} LastUpdated Time The timestamp of when the rule was last modified. formatdate-time Link to this property Version string The version of the rule. Link to this property ID stringOptional The unique ID of the rule. Link to this property Action LogCustomFieldRuleActionOptional The action to perform when the rule matches. Link to this property
ActionParameters LogCustomFieldRuleActionParametersOptional The parameters configuring the rule’s action.
CookieFields \[]LogCustomFieldRuleActionParametersCookieFieldOptional The cookie fields to log. Name string The name of the cookie. minLength1 Link to this property
Link to this property
RawResponseFields \[]LogCustomFieldRuleActionParametersRawResponseFieldOptional The raw response fields to log. Name string The name of the response header. minLength1 Link to this property PreserveDuplicates boolOptional Whether to log duplicate values of the same header. Link to this property
Link to this property
RequestFields \[]LogCustomFieldRuleActionParametersRequestFieldOptional The raw request fields to log. Name string The name of the header. minLength1 Link to this property
Link to this property
ResponseFields \[]LogCustomFieldRuleActionParametersResponseFieldOptional The transformed response fields to log. Name string The name of the response header. minLength1 Link to this property PreserveDuplicates boolOptional Whether to log duplicate values of the same header. Link to this property
Link to this property
TransformedRequestFields \[]LogCustomFieldRuleActionParametersTransformedRequestFieldOptional The transformed request fields to log. Name string The name of the header. minLength1 Link to this property
Link to this property
Link to this property Categories \[]stringOptional The categories of the rule. Link to this property Description stringOptional An informative description of the rule. Link to this property Enabled boolOptional Whether the rule should be executed. Link to this property
ExposedCredentialCheck LogCustomFieldRuleExposedCredentialCheckOptional Configuration for exposed credential checking. PasswordExpression string An expression that selects the password used in the credentials check. minLength1 Link to this property UsernameExpression string An expression that selects the user ID used in the credentials check. minLength1 Link to this property
Link to this property Expression stringOptional The expression defining which traffic will match the rule. minLength1 Link to this property
Logging LoggingOptional An object configuring the rule’s logging behavior. Enabled bool Whether to generate a log when the rule matches. Link to this property
Link to this property
Ratelimit LogCustomFieldRuleRatelimitOptional An object configuring the rule’s rate limit behavior. Characteristics \[]string Characteristics of the request on which the rate limit counter will be incremented. Link to this property Period int64 Period in seconds over which the counter is being incremented. minimum0 Link to this property CountingExpression stringOptional 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 MitigationTimeout int64Optional Period of time in seconds after which the action will be disabled following its first execution. Link to this property RequestsPerPeriod int64Optional The threshold of requests per period after which the action will be executed for the first time. minimum1 Link to this property RequestsToOrigin boolOptional Whether counting is only performed when an origin is reached. Link to this property ScorePerPeriod int64Optional The score threshold per period for which the action will be executed the first time. Link to this property ScoreResponseHeaderName stringOptional A response header name provided by the origin, which contains the score to increment rate limit counter with. minLength1 Link to this property
Link to this property Ref stringOptional The reference of the rule (the rule’s ID by default). minLength1 Link to this property
Link to this property
type ManagedChallengeRuleParam struct{…} LastUpdated Time The timestamp of when the rule was last modified. formatdate-time Link to this property Version string The version of the rule. Link to this property ID stringOptional The unique ID of the rule. Link to this property Action ManagedChallengeRuleActionOptional The action to perform when the rule matches. Link to this property ActionParameters unknownOptional The parameters configuring the rule’s action. Link to this property Categories \[]stringOptional The categories of the rule. Link to this property Description stringOptional An informative description of the rule. Link to this property Enabled boolOptional Whether the rule should be executed. Link to this property
ExposedCredentialCheck ManagedChallengeRuleExposedCredentialCheckOptional Configuration for exposed credential checking. PasswordExpression string An expression that selects the password used in the credentials check. minLength1 Link to this property UsernameExpression string An expression that selects the user ID used in the credentials check. minLength1 Link to this property
Link to this property Expression stringOptional The expression defining which traffic will match the rule. minLength1 Link to this property
Logging LoggingOptional An object configuring the rule’s logging behavior. Enabled bool Whether to generate a log when the rule matches. Link to this property
Link to this property
Ratelimit ManagedChallengeRuleRatelimitOptional An object configuring the rule’s rate limit behavior. Characteristics \[]string Characteristics of the request on which the rate limit counter will be incremented. Link to this property Period int64 Period in seconds over which the counter is being incremented. minimum0 Link to this property CountingExpression stringOptional 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 MitigationTimeout int64Optional Period of time in seconds after which the action will be disabled following its first execution. Link to this property RequestsPerPeriod int64Optional The threshold of requests per period after which the action will be executed for the first time. minimum1 Link to this property RequestsToOrigin boolOptional Whether counting is only performed when an origin is reached. Link to this property ScorePerPeriod int64Optional The score threshold per period for which the action will be executed the first time. Link to this property ScoreResponseHeaderName stringOptional A response header name provided by the origin, which contains the score to increment rate limit counter with. minLength1 Link to this property
Link to this property Ref stringOptional The reference of the rule (the rule’s ID by default). minLength1 Link to this property
Link to this property
type RedirectRuleParam struct{…} LastUpdated Time The timestamp of when the rule was last modified. formatdate-time Link to this property Version string The version of the rule. Link to this property ID stringOptional The unique ID of the rule. Link to this property Action RedirectRuleActionOptional The action to perform when the rule matches. Link to this property
ActionParameters RedirectRuleActionParametersOptional The parameters configuring the rule’s action.
FromList RedirectRuleActionParametersFromListOptional A redirect based on a bulk list lookup. Key string An expression that evaluates to the list lookup key. minLength1 Link to this property Name string The name of the list to match against. Link to this property
Link to this property
FromValue RedirectRuleActionParametersFromValueOptional A redirect based on the request properties.
TargetURL RedirectRuleActionParametersFromValueTargetURL A URL to redirect the request to. Expression stringOptional An expression that evaluates to a URL to redirect the request to. minLength1 Link to this property Value stringOptional A URL to redirect the request to. minLength1 Link to this property
Link to this property PreserveQueryString boolOptional Whether to keep the query string of the original request. Link to this property
StatusCode RedirectRuleActionParametersFromValueStatusCodeOptional The status code to use for the redirect. One of the following: const RedirectRuleActionParametersFromValueStatusCode301 RedirectRuleActionParametersFromValueStatusCode = 301 Link to this property const RedirectRuleActionParametersFromValueStatusCode302 RedirectRuleActionParametersFromValueStatusCode = 302 Link to this property const RedirectRuleActionParametersFromValueStatusCode303 RedirectRuleActionParametersFromValueStatusCode = 303 Link to this property const RedirectRuleActionParametersFromValueStatusCode307 RedirectRuleActionParametersFromValueStatusCode = 307 Link to this property const RedirectRuleActionParametersFromValueStatusCode308 RedirectRuleActionParametersFromValueStatusCode = 308 Link to this property
Link to this property
Link to this property
Link to this property Categories \[]stringOptional The categories of the rule. Link to this property Description stringOptional An informative description of the rule. Link to this property Enabled boolOptional Whether the rule should be executed. Link to this property
ExposedCredentialCheck RedirectRuleExposedCredentialCheckOptional Configuration for exposed credential checking. PasswordExpression string An expression that selects the password used in the credentials check. minLength1 Link to this property UsernameExpression string An expression that selects the user ID used in the credentials check. minLength1 Link to this property
Link to this property Expression stringOptional The expression defining which traffic will match the rule. minLength1 Link to this property
Logging LoggingOptional An object configuring the rule’s logging behavior. Enabled bool Whether to generate a log when the rule matches. Link to this property
Link to this property
Ratelimit RedirectRuleRatelimitOptional An object configuring the rule’s rate limit behavior. Characteristics \[]string Characteristics of the request on which the rate limit counter will be incremented. Link to this property Period int64 Period in seconds over which the counter is being incremented. minimum0 Link to this property CountingExpression stringOptional 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 MitigationTimeout int64Optional Period of time in seconds after which the action will be disabled following its first execution. Link to this property RequestsPerPeriod int64Optional The threshold of requests per period after which the action will be executed for the first time. minimum1 Link to this property RequestsToOrigin boolOptional Whether counting is only performed when an origin is reached. Link to this property ScorePerPeriod int64Optional The score threshold per period for which the action will be executed the first time. Link to this property ScoreResponseHeaderName stringOptional A response header name provided by the origin, which contains the score to increment rate limit counter with. minLength1 Link to this property
Link to this property Ref stringOptional The reference of the rule (the rule’s ID by default). minLength1 Link to this property
Link to this property
type RewriteRuleParam struct{…} LastUpdated Time The timestamp of when the rule was last modified. formatdate-time Link to this property Version string The version of the rule. Link to this property ID stringOptional The unique ID of the rule. Link to this property Action RewriteRuleActionOptional The action to perform when the rule matches. Link to this property
ActionParameters RewriteRuleActionParametersOptional The parameters configuring the rule’s action.
Headers map\[string, RewriteRuleActionParametersHeader]Optional A map of headers to rewrite. One of the following:
type RewriteRuleActionParametersHeadersAddStaticHeaderParam struct{…} A header with a static value to add. Operation RewriteRuleActionParametersHeadersAddStaticHeaderOperation The operation to perform on the header. Link to this property Value string A static value for the header. minLength1 Link to this property
Link to this property
type RewriteRuleActionParametersHeadersAddDynamicHeaderParam struct{…} A header with a dynamic value to add. Expression string An expression that evaluates to a value for the header. minLength1 Link to this property Operation RewriteRuleActionParametersHeadersAddDynamicHeaderOperation The operation to perform on the header. Link to this property
Link to this property
type RewriteRuleActionParametersHeadersSetStaticHeaderParam struct{…} A header with a static value to set. Operation RewriteRuleActionParametersHeadersSetStaticHeaderOperation The operation to perform on the header. Link to this property Value string A static value for the header. minLength1 Link to this property
Link to this property
type RewriteRuleActionParametersHeadersSetDynamicHeaderParam struct{…} A header with a dynamic value to set. Expression string An expression that evaluates to a value for the header. minLength1 Link to this property Operation RewriteRuleActionParametersHeadersSetDynamicHeaderOperation The operation to perform on the header. Link to this property
Link to this property
type RewriteRuleActionParametersHeadersRemoveHeaderParam struct{…} A header to remove. Operation RewriteRuleActionParametersHeadersRemoveHeaderOperation The operation to perform on the header. Link to this property
Link to this property
Link to this property
URI RewriteRuleActionParametersURIOptional A URI path rewrite. One of the following:
type RewriteRuleActionParametersURIURIPathParam struct{…} A URI path rewrite.
Path RewriteRuleActionParametersURIURIPathPath A URI path rewrite. Expression stringOptional An expression that evaluates to a value to rewrite the URI path to. minLength1 Link to this property Value stringOptional A value to rewrite the URI path to. minLength1 Link to this property
Link to this property Origin boolOptional Whether to propagate the rewritten URI to origin. Link to this property
Link to this property
type RewriteRuleActionParametersURIURIQueryParam struct{…} A URI query rewrite.
Query RewriteRuleActionParametersURIURIQueryQuery A URI query rewrite. Expression stringOptional An expression that evaluates to a value to rewrite the URI query to. minLength1 Link to this property Value stringOptional A value to rewrite the URI query to. Link to this property
Link to this property Origin boolOptional Whether to propagate the rewritten URI to origin. Link to this property
Link to this property
Link to this property
Link to this property Categories \[]stringOptional The categories of the rule. Link to this property Description stringOptional An informative description of the rule. Link to this property Enabled boolOptional Whether the rule should be executed. Link to this property
ExposedCredentialCheck RewriteRuleExposedCredentialCheckOptional Configuration for exposed credential checking. PasswordExpression string An expression that selects the password used in the credentials check. minLength1 Link to this property UsernameExpression string An expression that selects the user ID used in the credentials check. minLength1 Link to this property
Link to this property Expression stringOptional The expression defining which traffic will match the rule. minLength1 Link to this property
Logging LoggingOptional An object configuring the rule’s logging behavior. Enabled bool Whether to generate a log when the rule matches. Link to this property
Link to this property
Ratelimit RewriteRuleRatelimitOptional An object configuring the rule’s rate limit behavior. Characteristics \[]string Characteristics of the request on which the rate limit counter will be incremented. Link to this property Period int64 Period in seconds over which the counter is being incremented. minimum0 Link to this property CountingExpression stringOptional 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 MitigationTimeout int64Optional Period of time in seconds after which the action will be disabled following its first execution. Link to this property RequestsPerPeriod int64Optional The threshold of requests per period after which the action will be executed for the first time. minimum1 Link to this property RequestsToOrigin boolOptional Whether counting is only performed when an origin is reached. Link to this property ScorePerPeriod int64Optional The score threshold per period for which the action will be executed the first time. Link to this property ScoreResponseHeaderName stringOptional A response header name provided by the origin, which contains the score to increment rate limit counter with. minLength1 Link to this property
Link to this property Ref stringOptional The reference of the rule (the rule’s ID by default). minLength1 Link to this property
Link to this property
type RouteRuleParam struct{…} LastUpdated Time The timestamp of when the rule was last modified. formatdate-time Link to this property Version string The version of the rule. Link to this property ID stringOptional The unique ID of the rule. Link to this property Action RouteRuleActionOptional The action to perform when the rule matches. Link to this property
ActionParameters RouteRuleActionParametersOptional The parameters configuring the rule’s action. HostHeader stringOptional A value to rewrite the HTTP host header to. minLength1 Link to this property
Origin RouteRuleActionParametersOriginOptional An origin to route to. Host stringOptional A resolved host to route to. minLength1 Link to this property Port int64Optional A destination port to route to. maximum65535 minimum1 Link to this property
Link to this property
SNI RouteRuleActionParametersSNIOptional A Server Name Indication (SNI) override. Value string A value to override the SNI to. minLength1 Link to this property
Link to this property
Link to this property Categories \[]stringOptional The categories of the rule. Link to this property Description stringOptional An informative description of the rule. Link to this property Enabled boolOptional Whether the rule should be executed. Link to this property
ExposedCredentialCheck RouteRuleExposedCredentialCheckOptional Configuration for exposed credential checking. PasswordExpression string An expression that selects the password used in the credentials check. minLength1 Link to this property UsernameExpression string An expression that selects the user ID used in the credentials check. minLength1 Link to this property
Link to this property Expression stringOptional The expression defining which traffic will match the rule. minLength1 Link to this property
Logging LoggingOptional An object configuring the rule’s logging behavior. Enabled bool Whether to generate a log when the rule matches. Link to this property
Link to this property
Ratelimit RouteRuleRatelimitOptional An object configuring the rule’s rate limit behavior. Characteristics \[]string Characteristics of the request on which the rate limit counter will be incremented. Link to this property Period int64 Period in seconds over which the counter is being incremented. minimum0 Link to this property CountingExpression stringOptional 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 MitigationTimeout int64Optional Period of time in seconds after which the action will be disabled following its first execution. Link to this property RequestsPerPeriod int64Optional The threshold of requests per period after which the action will be executed for the first time. minimum1 Link to this property RequestsToOrigin boolOptional Whether counting is only performed when an origin is reached. Link to this property ScorePerPeriod int64Optional The score threshold per period for which the action will be executed the first time. Link to this property ScoreResponseHeaderName stringOptional A response header name provided by the origin, which contains the score to increment rate limit counter with. minLength1 Link to this property
Link to this property Ref stringOptional The reference of the rule (the rule’s ID by default). minLength1 Link to this property
Link to this property
type ScoreRuleParam struct{…} LastUpdated Time The timestamp of when the rule was last modified. formatdate-time Link to this property Version string The version of the rule. Link to this property ID stringOptional The unique ID of the rule. Link to this property Action ScoreRuleActionOptional The action to perform when the rule matches. Link to this property
ActionParameters ScoreRuleActionParametersOptional The parameters configuring the rule’s action. Increment int64 A delta to change the score by, which can be either positive or negative. Link to this property
Link to this property Categories \[]stringOptional The categories of the rule. Link to this property Description stringOptional An informative description of the rule. Link to this property Enabled boolOptional Link to this property
ExposedCredentialCheck ScoreRuleExposedCredentialCheckOptional Configuration for exposed credential checking. PasswordExpression string An expression that selects the password used in the credentials check. minLength1 Link to this property UsernameExpression string An expression that selects the user ID used in the credentials check. minLength1 Link to this property
Link to this property Expression stringOptional The expression defining which traffic will match the rule. minLength1 Link to this property
Logging LoggingOptional An object configuring the rule’s logging behavior. Enabled bool Whether to generate a log when the rule matches. Link to this property
Link to this property
Ratelimit ScoreRuleRatelimitOptional An object configuring the rule’s rate limit behavior. Characteristics \[]string Characteristics of the request on which the rate limit counter will be incremented. Link to this property Period int64 Period in seconds over which the counter is being incremented. minimum0 Link to this property CountingExpression stringOptional 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 MitigationTimeout int64Optional Period of time in seconds after which the action will be disabled following its first execution. Link to this property RequestsPerPeriod int64Optional The threshold of requests per period after which the action will be executed for the first time. minimum1 Link to this property RequestsToOrigin boolOptional Whether counting is only performed when an origin is reached. Link to this property ScorePerPeriod int64Optional The score threshold per period for which the action will be executed the first time. Link to this property ScoreResponseHeaderName stringOptional A response header name provided by the origin, which contains the score to increment rate limit counter with. minLength1 Link to this property
Link to this property Ref stringOptional The reference of the rule (the rule’s ID by default). minLength1 Link to this property
Link to this property
type ServeErrorRuleParam struct{…} LastUpdated Time The timestamp of when the rule was last modified. formatdate-time Link to this property Version string The version of the rule. Link to this property ID stringOptional The unique ID of the rule. Link to this property Action ServeErrorRuleActionOptional The action to perform when the rule matches. Link to this property
ActionParameters ServeErrorRuleActionParametersOptional The parameters configuring the rule’s action. One of the following:
type ServeErrorRuleActionParametersActionParametersContentParam struct{…} Content string The response content. minLength1 Link to this property
ContentType ServeErrorRuleActionParametersActionParametersContentContentTypeOptional The content type header to set with the error response. One of the following: const ServeErrorRuleActionParametersActionParametersContentContentTypeApplicationJson ServeErrorRuleActionParametersActionParametersContentContentType = "application/json" Link to this property const ServeErrorRuleActionParametersActionParametersContentContentTypeTextHTML ServeErrorRuleActionParametersActionParametersContentContentType = "text/html" Link to this property const ServeErrorRuleActionParametersActionParametersContentContentTypeTextPlain ServeErrorRuleActionParametersActionParametersContentContentType = "text/plain" Link to this property const ServeErrorRuleActionParametersActionParametersContentContentTypeTextXml ServeErrorRuleActionParametersActionParametersContentContentType = "text/xml" Link to this property
Link to this property StatusCode int64Optional The status code to use for the error. maximum999 minimum400 Link to this property
Link to this property
type ServeErrorRuleActionParametersActionParametersAssetParam struct{…} AssetName string The name of a custom asset to serve as the error response. minLength1 Link to this property
ContentType ServeErrorRuleActionParametersActionParametersAssetContentTypeOptional The content type header to set with the error response. One of the following: const ServeErrorRuleActionParametersActionParametersAssetContentTypeApplicationJson ServeErrorRuleActionParametersActionParametersAssetContentType = "application/json" Link to this property const ServeErrorRuleActionParametersActionParametersAssetContentTypeTextHTML ServeErrorRuleActionParametersActionParametersAssetContentType = "text/html" Link to this property const ServeErrorRuleActionParametersActionParametersAssetContentTypeTextPlain ServeErrorRuleActionParametersActionParametersAssetContentType = "text/plain" Link to this property const ServeErrorRuleActionParametersActionParametersAssetContentTypeTextXml ServeErrorRuleActionParametersActionParametersAssetContentType = "text/xml" Link to this property
Link to this property StatusCode int64Optional The status code to use for the error. maximum999 minimum400 Link to this property
Link to this property
Link to this property Categories \[]stringOptional The categories of the rule. Link to this property Description stringOptional An informative description of the rule. Link to this property Enabled boolOptional Link to this property
ExposedCredentialCheck ServeErrorRuleExposedCredentialCheckOptional Configuration for exposed credential checking. PasswordExpression string An expression that selects the password used in the credentials check. minLength1 Link to this property UsernameExpression string An expression that selects the user ID used in the credentials check. minLength1 Link to this property
Link to this property Expression stringOptional The expression defining which traffic will match the rule. minLength1 Link to this property
Logging LoggingOptional An object configuring the rule’s logging behavior. Enabled bool Whether to generate a log when the rule matches. Link to this property
Link to this property
Ratelimit ServeErrorRuleRatelimitOptional An object configuring the rule’s rate limit behavior. Characteristics \[]string Characteristics of the request on which the rate limit counter will be incremented. Link to this property Period int64 Period in seconds over which the counter is being incremented. minimum0 Link to this property CountingExpression stringOptional 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 MitigationTimeout int64Optional Period of time in seconds after which the action will be disabled following its first execution. Link to this property RequestsPerPeriod int64Optional The threshold of requests per period after which the action will be executed for the first time. minimum1 Link to this property RequestsToOrigin boolOptional Whether counting is only performed when an origin is reached. Link to this property ScorePerPeriod int64Optional The score threshold per period for which the action will be executed the first time. Link to this property ScoreResponseHeaderName stringOptional A response header name provided by the origin, which contains the score to increment rate limit counter with. minLength1 Link to this property
Link to this property Ref stringOptional The reference of the rule (the rule’s ID by default). minLength1 Link to this property
Link to this property
type PhaseUpdateParamsRulesRulesetsSetCacheControlRule struct{…} LastUpdated Time The timestamp of when the rule was last modified. formatdate-time Link to this property Version string The version of the rule. Link to this property ID stringOptional The unique ID of the rule. Link to this property Action PhaseUpdateParamsRulesRulesetsSetCacheControlRuleActionOptional The action to perform when the rule matches. Link to this property
ActionParameters PhaseUpdateParamsRulesRulesetsSetCacheControlRuleActionParametersOptional The parameters configuring the rule’s action.
Immutable PhaseUpdateParamsRulesRulesetsSetCacheControlRuleActionParametersImmutableOptional A cache-control directive configuration. One of the following:
type PhaseUpdateParamsRulesRulesetsSetCacheControlRuleActionParametersImmutableSetDirective struct{…} Set the directive.
Operation PhaseUpdateParamsRulesRulesetsSetCacheControlRuleActionParametersImmutableSetDirectiveOperation The operation to perform on the cache-control directive. One of the following: const PhaseUpdateParamsRulesRulesetsSetCacheControlRuleActionParametersImmutableSetDirectiveOperationSet PhaseUpdateParamsRulesRulesetsSetCacheControlRuleActionParametersImmutableSetDirectiveOperation = "set" Link to this property const PhaseUpdateParamsRulesRulesetsSetCacheControlRuleActionParametersImmutableSetDirectiveOperationRemove PhaseUpdateParamsRulesRulesetsSetCacheControlRuleActionParametersImmutableSetDirectiveOperation = "remove" Link to this property
Link to this property CloudflareOnly boolOptional Whether the directive should only be applied to the Cloudflare CDN cache. Link to this property
Link to this property
type PhaseUpdateParamsRulesRulesetsSetCacheControlRuleActionParametersImmutableRemoveDirective struct{…} Remove the directive.
Operation PhaseUpdateParamsRulesRulesetsSetCacheControlRuleActionParametersImmutableRemoveDirectiveOperation The operation to perform on the cache-control directive. One of the following: const PhaseUpdateParamsRulesRulesetsSetCacheControlRuleActionParametersImmutableRemoveDirectiveOperationSet PhaseUpdateParamsRulesRulesetsSetCacheControlRuleActionParametersImmutableRemoveDirectiveOperation = "set" Link to this property const PhaseUpdateParamsRulesRulesetsSetCacheControlRuleActionParametersImmutableRemoveDirectiveOperationRemove PhaseUpdateParamsRulesRulesetsSetCacheControlRuleActionParametersImmutableRemoveDirectiveOperation = "remove" Link to this property
Link to this property CloudflareOnly boolOptional Whether the directive should only be applied to the Cloudflare CDN cache. Link to this property
Link to this property
Link to this property
MaxAge PhaseUpdateParamsRulesRulesetsSetCacheControlRuleActionParametersMaxAgeOptional A cache-control directive configuration that accepts a duration value in seconds. One of the following:
type PhaseUpdateParamsRulesRulesetsSetCacheControlRuleActionParametersMaxAgeSetDirective struct{…} Set the directive with a duration value in seconds.
Operation PhaseUpdateParamsRulesRulesetsSetCacheControlRuleActionParametersMaxAgeSetDirectiveOperation The operation to perform on the cache-control directive. One of the following: const PhaseUpdateParamsRulesRulesetsSetCacheControlRuleActionParametersMaxAgeSetDirectiveOperationSet PhaseUpdateParamsRulesRulesetsSetCacheControlRuleActionParametersMaxAgeSetDirectiveOperation = "set" Link to this property const PhaseUpdateParamsRulesRulesetsSetCacheControlRuleActionParametersMaxAgeSetDirectiveOperationRemove PhaseUpdateParamsRulesRulesetsSetCacheControlRuleActionParametersMaxAgeSetDirectiveOperation = "remove" Link to this property
Link to this property Value int64 The duration value in seconds for the directive. minimum0 Link to this property CloudflareOnly boolOptional Whether the directive should only be applied to the Cloudflare CDN cache. Link to this property
Link to this property
type PhaseUpdateParamsRulesRulesetsSetCacheControlRuleActionParametersMaxAgeRemoveDirective struct{…} Remove the directive.
Operation PhaseUpdateParamsRulesRulesetsSetCacheControlRuleActionParametersMaxAgeRemoveDirectiveOperation The operation to perform on the cache-control directive. One of the following: const PhaseUpdateParamsRulesRulesetsSetCacheControlRuleActionParametersMaxAgeRemoveDirectiveOperationSet PhaseUpdateParamsRulesRulesetsSetCacheControlRuleActionParametersMaxAgeRemoveDirectiveOperation = "set" Link to this property const PhaseUpdateParamsRulesRulesetsSetCacheControlRuleActionParametersMaxAgeRemoveDirectiveOperationRemove PhaseUpdateParamsRulesRulesetsSetCacheControlRuleActionParametersMaxAgeRemoveDirectiveOperation = "remove" Link to this property
Link to this property CloudflareOnly boolOptional Whether the directive should only be applied to the Cloudflare CDN cache. Link to this property
Link to this property
Link to this property
MustRevalidate PhaseUpdateParamsRulesRulesetsSetCacheControlRuleActionParametersMustRevalidateOptional A cache-control directive configuration. One of the following:
type PhaseUpdateParamsRulesRulesetsSetCacheControlRuleActionParametersMustRevalidateSetDirective struct{…} Set the directive.
Operation PhaseUpdateParamsRulesRulesetsSetCacheControlRuleActionParametersMustRevalidateSetDirectiveOperation The operation to perform on the cache-control directive. One of the following: const PhaseUpdateParamsRulesRulesetsSetCacheControlRuleActionParametersMustRevalidateSetDirectiveOperationSet PhaseUpdateParamsRulesRulesetsSetCacheControlRuleActionParametersMustRevalidateSetDirectiveOperation = "set" Link to this property const PhaseUpdateParamsRulesRulesetsSetCacheControlRuleActionParametersMustRevalidateSetDirectiveOperationRemove PhaseUpdateParamsRulesRulesetsSetCacheControlRuleActionParametersMustRevalidateSetDirectiveOperation = "remove" Link to this property
Link to this property CloudflareOnly boolOptional Whether the directive should only be applied to the Cloudflare CDN cache. Link to this property
Link to this property
type PhaseUpdateParamsRulesRulesetsSetCacheControlRuleActionParametersMustRevalidateRemoveDirective struct{…} Remove the directive.
Operation PhaseUpdateParamsRulesRulesetsSetCacheControlRuleActionParametersMustRevalidateRemoveDirectiveOperation The operation to perform on the cache-control directive. One of the following: const PhaseUpdateParamsRulesRulesetsSetCacheControlRuleActionParametersMustRevalidateRemoveDirectiveOperationSet PhaseUpdateParamsRulesRulesetsSetCacheControlRuleActionParametersMustRevalidateRemoveDirectiveOperation = "set" Link to this property const PhaseUpdateParamsRulesRulesetsSetCacheControlRuleActionParametersMustRevalidateRemoveDirectiveOperationRemove PhaseUpdateParamsRulesRulesetsSetCacheControlRuleActionParametersMustRevalidateRemoveDirectiveOperation = "remove" Link to this property
Link to this property CloudflareOnly boolOptional Whether the directive should only be applied to the Cloudflare CDN cache. Link to this property
Link to this property
Link to this property
MustUnderstand PhaseUpdateParamsRulesRulesetsSetCacheControlRuleActionParametersMustUnderstandOptional A cache-control directive configuration. One of the following:
type PhaseUpdateParamsRulesRulesetsSetCacheControlRuleActionParametersMustUnderstandSetDirective struct{…} Set the directive.
Operation PhaseUpdateParamsRulesRulesetsSetCacheControlRuleActionParametersMustUnderstandSetDirectiveOperation The operation to perform on the cache-control directive. One of the following: const PhaseUpdateParamsRulesRulesetsSetCacheControlRuleActionParametersMustUnderstandSetDirectiveOperationSet PhaseUpdateParamsRulesRulesetsSetCacheControlRuleActionParametersMustUnderstandSetDirectiveOperation = "set" Link to this property const PhaseUpdateParamsRulesRulesetsSetCacheControlRuleActionParametersMustUnderstandSetDirectiveOperationRemove PhaseUpdateParamsRulesRulesetsSetCacheControlRuleActionParametersMustUnderstandSetDirectiveOperation = "remove" Link to this property
Link to this property CloudflareOnly boolOptional Whether the directive should only be applied to the Cloudflare CDN cache. Link to this property
Link to this property
type PhaseUpdateParamsRulesRulesetsSetCacheControlRuleActionParametersMustUnderstandRemoveDirective struct{…} Remove the directive.
Operation PhaseUpdateParamsRulesRulesetsSetCacheControlRuleActionParametersMustUnderstandRemoveDirectiveOperation The operation to perform on the cache-control directive. One of the following: const PhaseUpdateParamsRulesRulesetsSetCacheControlRuleActionParametersMustUnderstandRemoveDirectiveOperationSet PhaseUpdateParamsRulesRulesetsSetCacheControlRuleActionParametersMustUnderstandRemoveDirectiveOperation = "set" Link to this property const PhaseUpdateParamsRulesRulesetsSetCacheControlRuleActionParametersMustUnderstandRemoveDirectiveOperationRemove PhaseUpdateParamsRulesRulesetsSetCacheControlRuleActionParametersMustUnderstandRemoveDirectiveOperation = "remove" Link to this property
Link to this property CloudflareOnly boolOptional Whether the directive should only be applied to the Cloudflare CDN cache. Link to this property
Link to this property
Link to this property
NoCache PhaseUpdateParamsRulesRulesetsSetCacheControlRuleActionParametersNoCacheOptional A cache-control directive configuration that accepts optional qualifiers (header names). One of the following:
type PhaseUpdateParamsRulesRulesetsSetCacheControlRuleActionParametersNoCacheSetDirective struct{…} Set the directive with optional qualifiers.
Operation PhaseUpdateParamsRulesRulesetsSetCacheControlRuleActionParametersNoCacheSetDirectiveOperation The operation to perform on the cache-control directive. One of the following: const PhaseUpdateParamsRulesRulesetsSetCacheControlRuleActionParametersNoCacheSetDirectiveOperationSet PhaseUpdateParamsRulesRulesetsSetCacheControlRuleActionParametersNoCacheSetDirectiveOperation = "set" Link to this property const PhaseUpdateParamsRulesRulesetsSetCacheControlRuleActionParametersNoCacheSetDirectiveOperationRemove PhaseUpdateParamsRulesRulesetsSetCacheControlRuleActionParametersNoCacheSetDirectiveOperation = "remove" Link to this property
Link to this property CloudflareOnly boolOptional Whether the directive should only be applied to the Cloudflare CDN cache. Link to this property Qualifiers \[]stringOptional 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
type PhaseUpdateParamsRulesRulesetsSetCacheControlRuleActionParametersNoCacheRemoveDirective struct{…} Remove the directive.
Operation PhaseUpdateParamsRulesRulesetsSetCacheControlRuleActionParametersNoCacheRemoveDirectiveOperation The operation to perform on the cache-control directive. One of the following: const PhaseUpdateParamsRulesRulesetsSetCacheControlRuleActionParametersNoCacheRemoveDirectiveOperationSet PhaseUpdateParamsRulesRulesetsSetCacheControlRuleActionParametersNoCacheRemoveDirectiveOperation = "set" Link to this property const PhaseUpdateParamsRulesRulesetsSetCacheControlRuleActionParametersNoCacheRemoveDirectiveOperationRemove PhaseUpdateParamsRulesRulesetsSetCacheControlRuleActionParametersNoCacheRemoveDirectiveOperation = "remove" Link to this property
Link to this property CloudflareOnly boolOptional Whether the directive should only be applied to the Cloudflare CDN cache. Link to this property
Link to this property
Link to this property
NoStore PhaseUpdateParamsRulesRulesetsSetCacheControlRuleActionParametersNoStoreOptional A cache-control directive configuration. One of the following:
type PhaseUpdateParamsRulesRulesetsSetCacheControlRuleActionParametersNoStoreSetDirective struct{…} Set the directive.
Operation PhaseUpdateParamsRulesRulesetsSetCacheControlRuleActionParametersNoStoreSetDirectiveOperation The operation to perform on the cache-control directive. One of the following: const PhaseUpdateParamsRulesRulesetsSetCacheControlRuleActionParametersNoStoreSetDirectiveOperationSet PhaseUpdateParamsRulesRulesetsSetCacheControlRuleActionParametersNoStoreSetDirectiveOperation = "set" Link to this property const PhaseUpdateParamsRulesRulesetsSetCacheControlRuleActionParametersNoStoreSetDirectiveOperationRemove PhaseUpdateParamsRulesRulesetsSetCacheControlRuleActionParametersNoStoreSetDirectiveOperation = "remove" Link to this property
Link to this property CloudflareOnly boolOptional Whether the directive should only be applied to the Cloudflare CDN cache. Link to this property
Link to this property
type PhaseUpdateParamsRulesRulesetsSetCacheControlRuleActionParametersNoStoreRemoveDirective struct{…} Remove the directive.
Operation PhaseUpdateParamsRulesRulesetsSetCacheControlRuleActionParametersNoStoreRemoveDirectiveOperation The operation to perform on the cache-control directive. One of the following: const PhaseUpdateParamsRulesRulesetsSetCacheControlRuleActionParametersNoStoreRemoveDirectiveOperationSet PhaseUpdateParamsRulesRulesetsSetCacheControlRuleActionParametersNoStoreRemoveDirectiveOperation = "set" Link to this property const PhaseUpdateParamsRulesRulesetsSetCacheControlRuleActionParametersNoStoreRemoveDirectiveOperationRemove PhaseUpdateParamsRulesRulesetsSetCacheControlRuleActionParametersNoStoreRemoveDirectiveOperation = "remove" Link to this property
Link to this property CloudflareOnly boolOptional Whether the directive should only be applied to the Cloudflare CDN cache. Link to this property
Link to this property
Link to this property
NoTransform PhaseUpdateParamsRulesRulesetsSetCacheControlRuleActionParametersNoTransformOptional A cache-control directive configuration. One of the following:
type PhaseUpdateParamsRulesRulesetsSetCacheControlRuleActionParametersNoTransformSetDirective struct{…} Set the directive.
Operation PhaseUpdateParamsRulesRulesetsSetCacheControlRuleActionParametersNoTransformSetDirectiveOperation The operation to perform on the cache-control directive. One of the following: const PhaseUpdateParamsRulesRulesetsSetCacheControlRuleActionParametersNoTransformSetDirectiveOperationSet PhaseUpdateParamsRulesRulesetsSetCacheControlRuleActionParametersNoTransformSetDirectiveOperation = "set" Link to this property const PhaseUpdateParamsRulesRulesetsSetCacheControlRuleActionParametersNoTransformSetDirectiveOperationRemove PhaseUpdateParamsRulesRulesetsSetCacheControlRuleActionParametersNoTransformSetDirectiveOperation = "remove" Link to this property
Link to this property CloudflareOnly boolOptional Whether the directive should only be applied to the Cloudflare CDN cache. Link to this property
Link to this property
type PhaseUpdateParamsRulesRulesetsSetCacheControlRuleActionParametersNoTransformRemoveDirective struct{…} Remove the directive.
Operation PhaseUpdateParamsRulesRulesetsSetCacheControlRuleActionParametersNoTransformRemoveDirectiveOperation The operation to perform on the cache-control directive. One of the following: const PhaseUpdateParamsRulesRulesetsSetCacheControlRuleActionParametersNoTransformRemoveDirectiveOperationSet PhaseUpdateParamsRulesRulesetsSetCacheControlRuleActionParametersNoTransformRemoveDirectiveOperation = "set" Link to this property const PhaseUpdateParamsRulesRulesetsSetCacheControlRuleActionParametersNoTransformRemoveDirectiveOperationRemove PhaseUpdateParamsRulesRulesetsSetCacheControlRuleActionParametersNoTransformRemoveDirectiveOperation = "remove" Link to this property
Link to this property CloudflareOnly boolOptional 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 PhaseUpdateParamsRulesRulesetsSetCacheControlRuleActionParametersPrivateOptional A cache-control directive configuration that accepts optional qualifiers (header names). One of the following:
type PhaseUpdateParamsRulesRulesetsSetCacheControlRuleActionParametersPrivateSetDirective struct{…} Set the directive with optional qualifiers.
Operation PhaseUpdateParamsRulesRulesetsSetCacheControlRuleActionParametersPrivateSetDirectiveOperation The operation to perform on the cache-control directive. One of the following: const PhaseUpdateParamsRulesRulesetsSetCacheControlRuleActionParametersPrivateSetDirectiveOperationSet PhaseUpdateParamsRulesRulesetsSetCacheControlRuleActionParametersPrivateSetDirectiveOperation = "set" Link to this property const PhaseUpdateParamsRulesRulesetsSetCacheControlRuleActionParametersPrivateSetDirectiveOperationRemove PhaseUpdateParamsRulesRulesetsSetCacheControlRuleActionParametersPrivateSetDirectiveOperation = "remove" Link to this property
Link to this property CloudflareOnly boolOptional Whether the directive should only be applied to the Cloudflare CDN cache. Link to this property Qualifiers \[]stringOptional 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
type PhaseUpdateParamsRulesRulesetsSetCacheControlRuleActionParametersPrivateRemoveDirective struct{…} Remove the directive.
Operation PhaseUpdateParamsRulesRulesetsSetCacheControlRuleActionParametersPrivateRemoveDirectiveOperation The operation to perform on the cache-control directive. One of the following: const PhaseUpdateParamsRulesRulesetsSetCacheControlRuleActionParametersPrivateRemoveDirectiveOperationSet PhaseUpdateParamsRulesRulesetsSetCacheControlRuleActionParametersPrivateRemoveDirectiveOperation = "set" Link to this property const PhaseUpdateParamsRulesRulesetsSetCacheControlRuleActionParametersPrivateRemoveDirectiveOperationRemove PhaseUpdateParamsRulesRulesetsSetCacheControlRuleActionParametersPrivateRemoveDirectiveOperation = "remove" Link to this property
Link to this property CloudflareOnly boolOptional Whether the directive should only be applied to the Cloudflare CDN cache. Link to this property
Link to this property
Link to this property
ProxyRevalidate PhaseUpdateParamsRulesRulesetsSetCacheControlRuleActionParametersProxyRevalidateOptional A cache-control directive configuration. One of the following:
type PhaseUpdateParamsRulesRulesetsSetCacheControlRuleActionParametersProxyRevalidateSetDirective struct{…} Set the directive.
Operation PhaseUpdateParamsRulesRulesetsSetCacheControlRuleActionParametersProxyRevalidateSetDirectiveOperation The operation to perform on the cache-control directive. One of the following: const PhaseUpdateParamsRulesRulesetsSetCacheControlRuleActionParametersProxyRevalidateSetDirectiveOperationSet PhaseUpdateParamsRulesRulesetsSetCacheControlRuleActionParametersProxyRevalidateSetDirectiveOperation = "set" Link to this property const PhaseUpdateParamsRulesRulesetsSetCacheControlRuleActionParametersProxyRevalidateSetDirectiveOperationRemove PhaseUpdateParamsRulesRulesetsSetCacheControlRuleActionParametersProxyRevalidateSetDirectiveOperation = "remove" Link to this property
Link to this property CloudflareOnly boolOptional Whether the directive should only be applied to the Cloudflare CDN cache. Link to this property
Link to this property
type PhaseUpdateParamsRulesRulesetsSetCacheControlRuleActionParametersProxyRevalidateRemoveDirective struct{…} Remove the directive.
Operation PhaseUpdateParamsRulesRulesetsSetCacheControlRuleActionParametersProxyRevalidateRemoveDirectiveOperation The operation to perform on the cache-control directive. One of the following: const PhaseUpdateParamsRulesRulesetsSetCacheControlRuleActionParametersProxyRevalidateRemoveDirectiveOperationSet PhaseUpdateParamsRulesRulesetsSetCacheControlRuleActionParametersProxyRevalidateRemoveDirectiveOperation = "set" Link to this property const PhaseUpdateParamsRulesRulesetsSetCacheControlRuleActionParametersProxyRevalidateRemoveDirectiveOperationRemove PhaseUpdateParamsRulesRulesetsSetCacheControlRuleActionParametersProxyRevalidateRemoveDirectiveOperation = "remove" Link to this property
Link to this property CloudflareOnly boolOptional 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 PhaseUpdateParamsRulesRulesetsSetCacheControlRuleActionParametersPublicOptional A cache-control directive configuration. One of the following:
type PhaseUpdateParamsRulesRulesetsSetCacheControlRuleActionParametersPublicSetDirective struct{…} Set the directive.
Operation PhaseUpdateParamsRulesRulesetsSetCacheControlRuleActionParametersPublicSetDirectiveOperation The operation to perform on the cache-control directive. One of the following: const PhaseUpdateParamsRulesRulesetsSetCacheControlRuleActionParametersPublicSetDirectiveOperationSet PhaseUpdateParamsRulesRulesetsSetCacheControlRuleActionParametersPublicSetDirectiveOperation = "set" Link to this property const PhaseUpdateParamsRulesRulesetsSetCacheControlRuleActionParametersPublicSetDirectiveOperationRemove PhaseUpdateParamsRulesRulesetsSetCacheControlRuleActionParametersPublicSetDirectiveOperation = "remove" Link to this property
Link to this property CloudflareOnly boolOptional Whether the directive should only be applied to the Cloudflare CDN cache. Link to this property
Link to this property
type PhaseUpdateParamsRulesRulesetsSetCacheControlRuleActionParametersPublicRemoveDirective struct{…} Remove the directive.
Operation PhaseUpdateParamsRulesRulesetsSetCacheControlRuleActionParametersPublicRemoveDirectiveOperation The operation to perform on the cache-control directive. One of the following: const PhaseUpdateParamsRulesRulesetsSetCacheControlRuleActionParametersPublicRemoveDirectiveOperationSet PhaseUpdateParamsRulesRulesetsSetCacheControlRuleActionParametersPublicRemoveDirectiveOperation = "set" Link to this property const PhaseUpdateParamsRulesRulesetsSetCacheControlRuleActionParametersPublicRemoveDirectiveOperationRemove PhaseUpdateParamsRulesRulesetsSetCacheControlRuleActionParametersPublicRemoveDirectiveOperation = "remove" Link to this property
Link to this property CloudflareOnly boolOptional Whether the directive should only be applied to the Cloudflare CDN cache. Link to this property
Link to this property
Link to this property
SMaxage PhaseUpdateParamsRulesRulesetsSetCacheControlRuleActionParametersSMaxageOptional A cache-control directive configuration that accepts a duration value in seconds. One of the following:
type PhaseUpdateParamsRulesRulesetsSetCacheControlRuleActionParametersSMaxageSetDirective struct{…} Set the directive with a duration value in seconds.
Operation PhaseUpdateParamsRulesRulesetsSetCacheControlRuleActionParametersSMaxageSetDirectiveOperation The operation to perform on the cache-control directive. One of the following: const PhaseUpdateParamsRulesRulesetsSetCacheControlRuleActionParametersSMaxageSetDirectiveOperationSet PhaseUpdateParamsRulesRulesetsSetCacheControlRuleActionParametersSMaxageSetDirectiveOperation = "set" Link to this property const PhaseUpdateParamsRulesRulesetsSetCacheControlRuleActionParametersSMaxageSetDirectiveOperationRemove PhaseUpdateParamsRulesRulesetsSetCacheControlRuleActionParametersSMaxageSetDirectiveOperation = "remove" Link to this property
Link to this property Value int64 The duration value in seconds for the directive. minimum0 Link to this property CloudflareOnly boolOptional Whether the directive should only be applied to the Cloudflare CDN cache. Link to this property
Link to this property
type PhaseUpdateParamsRulesRulesetsSetCacheControlRuleActionParametersSMaxageRemoveDirective struct{…} Remove the directive.
Operation PhaseUpdateParamsRulesRulesetsSetCacheControlRuleActionParametersSMaxageRemoveDirectiveOperation The operation to perform on the cache-control directive. One of the following: const PhaseUpdateParamsRulesRulesetsSetCacheControlRuleActionParametersSMaxageRemoveDirectiveOperationSet PhaseUpdateParamsRulesRulesetsSetCacheControlRuleActionParametersSMaxageRemoveDirectiveOperation = "set" Link to this property const PhaseUpdateParamsRulesRulesetsSetCacheControlRuleActionParametersSMaxageRemoveDirectiveOperationRemove PhaseUpdateParamsRulesRulesetsSetCacheControlRuleActionParametersSMaxageRemoveDirectiveOperation = "remove" Link to this property
Link to this property CloudflareOnly boolOptional Whether the directive should only be applied to the Cloudflare CDN cache. Link to this property
Link to this property
Link to this property
StaleIfError PhaseUpdateParamsRulesRulesetsSetCacheControlRuleActionParametersStaleIfErrorOptional A cache-control directive configuration that accepts a duration value in seconds. One of the following:
type PhaseUpdateParamsRulesRulesetsSetCacheControlRuleActionParametersStaleIfErrorSetDirective struct{…} Set the directive with a duration value in seconds.
Operation PhaseUpdateParamsRulesRulesetsSetCacheControlRuleActionParametersStaleIfErrorSetDirectiveOperation The operation to perform on the cache-control directive. One of the following: const PhaseUpdateParamsRulesRulesetsSetCacheControlRuleActionParametersStaleIfErrorSetDirectiveOperationSet PhaseUpdateParamsRulesRulesetsSetCacheControlRuleActionParametersStaleIfErrorSetDirectiveOperation = "set" Link to this property const PhaseUpdateParamsRulesRulesetsSetCacheControlRuleActionParametersStaleIfErrorSetDirectiveOperationRemove PhaseUpdateParamsRulesRulesetsSetCacheControlRuleActionParametersStaleIfErrorSetDirectiveOperation = "remove" Link to this property
Link to this property Value int64 The duration value in seconds for the directive. minimum0 Link to this property CloudflareOnly boolOptional Whether the directive should only be applied to the Cloudflare CDN cache. Link to this property
Link to this property
type PhaseUpdateParamsRulesRulesetsSetCacheControlRuleActionParametersStaleIfErrorRemoveDirective struct{…} Remove the directive.
Operation PhaseUpdateParamsRulesRulesetsSetCacheControlRuleActionParametersStaleIfErrorRemoveDirectiveOperation The operation to perform on the cache-control directive. One of the following: const PhaseUpdateParamsRulesRulesetsSetCacheControlRuleActionParametersStaleIfErrorRemoveDirectiveOperationSet PhaseUpdateParamsRulesRulesetsSetCacheControlRuleActionParametersStaleIfErrorRemoveDirectiveOperation = "set" Link to this property const PhaseUpdateParamsRulesRulesetsSetCacheControlRuleActionParametersStaleIfErrorRemoveDirectiveOperationRemove PhaseUpdateParamsRulesRulesetsSetCacheControlRuleActionParametersStaleIfErrorRemoveDirectiveOperation = "remove" Link to this property
Link to this property CloudflareOnly boolOptional Whether the directive should only be applied to the Cloudflare CDN cache. Link to this property
Link to this property
Link to this property
StaleWhileRevalidate PhaseUpdateParamsRulesRulesetsSetCacheControlRuleActionParametersStaleWhileRevalidateOptional A cache-control directive configuration that accepts a duration value in seconds. One of the following:
type PhaseUpdateParamsRulesRulesetsSetCacheControlRuleActionParametersStaleWhileRevalidateSetDirective struct{…} Set the directive with a duration value in seconds.
Operation PhaseUpdateParamsRulesRulesetsSetCacheControlRuleActionParametersStaleWhileRevalidateSetDirectiveOperation The operation to perform on the cache-control directive. One of the following: const PhaseUpdateParamsRulesRulesetsSetCacheControlRuleActionParametersStaleWhileRevalidateSetDirectiveOperationSet PhaseUpdateParamsRulesRulesetsSetCacheControlRuleActionParametersStaleWhileRevalidateSetDirectiveOperation = "set" Link to this property const PhaseUpdateParamsRulesRulesetsSetCacheControlRuleActionParametersStaleWhileRevalidateSetDirectiveOperationRemove PhaseUpdateParamsRulesRulesetsSetCacheControlRuleActionParametersStaleWhileRevalidateSetDirectiveOperation = "remove" Link to this property
Link to this property Value int64 The duration value in seconds for the directive. minimum0 Link to this property CloudflareOnly boolOptional Whether the directive should only be applied to the Cloudflare CDN cache. Link to this property
Link to this property
type PhaseUpdateParamsRulesRulesetsSetCacheControlRuleActionParametersStaleWhileRevalidateRemoveDirective struct{…} Remove the directive.
Operation PhaseUpdateParamsRulesRulesetsSetCacheControlRuleActionParametersStaleWhileRevalidateRemoveDirectiveOperation The operation to perform on the cache-control directive. One of the following: const PhaseUpdateParamsRulesRulesetsSetCacheControlRuleActionParametersStaleWhileRevalidateRemoveDirectiveOperationSet PhaseUpdateParamsRulesRulesetsSetCacheControlRuleActionParametersStaleWhileRevalidateRemoveDirectiveOperation = "set" Link to this property const PhaseUpdateParamsRulesRulesetsSetCacheControlRuleActionParametersStaleWhileRevalidateRemoveDirectiveOperationRemove PhaseUpdateParamsRulesRulesetsSetCacheControlRuleActionParametersStaleWhileRevalidateRemoveDirectiveOperation = "remove" Link to this property
Link to this property CloudflareOnly boolOptional 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 \[]stringOptional The categories of the rule. Link to this property Description stringOptional An informative description of the rule. Link to this property Enabled boolOptional Link to this property
ExposedCredentialCheck PhaseUpdateParamsRulesRulesetsSetCacheControlRuleExposedCredentialCheckOptional Configuration for exposed credential checking. PasswordExpression string An expression that selects the password used in the credentials check. minLength1 Link to this property UsernameExpression string An expression that selects the user ID used in the credentials check. minLength1 Link to this property
Link to this property Expression stringOptional The expression defining which traffic will match the rule. minLength1 Link to this property
Logging LoggingOptional An object configuring the rule’s logging behavior. Enabled bool Whether to generate a log when the rule matches. Link to this property
Link to this property
Ratelimit PhaseUpdateParamsRulesRulesetsSetCacheControlRuleRatelimitOptional An object configuring the rule’s rate limit behavior. Characteristics \[]string Characteristics of the request on which the rate limit counter will be incremented. Link to this property Period int64 Period in seconds over which the counter is being incremented. minimum0 Link to this property CountingExpression stringOptional 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 MitigationTimeout int64Optional Period of time in seconds after which the action will be disabled following its first execution. Link to this property RequestsPerPeriod int64Optional The threshold of requests per period after which the action will be executed for the first time. minimum1 Link to this property RequestsToOrigin boolOptional Whether counting is only performed when an origin is reached. Link to this property ScorePerPeriod int64Optional The score threshold per period for which the action will be executed the first time. Link to this property ScoreResponseHeaderName stringOptional A response header name provided by the origin, which contains the score to increment rate limit counter with. minLength1 Link to this property
Link to this property Ref stringOptional The reference of the rule (the rule’s ID by default). minLength1 Link to this property
Link to this property
type SetCacheSettingsRuleParam struct{…} LastUpdated Time The timestamp of when the rule was last modified. formatdate-time Link to this property Version string The version of the rule. Link to this property ID stringOptional The unique ID of the rule. Link to this property Action SetCacheSettingsRuleActionOptional The action to perform when the rule matches. Link to this property
ActionParameters SetCacheSettingsRuleActionParametersOptional The parameters configuring the rule’s action. AdditionalCacheablePorts \[]int64Optional A list of additional ports that caching should be enabled on. Link to this property
BrowserTTL SetCacheSettingsRuleActionParametersBrowserTTLOptional How long client browsers should cache the response. Cloudflare cache purge will not purge content cached on client browsers, so high browser TTLs may lead to stale content.
Mode SetCacheSettingsRuleActionParametersBrowserTTLMode The browser TTL mode. One of the following: const SetCacheSettingsRuleActionParametersBrowserTTLModeRespectOrigin SetCacheSettingsRuleActionParametersBrowserTTLMode = "respect\_origin" Link to this property const SetCacheSettingsRuleActionParametersBrowserTTLModeBypassByDefault SetCacheSettingsRuleActionParametersBrowserTTLMode = "bypass\_by\_default" Link to this property const SetCacheSettingsRuleActionParametersBrowserTTLModeOverrideOrigin SetCacheSettingsRuleActionParametersBrowserTTLMode = "override\_origin" Link to this property const SetCacheSettingsRuleActionParametersBrowserTTLModeBypass SetCacheSettingsRuleActionParametersBrowserTTLMode = "bypass" Link to this property
Link to this property Default int64Optional The browser TTL (in seconds) if you choose the “override\_origin” mode. minimum0 Link to this property
Link to this property Cache boolOptional Whether the request’s response from the origin is eligible for caching. Caching itself will still depend on the cache control header and your other caching configurations. Link to this property
CacheKey SetCacheSettingsRuleActionParametersCacheKeyOptional Which components of the request are included in or excluded from the cache key Cloudflare uses to store the response in cache. CacheByDeviceType boolOptional Whether to separate cached content based on the visitor’s device type. Link to this property CacheDeceptionArmor boolOptional Whether to protect from web cache deception attacks, while allowing static assets to be cached. Link to this property
CustomKey SetCacheSettingsRuleActionParametersCacheKeyCustomKeyOptional Which components of the request are included or excluded from the cache key.
Cookie SetCacheSettingsRuleActionParametersCacheKeyCustomKeyCookieOptional Which cookies to include in the cache key. CheckPresence \[]stringOptional A list of cookies to check for the presence of. The presence of these cookies is included in the cache key. Link to this property Include \[]stringOptional A list of cookies to include in the cache key. Link to this property
Link to this property
Header SetCacheSettingsRuleActionParametersCacheKeyCustomKeyHeaderOptional Which headers to include in the cache key. CheckPresence \[]stringOptional A list of headers to check for the presence of. The presence of these headers is included in the cache key. Link to this property Contains map\[string, \[]string]Optional A mapping of header names to a list of values. If a header is present in the request and contains any of the values provided, its value is included in the cache key. Link to this property ExcludeOrigin boolOptional Whether to exclude the origin header in the cache key. Link to this property Include \[]stringOptional A list of headers to include in the cache key. Link to this property
Link to this property
Host SetCacheSettingsRuleActionParametersCacheKeyCustomKeyHostOptional How to use the host in the cache key. Resolved boolOptional Whether to use the resolved host in the cache key. Link to this property
Link to this property
QueryString SetCacheSettingsRuleActionParametersCacheKeyCustomKeyQueryStringOptional Which query string parameters to include in or exclude from the cache key.
Exclude SetCacheSettingsRuleActionParametersCacheKeyCustomKeyQueryStringExcludeOptional Which query string parameters to exclude from the cache key. All SetCacheSettingsRuleActionParametersCacheKeyCustomKeyQueryStringExcludeAllOptional Whether to exclude all query string parameters from the cache key. Link to this property List \[]stringOptional A list of query string parameters to exclude from the cache key. Link to this property
Link to this property
Include SetCacheSettingsRuleActionParametersCacheKeyCustomKeyQueryStringIncludeOptional Which query string parameters to include in the cache key. All SetCacheSettingsRuleActionParametersCacheKeyCustomKeyQueryStringIncludeAllOptional Whether to include all query string parameters in the cache key. Link to this property List \[]stringOptional A list of query string parameters to include in the cache key. Link to this property
Link to this property
Link to this property
User SetCacheSettingsRuleActionParametersCacheKeyCustomKeyUserOptional How to use characteristics of the request user agent in the cache key. DeviceType boolOptional Whether to use the user agent’s device type in the cache key. Link to this property Geo boolOptional Whether to use the user agents’s country in the cache key. Link to this property Lang boolOptional Whether to use the user agent’s language in the cache key. Link to this property
Link to this property
Link to this property IgnoreQueryStringsOrder boolOptional Whether to treat requests with the same query parameters the same, regardless of the order those query parameters are in. Link to this property
Link to this property
CacheReserve SetCacheSettingsRuleActionParametersCacheReserveOptional Settings to determine whether the request’s response from origin is eligible for Cache Reserve (requires a Cache Reserve add-on plan). Eligible bool Whether Cache Reserve is enabled. If this is true and a request meets eligibility criteria, Cloudflare will write the resource to Cache Reserve. Link to this property MinimumFileSize int64Optional The minimum file size eligible for storage in Cache Reserve. minimum0 Link to this property
Link to this property
EdgeTTL SetCacheSettingsRuleActionParametersEdgeTTLOptional How long the Cloudflare edge network should cache the response.
Mode SetCacheSettingsRuleActionParametersEdgeTTLMode The edge TTL mode. One of the following: const SetCacheSettingsRuleActionParametersEdgeTTLModeRespectOrigin SetCacheSettingsRuleActionParametersEdgeTTLMode = "respect\_origin" Link to this property const SetCacheSettingsRuleActionParametersEdgeTTLModeBypassByDefault SetCacheSettingsRuleActionParametersEdgeTTLMode = "bypass\_by\_default" Link to this property const SetCacheSettingsRuleActionParametersEdgeTTLModeOverrideOrigin SetCacheSettingsRuleActionParametersEdgeTTLMode = "override\_origin" Link to this property
Link to this property Default int64Optional The edge TTL (in seconds) if you choose the “override\_origin” mode. minimum0 Link to this property
StatusCodeTTL \[]SetCacheSettingsRuleActionParametersEdgeTTLStatusCodeTTLOptional A list of TTLs to apply to specific status codes or status code ranges. Value int64 The time to cache the response for (in seconds). A value of 0 is equivalent to setting the cache control header with the value “no-cache”. A value of -1 is equivalent to setting the cache control header with the value of “no-store”. Link to this property StatusCode int64Optional A single status code to apply the TTL to. maximum999 minimum100 Link to this property
StatusCodeRange SetCacheSettingsRuleActionParametersEdgeTTLStatusCodeTTLStatusCodeRangeOptional A range of status codes to apply the TTL to. From int64Optional The lower bound of the range. maximum999 minimum100 Link to this property To int64Optional The upper bound of the range. maximum999 minimum100 Link to this property
Link to this property
Link to this property
Link to this property OriginCacheControl boolOptional Whether Cloudflare will aim to strictly adhere to RFC 7234. Link to this property OriginErrorPagePassthru boolOptional Whether to generate Cloudflare error pages for issues from the origin server. Link to this property
OriginRangeRequests SetCacheSettingsRuleActionParametersOriginRangeRequestsOptional Controls whether Cloudflare fetches a large asset from the origin as a series of range requests instead of one whole-body request.
Mode SetCacheSettingsRuleActionParametersOriginRangeRequestsMode Whether to use range requests. default is the behaviour the zone gets without this rule. One of the following: const SetCacheSettingsRuleActionParametersOriginRangeRequestsModeOn SetCacheSettingsRuleActionParametersOriginRangeRequestsMode = "on" Link to this property const SetCacheSettingsRuleActionParametersOriginRangeRequestsModeOff SetCacheSettingsRuleActionParametersOriginRangeRequestsMode = "off" Link to this property const SetCacheSettingsRuleActionParametersOriginRangeRequestsModeDefault SetCacheSettingsRuleActionParametersOriginRangeRequestsMode = "default" Link to this property
Link to this property
Link to this property ReadTimeout int64Optional A timeout value between two successive read operations to use for your origin server. Historically, the timeout value between two read options from Cloudflare to an origin server is 100 seconds. If you are attempting to reduce HTTP 524 errors because of timeouts from an origin server, try increasing this timeout value. maximum6000 minimum100 Link to this property RespectStrongEtags boolOptional Whether Cloudflare should respect strong ETag (entity tag) headers. If false, Cloudflare converts strong ETag headers to weak ETag headers. Link to this property
ServeStale SetCacheSettingsRuleActionParametersServeStaleOptional When to serve stale content from cache. DisableStaleWhileUpdating boolOptional Whether Cloudflare should disable serving stale content while getting the latest content from the origin. Link to this property
Link to this property
SharedDictionary SetCacheSettingsRuleActionParametersSharedDictionaryOptional Configuration for shared dictionary compression. When set, Cloudflare injects Use-As-Dictionary headers on matching cacheable responses. MatchPattern string URL pattern for the Use-As-Dictionary match field. This pattern specifies which URLs can use this response as a dictionary. maxLength1024 minLength1 Link to this property
Link to this property StripEtags boolOptional Whether to strip ETag headers from the origin response before caching. Link to this property StripLastModified boolOptional Whether to strip Last-Modified headers from the origin response before caching. Link to this property StripSetCookie boolOptional Whether to strip Set-Cookie headers from the origin response before caching. Link to this property
Vary SetCacheSettingsRuleActionParametersVaryOptional Controls how cached responses vary based on request headers. default is required by the API and applies to any Vary response header that does not have a per-header override.
Default SetCacheSettingsRuleActionParametersVaryDefaultOptional Controls how response Vary headers without a per-header override contribute to the cache key.
Action SetCacheSettingsRuleActionParametersVaryDefaultAction How the header value is treated when building the cache key. One of the following: const SetCacheSettingsRuleActionParametersVaryDefaultActionBypass SetCacheSettingsRuleActionParametersVaryDefaultAction = "bypass" Link to this property const SetCacheSettingsRuleActionParametersVaryDefaultActionPassthrough SetCacheSettingsRuleActionParametersVaryDefaultAction = "passthrough" Link to this property const SetCacheSettingsRuleActionParametersVaryDefaultActionNormalize SetCacheSettingsRuleActionParametersVaryDefaultAction = "normalize" Link to this property
Link to this property
Link to this property
Headers map\[string, SetCacheSettingsRuleActionParametersVaryHeader]Optional A mapping of lowercase request header names to their vary configuration.
Action SetCacheSettingsRuleActionParametersVaryHeadersAction How the header value is treated when building the cache key. One of the following: const SetCacheSettingsRuleActionParametersVaryHeadersActionBypass SetCacheSettingsRuleActionParametersVaryHeadersAction = "bypass" Link to this property const SetCacheSettingsRuleActionParametersVaryHeadersActionPassthrough SetCacheSettingsRuleActionParametersVaryHeadersAction = "passthrough" Link to this property const SetCacheSettingsRuleActionParametersVaryHeadersActionNormalize SetCacheSettingsRuleActionParametersVaryHeadersAction = "normalize" Link to this property
Link to this property Languages \[]stringOptional The set of languages to normalize against. Only valid for the accept-language header. Link to this property MediaTypes \[]stringOptional The set of media types to normalize against. Only valid for the accept header. Link to this property
Link to this property
Link to this property
Link to this property Categories \[]stringOptional The categories of the rule. Link to this property Description stringOptional An informative description of the rule. Link to this property Enabled boolOptional Link to this property
ExposedCredentialCheck SetCacheSettingsRuleExposedCredentialCheckOptional Configuration for exposed credential checking. PasswordExpression string An expression that selects the password used in the credentials check. minLength1 Link to this property UsernameExpression string An expression that selects the user ID used in the credentials check. minLength1 Link to this property
Link to this property Expression stringOptional The expression defining which traffic will match the rule. minLength1 Link to this property
Logging LoggingOptional An object configuring the rule’s logging behavior. Enabled bool Whether to generate a log when the rule matches. Link to this property
Link to this property
Ratelimit SetCacheSettingsRuleRatelimitOptional An object configuring the rule’s rate limit behavior. Characteristics \[]string Characteristics of the request on which the rate limit counter will be incremented. Link to this property Period int64 Period in seconds over which the counter is being incremented. minimum0 Link to this property CountingExpression stringOptional 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 MitigationTimeout int64Optional Period of time in seconds after which the action will be disabled following its first execution. Link to this property RequestsPerPeriod int64Optional The threshold of requests per period after which the action will be executed for the first time. minimum1 Link to this property RequestsToOrigin boolOptional Whether counting is only performed when an origin is reached. Link to this property ScorePerPeriod int64Optional The score threshold per period for which the action will be executed the first time. Link to this property ScoreResponseHeaderName stringOptional A response header name provided by the origin, which contains the score to increment rate limit counter with. minLength1 Link to this property
Link to this property Ref stringOptional The reference of the rule (the rule’s ID by default). minLength1 Link to this property
Link to this property
type PhaseUpdateParamsRulesRulesetsSetCacheTagsRule struct{…} LastUpdated Time The timestamp of when the rule was last modified. formatdate-time Link to this property Version string The version of the rule. Link to this property ID stringOptional The unique ID of the rule. Link to this property Action PhaseUpdateParamsRulesRulesetsSetCacheTagsRuleActionOptional The action to perform when the rule matches. Link to this property
ActionParameters PhaseUpdateParamsRulesRulesetsSetCacheTagsRuleActionParametersOptional The parameters configuring the rule’s action. One of the following:
type PhaseUpdateParamsRulesRulesetsSetCacheTagsRuleActionParametersAddCacheTagsValues struct{…} Add cache tags using a list of values.
Operation PhaseUpdateParamsRulesRulesetsSetCacheTagsRuleActionParametersAddCacheTagsValuesOperation The operation to perform on the cache tags. One of the following: const PhaseUpdateParamsRulesRulesetsSetCacheTagsRuleActionParametersAddCacheTagsValuesOperationAdd PhaseUpdateParamsRulesRulesetsSetCacheTagsRuleActionParametersAddCacheTagsValuesOperation = "add" Link to this property const PhaseUpdateParamsRulesRulesetsSetCacheTagsRuleActionParametersAddCacheTagsValuesOperationRemove PhaseUpdateParamsRulesRulesetsSetCacheTagsRuleActionParametersAddCacheTagsValuesOperation = "remove" Link to this property const PhaseUpdateParamsRulesRulesetsSetCacheTagsRuleActionParametersAddCacheTagsValuesOperationSet PhaseUpdateParamsRulesRulesetsSetCacheTagsRuleActionParametersAddCacheTagsValuesOperation = "set" Link to this property
Link to this property Values \[]string A list of cache tag values. Link to this property
Link to this property
type PhaseUpdateParamsRulesRulesetsSetCacheTagsRuleActionParametersAddCacheTagsExpression struct{…} 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 PhaseUpdateParamsRulesRulesetsSetCacheTagsRuleActionParametersAddCacheTagsExpressionOperation The operation to perform on the cache tags. One of the following: const PhaseUpdateParamsRulesRulesetsSetCacheTagsRuleActionParametersAddCacheTagsExpressionOperationAdd PhaseUpdateParamsRulesRulesetsSetCacheTagsRuleActionParametersAddCacheTagsExpressionOperation = "add" Link to this property const PhaseUpdateParamsRulesRulesetsSetCacheTagsRuleActionParametersAddCacheTagsExpressionOperationRemove PhaseUpdateParamsRulesRulesetsSetCacheTagsRuleActionParametersAddCacheTagsExpressionOperation = "remove" Link to this property const PhaseUpdateParamsRulesRulesetsSetCacheTagsRuleActionParametersAddCacheTagsExpressionOperationSet PhaseUpdateParamsRulesRulesetsSetCacheTagsRuleActionParametersAddCacheTagsExpressionOperation = "set" Link to this property
Link to this property
Link to this property
type PhaseUpdateParamsRulesRulesetsSetCacheTagsRuleActionParametersRemoveCacheTagsValues struct{…} Remove cache tags using a list of values.
Operation PhaseUpdateParamsRulesRulesetsSetCacheTagsRuleActionParametersRemoveCacheTagsValuesOperation The operation to perform on the cache tags. One of the following: const PhaseUpdateParamsRulesRulesetsSetCacheTagsRuleActionParametersRemoveCacheTagsValuesOperationAdd PhaseUpdateParamsRulesRulesetsSetCacheTagsRuleActionParametersRemoveCacheTagsValuesOperation = "add" Link to this property const PhaseUpdateParamsRulesRulesetsSetCacheTagsRuleActionParametersRemoveCacheTagsValuesOperationRemove PhaseUpdateParamsRulesRulesetsSetCacheTagsRuleActionParametersRemoveCacheTagsValuesOperation = "remove" Link to this property const PhaseUpdateParamsRulesRulesetsSetCacheTagsRuleActionParametersRemoveCacheTagsValuesOperationSet PhaseUpdateParamsRulesRulesetsSetCacheTagsRuleActionParametersRemoveCacheTagsValuesOperation = "set" Link to this property
Link to this property Values \[]string A list of cache tag values. Link to this property
Link to this property
type PhaseUpdateParamsRulesRulesetsSetCacheTagsRuleActionParametersRemoveCacheTagsExpression struct{…} 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 PhaseUpdateParamsRulesRulesetsSetCacheTagsRuleActionParametersRemoveCacheTagsExpressionOperation The operation to perform on the cache tags. One of the following: const PhaseUpdateParamsRulesRulesetsSetCacheTagsRuleActionParametersRemoveCacheTagsExpressionOperationAdd PhaseUpdateParamsRulesRulesetsSetCacheTagsRuleActionParametersRemoveCacheTagsExpressionOperation = "add" Link to this property const PhaseUpdateParamsRulesRulesetsSetCacheTagsRuleActionParametersRemoveCacheTagsExpressionOperationRemove PhaseUpdateParamsRulesRulesetsSetCacheTagsRuleActionParametersRemoveCacheTagsExpressionOperation = "remove" Link to this property const PhaseUpdateParamsRulesRulesetsSetCacheTagsRuleActionParametersRemoveCacheTagsExpressionOperationSet PhaseUpdateParamsRulesRulesetsSetCacheTagsRuleActionParametersRemoveCacheTagsExpressionOperation = "set" Link to this property
Link to this property
Link to this property
type PhaseUpdateParamsRulesRulesetsSetCacheTagsRuleActionParametersSetCacheTagsValues struct{…} Set cache tags using a list of values.
Operation PhaseUpdateParamsRulesRulesetsSetCacheTagsRuleActionParametersSetCacheTagsValuesOperation The operation to perform on the cache tags. One of the following: const PhaseUpdateParamsRulesRulesetsSetCacheTagsRuleActionParametersSetCacheTagsValuesOperationAdd PhaseUpdateParamsRulesRulesetsSetCacheTagsRuleActionParametersSetCacheTagsValuesOperation = "add" Link to this property const PhaseUpdateParamsRulesRulesetsSetCacheTagsRuleActionParametersSetCacheTagsValuesOperationRemove PhaseUpdateParamsRulesRulesetsSetCacheTagsRuleActionParametersSetCacheTagsValuesOperation = "remove" Link to this property const PhaseUpdateParamsRulesRulesetsSetCacheTagsRuleActionParametersSetCacheTagsValuesOperationSet PhaseUpdateParamsRulesRulesetsSetCacheTagsRuleActionParametersSetCacheTagsValuesOperation = "set" Link to this property
Link to this property Values \[]string A list of cache tag values. Link to this property
Link to this property
type PhaseUpdateParamsRulesRulesetsSetCacheTagsRuleActionParametersSetCacheTagsExpression struct{…} 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 PhaseUpdateParamsRulesRulesetsSetCacheTagsRuleActionParametersSetCacheTagsExpressionOperation The operation to perform on the cache tags. One of the following: const PhaseUpdateParamsRulesRulesetsSetCacheTagsRuleActionParametersSetCacheTagsExpressionOperationAdd PhaseUpdateParamsRulesRulesetsSetCacheTagsRuleActionParametersSetCacheTagsExpressionOperation = "add" Link to this property const PhaseUpdateParamsRulesRulesetsSetCacheTagsRuleActionParametersSetCacheTagsExpressionOperationRemove PhaseUpdateParamsRulesRulesetsSetCacheTagsRuleActionParametersSetCacheTagsExpressionOperation = "remove" Link to this property const PhaseUpdateParamsRulesRulesetsSetCacheTagsRuleActionParametersSetCacheTagsExpressionOperationSet PhaseUpdateParamsRulesRulesetsSetCacheTagsRuleActionParametersSetCacheTagsExpressionOperation = "set" Link to this property
Link to this property
Link to this property
Link to this property Categories \[]stringOptional The categories of the rule. Link to this property Description stringOptional An informative description of the rule. Link to this property Enabled boolOptional Link to this property
ExposedCredentialCheck PhaseUpdateParamsRulesRulesetsSetCacheTagsRuleExposedCredentialCheckOptional Configuration for exposed credential checking. PasswordExpression string An expression that selects the password used in the credentials check. minLength1 Link to this property UsernameExpression string An expression that selects the user ID used in the credentials check. minLength1 Link to this property
Link to this property Expression stringOptional The expression defining which traffic will match the rule. minLength1 Link to this property
Logging LoggingOptional An object configuring the rule’s logging behavior. Enabled bool Whether to generate a log when the rule matches. Link to this property
Link to this property
Ratelimit PhaseUpdateParamsRulesRulesetsSetCacheTagsRuleRatelimitOptional An object configuring the rule’s rate limit behavior. Characteristics \[]string Characteristics of the request on which the rate limit counter will be incremented. Link to this property Period int64 Period in seconds over which the counter is being incremented. minimum0 Link to this property CountingExpression stringOptional 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 MitigationTimeout int64Optional Period of time in seconds after which the action will be disabled following its first execution. Link to this property RequestsPerPeriod int64Optional The threshold of requests per period after which the action will be executed for the first time. minimum1 Link to this property RequestsToOrigin boolOptional Whether counting is only performed when an origin is reached. Link to this property ScorePerPeriod int64Optional The score threshold per period for which the action will be executed the first time. Link to this property ScoreResponseHeaderName stringOptional A response header name provided by the origin, which contains the score to increment rate limit counter with. minLength1 Link to this property
Link to this property Ref stringOptional The reference of the rule (the rule’s ID by default). minLength1 Link to this property
Link to this property
type SetConfigRuleParam struct{…} LastUpdated Time The timestamp of when the rule was last modified. formatdate-time Link to this property Version string The version of the rule. Link to this property ID stringOptional The unique ID of the rule. Link to this property Action SetConfigRuleActionOptional The action to perform when the rule matches. Link to this property
ActionParameters SetConfigRuleActionParametersOptional The parameters configuring the rule’s action. AutomaticHTTPSRewrites boolOptional Whether to enable Automatic HTTPS Rewrites. Link to this property
Autominify SetConfigRuleActionParametersAutominifyOptional Which file extensions to minify automatically. CSS boolOptional Whether to minify CSS files. Link to this property HTML boolOptional Whether to minify HTML files. Link to this property JS boolOptional Whether to minify JavaScript files. Link to this property
Link to this property BIC boolOptional Whether to enable Browser Integrity Check (BIC). Link to this property ContentConverter boolOptional Whether to enable content conversion (e.g., HTML to Markdown). Link to this property DeprecatedDisableApps SetConfigRuleActionParametersDisableAppsOptional Cloudflare Apps are deprected. Whether to disable Cloudflare Apps. Link to this property DisablePayPerCrawl SetConfigRuleActionParametersDisablePayPerCrawlOptional Whether to disable Pay Per Crawl. Link to this property DisableRUM SetConfigRuleActionParametersDisableRUMOptional Whether to disable Real User Monitoring (RUM). Link to this property DisableZaraz SetConfigRuleActionParametersDisableZarazOptional Whether to disable Zaraz. Link to this property EmailObfuscation boolOptional Whether to enable Email Obfuscation. Link to this property Fonts boolOptional Whether to enable Cloudflare Fonts. Link to this property HotlinkProtection boolOptional Whether to enable Hotlink Protection. Link to this property DeprecatedMirage boolOptional Mirage is deprecated. More information at https://developers.cloudflare.com/speed/optimization/images/mirage/. Whether to enable Mirage. Link to this property OpportunisticEncryption boolOptional Whether to enable Opportunistic Encryption. Link to this property
Polish SetConfigRuleActionParametersPolishOptional The Polish level to configure. One of the following: const SetConfigRuleActionParametersPolishOff SetConfigRuleActionParametersPolish = "off" Link to this property const SetConfigRuleActionParametersPolishLossless SetConfigRuleActionParametersPolish = "lossless" Link to this property const SetConfigRuleActionParametersPolishLossy SetConfigRuleActionParametersPolish = "lossy" Link to this property const SetConfigRuleActionParametersPolishWebP SetConfigRuleActionParametersPolish = "webp" Link to this property
Link to this property RedirectsForAITraining boolOptional Whether to redirect verified AI training crawlers to canonical URLs found in the HTML response. Link to this property
RequestBodyBuffering SetConfigRuleActionParametersRequestBodyBufferingOptional The request body buffering mode. One of the following: const SetConfigRuleActionParametersRequestBodyBufferingNone SetConfigRuleActionParametersRequestBodyBuffering = "none" Link to this property const SetConfigRuleActionParametersRequestBodyBufferingStandard SetConfigRuleActionParametersRequestBodyBuffering = "standard" Link to this property const SetConfigRuleActionParametersRequestBodyBufferingFull SetConfigRuleActionParametersRequestBodyBuffering = "full" Link to this property
Link to this property
ResponseBodyBuffering SetConfigRuleActionParametersResponseBodyBufferingOptional The response body buffering mode. One of the following: const SetConfigRuleActionParametersResponseBodyBufferingNone SetConfigRuleActionParametersResponseBodyBuffering = "none" Link to this property const SetConfigRuleActionParametersResponseBodyBufferingStandard SetConfigRuleActionParametersResponseBodyBuffering = "standard" Link to this property
Link to this property RocketLoader boolOptional Whether to enable Rocket Loader. Link to this property
SecurityLevel SetConfigRuleActionParametersSecurityLevelOptional The Security Level to configure. One of the following: const SetConfigRuleActionParametersSecurityLevelOff SetConfigRuleActionParametersSecurityLevel = "off" Link to this property const SetConfigRuleActionParametersSecurityLevelEssentiallyOff SetConfigRuleActionParametersSecurityLevel = "essentially\_off" Link to this property const SetConfigRuleActionParametersSecurityLevelLow SetConfigRuleActionParametersSecurityLevel = "low" Link to this property const SetConfigRuleActionParametersSecurityLevelMedium SetConfigRuleActionParametersSecurityLevel = "medium" Link to this property const SetConfigRuleActionParametersSecurityLevelHigh SetConfigRuleActionParametersSecurityLevel = "high" Link to this property const SetConfigRuleActionParametersSecurityLevelUnderAttack SetConfigRuleActionParametersSecurityLevel = "under\_attack" Link to this property
Link to this property ServerSideExcludes boolOptional Whether to enable Server-Side Excludes. Link to this property
SSL SetConfigRuleActionParametersSSLOptional The SSL level to configure. One of the following: const SetConfigRuleActionParametersSSLOff SetConfigRuleActionParametersSSL = "off" Link to this property const SetConfigRuleActionParametersSSLFlexible SetConfigRuleActionParametersSSL = "flexible" Link to this property const SetConfigRuleActionParametersSSLFull SetConfigRuleActionParametersSSL = "full" Link to this property const SetConfigRuleActionParametersSSLStrict SetConfigRuleActionParametersSSL = "strict" Link to this property const SetConfigRuleActionParametersSSLOriginPull SetConfigRuleActionParametersSSL = "origin\_pull" Link to this property
Link to this property DeprecatedSXG boolOptional Signed Exchanges (SXG) is deprecated. Whether to enable Signed Exchanges (SXG). Link to this property WebmcpEnabled boolOptional Whether to serve the WebMCP bridge script, which exposes the page’s tools to browser AI agents. Link to this property WebmcpPacks \[]stringOptional Bundled WebMCP tool packs to activate for matching requests. An empty array disables all packs. Omitting this parameter leaves the pack selection unchanged. Does not enable the WebMCP bridge itself. Non-empty selections require the WebMCP Configuration Rules entitlement. Link to this property
Link to this property Categories \[]stringOptional The categories of the rule. Link to this property Description stringOptional An informative description of the rule. Link to this property Enabled boolOptional Link to this property
ExposedCredentialCheck SetConfigRuleExposedCredentialCheckOptional Configuration for exposed credential checking. PasswordExpression string An expression that selects the password used in the credentials check. minLength1 Link to this property UsernameExpression string An expression that selects the user ID used in the credentials check. minLength1 Link to this property
Link to this property Expression stringOptional The expression defining which traffic will match the rule. minLength1 Link to this property
Logging LoggingOptional An object configuring the rule’s logging behavior. Enabled bool Whether to generate a log when the rule matches. Link to this property
Link to this property
Ratelimit SetConfigRuleRatelimitOptional An object configuring the rule’s rate limit behavior. Characteristics \[]string Characteristics of the request on which the rate limit counter will be incremented. Link to this property Period int64 Period in seconds over which the counter is being incremented. minimum0 Link to this property CountingExpression stringOptional 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 MitigationTimeout int64Optional Period of time in seconds after which the action will be disabled following its first execution. Link to this property RequestsPerPeriod int64Optional The threshold of requests per period after which the action will be executed for the first time. minimum1 Link to this property RequestsToOrigin boolOptional Whether counting is only performed when an origin is reached. Link to this property ScorePerPeriod int64Optional The score threshold per period for which the action will be executed the first time. Link to this property ScoreResponseHeaderName stringOptional A response header name provided by the origin, which contains the score to increment rate limit counter with. minLength1 Link to this property
Link to this property Ref stringOptional The reference of the rule (the rule’s ID by default). minLength1 Link to this property
Link to this property
type SkipRuleParam struct{…} LastUpdated Time The timestamp of when the rule was last modified. formatdate-time Link to this property Version string The version of the rule. Link to this property ID stringOptional The unique ID of the rule. Link to this property Action SkipRuleActionOptional The action to perform when the rule matches. Link to this property
ActionParameters SkipRuleActionParametersOptional The parameters configuring the rule’s action. Phase SkipRuleActionParametersPhaseOptional A phase to skip the execution of. This option is only compatible with the products option. Link to this property
Phases \[]PhaseOptional A list of phases to skip the execution of. This option is incompatible with the rulesets option. One of the following: const PhaseDDoSL4 Phase = "ddos\_l4" Link to this property const PhaseDDoSL7 Phase = "ddos\_l7" Link to this property const PhaseHTTPConfigSettings Phase = "http\_config\_settings" Link to this property const PhaseHTTPCustomErrors Phase = "http\_custom\_errors" Link to this property const PhaseHTTPLogCustomFields Phase = "http\_log\_custom\_fields" Link to this property const PhaseHTTPRatelimit Phase = "http\_ratelimit" Link to this property const PhaseHTTPRequestCacheSettings Phase = "http\_request\_cache\_settings" Link to this property const PhaseHTTPRequestDynamicRedirect Phase = "http\_request\_dynamic\_redirect" Link to this property const PhaseHTTPRequestFirewallCustom Phase = "http\_request\_firewall\_custom" Link to this property const PhaseHTTPRequestFirewallManaged Phase = "http\_request\_firewall\_managed" Link to this property const PhaseHTTPRequestLateTransform Phase = "http\_request\_late\_transform" Link to this property const PhaseHTTPRequestOrigin Phase = "http\_request\_origin" Link to this property const PhaseHTTPRequestRedirect Phase = "http\_request\_redirect" Link to this property const PhaseHTTPRequestSanitize Phase = "http\_request\_sanitize" Link to this property const PhaseHTTPRequestSBFM Phase = "http\_request\_sbfm" Link to this property const PhaseHTTPRequestTransform Phase = "http\_request\_transform" Link to this property const PhaseHTTPResponseCacheSettings Phase = "http\_response\_cache\_settings" Link to this property const PhaseHTTPResponseCompression Phase = "http\_response\_compression" Link to this property const PhaseHTTPResponseFirewallManaged Phase = "http\_response\_firewall\_managed" Link to this property const PhaseHTTPResponseHeadersTransform Phase = "http\_response\_headers\_transform" Link to this property const PhaseMagicTransit Phase = "magic\_transit" Link to this property const PhaseMagicTransitIDsManaged Phase = "magic\_transit\_ids\_managed" Link to this property const PhaseMagicTransitManaged Phase = "magic\_transit\_managed" Link to this property const PhaseMagicTransitRatelimit Phase = "magic\_transit\_ratelimit" Link to this property
Link to this property
Products \[]SkipRuleActionParametersProductOptional A list of legacy security products to skip the execution of. One of the following: const SkipRuleActionParametersProductBIC SkipRuleActionParametersProduct = "bic" Link to this property const SkipRuleActionParametersProductHot SkipRuleActionParametersProduct = "hot" Link to this property const SkipRuleActionParametersProductRateLimit SkipRuleActionParametersProduct = "rateLimit" Link to this property const SkipRuleActionParametersProductSecurityLevel SkipRuleActionParametersProduct = "securityLevel" Link to this property const SkipRuleActionParametersProductUABlock SkipRuleActionParametersProduct = "uaBlock" Link to this property const SkipRuleActionParametersProductWAF SkipRuleActionParametersProduct = "waf" Link to this property const SkipRuleActionParametersProductZoneLockdown SkipRuleActionParametersProduct = "zoneLockdown" Link to this property
Link to this property Rules map\[string, \[]string]Optional A mapping of ruleset IDs to a list of rule IDs in that ruleset to skip the execution of. This option is incompatible with the ruleset option. Link to this property Ruleset SkipRuleActionParametersRulesetOptional A ruleset to skip the execution of. This option is incompatible with the rulesets option. Link to this property Rulesets \[]stringOptional A list of ruleset IDs to skip the execution of. This option is incompatible with the ruleset and phases options. Link to this property
Link to this property Categories \[]stringOptional The categories of the rule. Link to this property Description stringOptional An informative description of the rule. Link to this property Enabled boolOptional Link to this property
ExposedCredentialCheck SkipRuleExposedCredentialCheckOptional Configuration for exposed credential checking. PasswordExpression string An expression that selects the password used in the credentials check. minLength1 Link to this property UsernameExpression string An expression that selects the user ID used in the credentials check. minLength1 Link to this property
Link to this property Expression stringOptional The expression defining which traffic will match the rule. minLength1 Link to this property
Logging LoggingOptional An object configuring the rule’s logging behavior. Enabled bool Whether to generate a log when the rule matches. Link to this property
Link to this property
Ratelimit SkipRuleRatelimitOptional An object configuring the rule’s rate limit behavior. Characteristics \[]string Characteristics of the request on which the rate limit counter will be incremented. Link to this property Period int64 Period in seconds over which the counter is being incremented. minimum0 Link to this property CountingExpression stringOptional 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 MitigationTimeout int64Optional Period of time in seconds after which the action will be disabled following its first execution. Link to this property RequestsPerPeriod int64Optional The threshold of requests per period after which the action will be executed for the first time. minimum1 Link to this property RequestsToOrigin boolOptional Whether counting is only performed when an origin is reached. Link to this property ScorePerPeriod int64Optional The score threshold per period for which the action will be executed the first time. Link to this property ScoreResponseHeaderName stringOptional A response header name provided by the origin, which contains the score to increment rate limit counter with. minLength1 Link to this property
Link to this property Ref stringOptional The reference of the rule (the rule’s ID by default). minLength1 Link to this property
Link to this property
type PhaseUpdateParamsRulesRulesetsTransformResponseHTMLRule struct{…} LastUpdated Time The timestamp of when the rule was last modified. formatdate-time Link to this property Version string The version of the rule. Link to this property ID stringOptional The unique ID of the rule. Link to this property Action PhaseUpdateParamsRulesRulesetsTransformResponseHTMLRuleActionOptional The action to perform when the rule matches. Link to this property
ActionParameters PhaseUpdateParamsRulesRulesetsTransformResponseHTMLRuleActionParametersOptional The parameters configuring the rule’s action. LinkMaze unknown Enables the link maze transformation on the response. Link to this property
Link to this property Categories \[]stringOptional The categories of the rule. Link to this property Description stringOptional An informative description of the rule. Link to this property Enabled boolOptional Link to this property
ExposedCredentialCheck PhaseUpdateParamsRulesRulesetsTransformResponseHTMLRuleExposedCredentialCheckOptional Configuration for exposed credential checking. PasswordExpression string An expression that selects the password used in the credentials check. minLength1 Link to this property UsernameExpression string An expression that selects the user ID used in the credentials check. minLength1 Link to this property
Link to this property Expression stringOptional The expression defining which traffic will match the rule. minLength1 Link to this property
Logging LoggingOptional An object configuring the rule’s logging behavior. Enabled bool Whether to generate a log when the rule matches. Link to this property
Link to this property
Ratelimit PhaseUpdateParamsRulesRulesetsTransformResponseHTMLRuleRatelimitOptional An object configuring the rule’s rate limit behavior. Characteristics \[]string Characteristics of the request on which the rate limit counter will be incremented. Link to this property Period int64 Period in seconds over which the counter is being incremented. minimum0 Link to this property CountingExpression stringOptional 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 MitigationTimeout int64Optional Period of time in seconds after which the action will be disabled following its first execution. Link to this property RequestsPerPeriod int64Optional The threshold of requests per period after which the action will be executed for the first time. minimum1 Link to this property RequestsToOrigin boolOptional Whether counting is only performed when an origin is reached. Link to this property ScorePerPeriod int64Optional The score threshold per period for which the action will be executed the first time. Link to this property ScoreResponseHeaderName stringOptional A response header name provided by the origin, which contains the score to increment rate limit counter with. minLength1 Link to this property
Link to this property Ref stringOptional The reference of the rule (the rule’s ID by default). minLength1 Link to this property
Link to this property
Link to this property
[Link to this property](<#(resource)%20rulesets.phases%20%3E%20(method)%20update%20%3E%20(params)%20default>) ##### ReturnsExpand Collapse
type PhaseUpdateResponseEnvelopeResult interface{…} A result. One of the following:
type PhaseUpdateResponseEnvelopeResult struct{…} A ruleset object. ID string The unique ID of the ruleset. Link to this property
Kind Kind The kind of the ruleset. One of the following: const KindManaged Kind = "managed" Link to this property const KindCustom Kind = "custom" Link to this property const KindRoot Kind = "root" Link to this property const KindZone Kind = "zone" Link to this property
Link to this property LastUpdated Time The timestamp of when the ruleset was last modified. formatdate-time Link to this property Name string The human-readable name of the ruleset. minLength1 Link to this property
Phase Phase The phase of the ruleset. One of the following: const PhaseDDoSL4 Phase = "ddos\_l4" Link to this property const PhaseDDoSL7 Phase = "ddos\_l7" Link to this property const PhaseHTTPConfigSettings Phase = "http\_config\_settings" Link to this property const PhaseHTTPCustomErrors Phase = "http\_custom\_errors" Link to this property const PhaseHTTPLogCustomFields Phase = "http\_log\_custom\_fields" Link to this property const PhaseHTTPRatelimit Phase = "http\_ratelimit" Link to this property const PhaseHTTPRequestCacheSettings Phase = "http\_request\_cache\_settings" Link to this property const PhaseHTTPRequestDynamicRedirect Phase = "http\_request\_dynamic\_redirect" Link to this property const PhaseHTTPRequestFirewallCustom Phase = "http\_request\_firewall\_custom" Link to this property const PhaseHTTPRequestFirewallManaged Phase = "http\_request\_firewall\_managed" Link to this property const PhaseHTTPRequestLateTransform Phase = "http\_request\_late\_transform" Link to this property const PhaseHTTPRequestOrigin Phase = "http\_request\_origin" Link to this property const PhaseHTTPRequestRedirect Phase = "http\_request\_redirect" Link to this property const PhaseHTTPRequestSanitize Phase = "http\_request\_sanitize" Link to this property const PhaseHTTPRequestSBFM Phase = "http\_request\_sbfm" Link to this property const PhaseHTTPRequestTransform Phase = "http\_request\_transform" Link to this property const PhaseHTTPResponseCacheSettings Phase = "http\_response\_cache\_settings" Link to this property const PhaseHTTPResponseCompression Phase = "http\_response\_compression" Link to this property const PhaseHTTPResponseFirewallManaged Phase = "http\_response\_firewall\_managed" Link to this property const PhaseHTTPResponseHeadersTransform Phase = "http\_response\_headers\_transform" Link to this property const PhaseMagicTransit Phase = "magic\_transit" Link to this property const PhaseMagicTransitIDsManaged Phase = "magic\_transit\_ids\_managed" Link to this property const PhaseMagicTransitManaged Phase = "magic\_transit\_managed" Link to this property const PhaseMagicTransitRatelimit Phase = "magic\_transit\_ratelimit" Link to this property
Link to this property
Rules \[]PhaseUpdateResponseEnvelopeResultRules The list of rules in the ruleset. One of the following:
type PhaseUpdateResponseEnvelopeResultRulesBlockRule struct{…} ID string Link to this property Action string Link to this property Enabled bool Link to this property Expression string Link to this property Ref string Link to this property
Link to this property
type PhaseUpdateResponseEnvelopeResultRulesChallengeRule struct{…} ID string The unique ID of the rule. Link to this property Action PhaseUpdateResponseEnvelopeResultRulesChallengeRuleAction The action to perform when the rule matches. Link to this property Enabled bool 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 LastUpdated Time 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 ActionParameters unknownOptional The parameters configuring the rule’s action. Link to this property Categories \[]stringOptional The categories of the rule. Link to this property Description stringOptional An informative description of the rule. Link to this property
ExposedCredentialCheck PhaseUpdateResponseEnvelopeResultRulesChallengeRuleExposedCredentialCheckOptional Configuration for exposed credential checking. PasswordExpression string An expression that selects the password used in the credentials check. minLength1 Link to this property UsernameExpression string An expression that selects the user ID used in the credentials check. minLength1 Link to this property
Link to this property
Logging LoggingOptional An object configuring the rule’s logging behavior. Enabled bool Whether to generate a log when the rule matches. Link to this property
Link to this property
Ratelimit PhaseUpdateResponseEnvelopeResultRulesChallengeRuleRatelimitOptional An object configuring the rule’s rate limit behavior. Characteristics \[]string Characteristics of the request on which the rate limit counter will be incremented. Link to this property Period int64 Period in seconds over which the counter is being incremented. minimum0 Link to this property CountingExpression stringOptional 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 MitigationTimeout int64Optional Period of time in seconds after which the action will be disabled following its first execution. Link to this property RequestsPerPeriod int64Optional The threshold of requests per period after which the action will be executed for the first time. minimum1 Link to this property RequestsToOrigin boolOptional Whether counting is only performed when an origin is reached. Link to this property ScorePerPeriod int64Optional The score threshold per period for which the action will be executed the first time. Link to this property ScoreResponseHeaderName stringOptional 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
type PhaseUpdateResponseEnvelopeResultRulesResponseCompressionRule struct{…} ID string Link to this property Action string Link to this property Enabled bool Link to this property Expression string Link to this property Ref string Link to this property
Link to this property
type PhaseUpdateResponseEnvelopeResultRulesDDoSDynamicRule struct{…} ID string Link to this property Action string Link to this property Enabled bool Link to this property Expression string Link to this property Ref string Link to this property
Link to this property
type PhaseUpdateResponseEnvelopeResultRulesExecuteRule struct{…} ID string Link to this property Action string Link to this property Enabled bool Link to this property Expression string Link to this property Ref string Link to this property
Link to this property
type PhaseUpdateResponseEnvelopeResultRulesForceConnectionCloseRule struct{…} ID string Link to this property Action string Link to this property Enabled bool Link to this property Expression string Link to this property Ref string Link to this property
Link to this property
type PhaseUpdateResponseEnvelopeResultRulesJavaScriptChallengeRule struct{…} ID string The unique ID of the rule. Link to this property Action PhaseUpdateResponseEnvelopeResultRulesJavaScriptChallengeRuleAction The action to perform when the rule matches. Link to this property Enabled bool 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 LastUpdated Time 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 ActionParameters unknownOptional The parameters configuring the rule’s action. Link to this property Categories \[]stringOptional The categories of the rule. Link to this property Description stringOptional An informative description of the rule. Link to this property
ExposedCredentialCheck PhaseUpdateResponseEnvelopeResultRulesJavaScriptChallengeRuleExposedCredentialCheckOptional Configuration for exposed credential checking. PasswordExpression string An expression that selects the password used in the credentials check. minLength1 Link to this property UsernameExpression string An expression that selects the user ID used in the credentials check. minLength1 Link to this property
Link to this property
Logging LoggingOptional An object configuring the rule’s logging behavior. Enabled bool Whether to generate a log when the rule matches. Link to this property
Link to this property
Ratelimit PhaseUpdateResponseEnvelopeResultRulesJavaScriptChallengeRuleRatelimitOptional An object configuring the rule’s rate limit behavior. Characteristics \[]string Characteristics of the request on which the rate limit counter will be incremented. Link to this property Period int64 Period in seconds over which the counter is being incremented. minimum0 Link to this property CountingExpression stringOptional 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 MitigationTimeout int64Optional Period of time in seconds after which the action will be disabled following its first execution. Link to this property RequestsPerPeriod int64Optional The threshold of requests per period after which the action will be executed for the first time. minimum1 Link to this property RequestsToOrigin boolOptional Whether counting is only performed when an origin is reached. Link to this property ScorePerPeriod int64Optional The score threshold per period for which the action will be executed the first time. Link to this property ScoreResponseHeaderName stringOptional 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
type PhaseUpdateResponseEnvelopeResultRulesLogRule struct{…} ID string Link to this property Action string Link to this property Enabled bool Link to this property Expression string Link to this property Ref string Link to this property
Link to this property
type PhaseUpdateResponseEnvelopeResultRulesLogCustomFieldRule struct{…} ID string Link to this property Action string Link to this property Enabled bool Link to this property Expression string Link to this property Ref string Link to this property
Link to this property
type PhaseUpdateResponseEnvelopeResultRulesManagedChallengeRule struct{…} ID string Link to this property Action string Link to this property Enabled bool Link to this property Expression string Link to this property Ref string Link to this property
Link to this property
type PhaseUpdateResponseEnvelopeResultRulesRedirectRule struct{…} ID string Link to this property Action string Link to this property Enabled bool Link to this property Expression string Link to this property Ref string Link to this property
Link to this property
type PhaseUpdateResponseEnvelopeResultRulesRewriteRule struct{…} ID string Link to this property Action string Link to this property Enabled bool Link to this property Expression string Link to this property Ref string Link to this property
Link to this property
type PhaseUpdateResponseEnvelopeResultRulesRouteRule struct{…} ID string Link to this property Action string Link to this property Enabled bool Link to this property Expression string Link to this property Ref string Link to this property
Link to this property
type PhaseUpdateResponseEnvelopeResultRulesScoreRule struct{…} ID string Link to this property Action string Link to this property Enabled bool Link to this property Expression string Link to this property Ref string Link to this property
Link to this property
type PhaseUpdateResponseEnvelopeResultRulesServeErrorRule struct{…} ID string Link to this property Action string Link to this property Enabled bool Link to this property Expression string Link to this property Ref string Link to this property
Link to this property
type PhaseUpdateResponseEnvelopeResultRulesSetCacheControlRule struct{…} ID string The unique ID of the rule. Link to this property Action PhaseUpdateResponseEnvelopeResultRulesSetCacheControlRuleAction The action to perform when the rule matches. Link to this property Enabled bool Link to this property Expression string The expression defining which traffic will match the rule. minLength1 Link to this property LastUpdated Time 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
ActionParameters PhaseUpdateResponseEnvelopeResultRulesSetCacheControlRuleActionParametersOptional The parameters configuring the rule’s action.
Immutable PhaseUpdateResponseEnvelopeResultRulesSetCacheControlRuleActionParametersImmutableOptional A cache-control directive configuration. One of the following:
type PhaseUpdateResponseEnvelopeResultRulesSetCacheControlRuleActionParametersImmutableSetDirective struct{…} Set the directive.
Operation PhaseUpdateResponseEnvelopeResultRulesSetCacheControlRuleActionParametersImmutableSetDirectiveOperation The operation to perform on the cache-control directive. One of the following: const PhaseUpdateResponseEnvelopeResultRulesSetCacheControlRuleActionParametersImmutableSetDirectiveOperationSet PhaseUpdateResponseEnvelopeResultRulesSetCacheControlRuleActionParametersImmutableSetDirectiveOperation = "set" Link to this property const PhaseUpdateResponseEnvelopeResultRulesSetCacheControlRuleActionParametersImmutableSetDirectiveOperationRemove PhaseUpdateResponseEnvelopeResultRulesSetCacheControlRuleActionParametersImmutableSetDirectiveOperation = "remove" Link to this property
Link to this property CloudflareOnly boolOptional Whether the directive should only be applied to the Cloudflare CDN cache. Link to this property
Link to this property
type PhaseUpdateResponseEnvelopeResultRulesSetCacheControlRuleActionParametersImmutableRemoveDirective struct{…} Remove the directive.
Operation PhaseUpdateResponseEnvelopeResultRulesSetCacheControlRuleActionParametersImmutableRemoveDirectiveOperation The operation to perform on the cache-control directive. One of the following: const PhaseUpdateResponseEnvelopeResultRulesSetCacheControlRuleActionParametersImmutableRemoveDirectiveOperationSet PhaseUpdateResponseEnvelopeResultRulesSetCacheControlRuleActionParametersImmutableRemoveDirectiveOperation = "set" Link to this property const PhaseUpdateResponseEnvelopeResultRulesSetCacheControlRuleActionParametersImmutableRemoveDirectiveOperationRemove PhaseUpdateResponseEnvelopeResultRulesSetCacheControlRuleActionParametersImmutableRemoveDirectiveOperation = "remove" Link to this property
Link to this property CloudflareOnly boolOptional Whether the directive should only be applied to the Cloudflare CDN cache. Link to this property
Link to this property
Link to this property
MaxAge PhaseUpdateResponseEnvelopeResultRulesSetCacheControlRuleActionParametersMaxAgeOptional A cache-control directive configuration that accepts a duration value in seconds. One of the following:
type PhaseUpdateResponseEnvelopeResultRulesSetCacheControlRuleActionParametersMaxAgeSetDirective struct{…} Set the directive with a duration value in seconds.
Operation PhaseUpdateResponseEnvelopeResultRulesSetCacheControlRuleActionParametersMaxAgeSetDirectiveOperation The operation to perform on the cache-control directive. One of the following: const PhaseUpdateResponseEnvelopeResultRulesSetCacheControlRuleActionParametersMaxAgeSetDirectiveOperationSet PhaseUpdateResponseEnvelopeResultRulesSetCacheControlRuleActionParametersMaxAgeSetDirectiveOperation = "set" Link to this property const PhaseUpdateResponseEnvelopeResultRulesSetCacheControlRuleActionParametersMaxAgeSetDirectiveOperationRemove PhaseUpdateResponseEnvelopeResultRulesSetCacheControlRuleActionParametersMaxAgeSetDirectiveOperation = "remove" Link to this property
Link to this property Value int64 The duration value in seconds for the directive. minimum0 Link to this property CloudflareOnly boolOptional Whether the directive should only be applied to the Cloudflare CDN cache. Link to this property
Link to this property
type PhaseUpdateResponseEnvelopeResultRulesSetCacheControlRuleActionParametersMaxAgeRemoveDirective struct{…} Remove the directive.
Operation PhaseUpdateResponseEnvelopeResultRulesSetCacheControlRuleActionParametersMaxAgeRemoveDirectiveOperation The operation to perform on the cache-control directive. One of the following: const PhaseUpdateResponseEnvelopeResultRulesSetCacheControlRuleActionParametersMaxAgeRemoveDirectiveOperationSet PhaseUpdateResponseEnvelopeResultRulesSetCacheControlRuleActionParametersMaxAgeRemoveDirectiveOperation = "set" Link to this property const PhaseUpdateResponseEnvelopeResultRulesSetCacheControlRuleActionParametersMaxAgeRemoveDirectiveOperationRemove PhaseUpdateResponseEnvelopeResultRulesSetCacheControlRuleActionParametersMaxAgeRemoveDirectiveOperation = "remove" Link to this property
Link to this property CloudflareOnly boolOptional Whether the directive should only be applied to the Cloudflare CDN cache. Link to this property
Link to this property
Link to this property
MustRevalidate PhaseUpdateResponseEnvelopeResultRulesSetCacheControlRuleActionParametersMustRevalidateOptional A cache-control directive configuration. One of the following:
type PhaseUpdateResponseEnvelopeResultRulesSetCacheControlRuleActionParametersMustRevalidateSetDirective struct{…} Set the directive.
Operation PhaseUpdateResponseEnvelopeResultRulesSetCacheControlRuleActionParametersMustRevalidateSetDirectiveOperation The operation to perform on the cache-control directive. One of the following: const PhaseUpdateResponseEnvelopeResultRulesSetCacheControlRuleActionParametersMustRevalidateSetDirectiveOperationSet PhaseUpdateResponseEnvelopeResultRulesSetCacheControlRuleActionParametersMustRevalidateSetDirectiveOperation = "set" Link to this property const PhaseUpdateResponseEnvelopeResultRulesSetCacheControlRuleActionParametersMustRevalidateSetDirectiveOperationRemove PhaseUpdateResponseEnvelopeResultRulesSetCacheControlRuleActionParametersMustRevalidateSetDirectiveOperation = "remove" Link to this property
Link to this property CloudflareOnly boolOptional Whether the directive should only be applied to the Cloudflare CDN cache. Link to this property
Link to this property
type PhaseUpdateResponseEnvelopeResultRulesSetCacheControlRuleActionParametersMustRevalidateRemoveDirective struct{…} Remove the directive.
Operation PhaseUpdateResponseEnvelopeResultRulesSetCacheControlRuleActionParametersMustRevalidateRemoveDirectiveOperation The operation to perform on the cache-control directive. One of the following: const PhaseUpdateResponseEnvelopeResultRulesSetCacheControlRuleActionParametersMustRevalidateRemoveDirectiveOperationSet PhaseUpdateResponseEnvelopeResultRulesSetCacheControlRuleActionParametersMustRevalidateRemoveDirectiveOperation = "set" Link to this property const PhaseUpdateResponseEnvelopeResultRulesSetCacheControlRuleActionParametersMustRevalidateRemoveDirectiveOperationRemove PhaseUpdateResponseEnvelopeResultRulesSetCacheControlRuleActionParametersMustRevalidateRemoveDirectiveOperation = "remove" Link to this property
Link to this property CloudflareOnly boolOptional Whether the directive should only be applied to the Cloudflare CDN cache. Link to this property
Link to this property
Link to this property
MustUnderstand PhaseUpdateResponseEnvelopeResultRulesSetCacheControlRuleActionParametersMustUnderstandOptional A cache-control directive configuration. One of the following:
type PhaseUpdateResponseEnvelopeResultRulesSetCacheControlRuleActionParametersMustUnderstandSetDirective struct{…} Set the directive.
Operation PhaseUpdateResponseEnvelopeResultRulesSetCacheControlRuleActionParametersMustUnderstandSetDirectiveOperation The operation to perform on the cache-control directive. One of the following: const PhaseUpdateResponseEnvelopeResultRulesSetCacheControlRuleActionParametersMustUnderstandSetDirectiveOperationSet PhaseUpdateResponseEnvelopeResultRulesSetCacheControlRuleActionParametersMustUnderstandSetDirectiveOperation = "set" Link to this property const PhaseUpdateResponseEnvelopeResultRulesSetCacheControlRuleActionParametersMustUnderstandSetDirectiveOperationRemove PhaseUpdateResponseEnvelopeResultRulesSetCacheControlRuleActionParametersMustUnderstandSetDirectiveOperation = "remove" Link to this property
Link to this property CloudflareOnly boolOptional Whether the directive should only be applied to the Cloudflare CDN cache. Link to this property
Link to this property
type PhaseUpdateResponseEnvelopeResultRulesSetCacheControlRuleActionParametersMustUnderstandRemoveDirective struct{…} Remove the directive.
Operation PhaseUpdateResponseEnvelopeResultRulesSetCacheControlRuleActionParametersMustUnderstandRemoveDirectiveOperation The operation to perform on the cache-control directive. One of the following: const PhaseUpdateResponseEnvelopeResultRulesSetCacheControlRuleActionParametersMustUnderstandRemoveDirectiveOperationSet PhaseUpdateResponseEnvelopeResultRulesSetCacheControlRuleActionParametersMustUnderstandRemoveDirectiveOperation = "set" Link to this property const PhaseUpdateResponseEnvelopeResultRulesSetCacheControlRuleActionParametersMustUnderstandRemoveDirectiveOperationRemove PhaseUpdateResponseEnvelopeResultRulesSetCacheControlRuleActionParametersMustUnderstandRemoveDirectiveOperation = "remove" Link to this property
Link to this property CloudflareOnly boolOptional Whether the directive should only be applied to the Cloudflare CDN cache. Link to this property
Link to this property
Link to this property
NoCache PhaseUpdateResponseEnvelopeResultRulesSetCacheControlRuleActionParametersNoCacheOptional A cache-control directive configuration that accepts optional qualifiers (header names). One of the following:
type PhaseUpdateResponseEnvelopeResultRulesSetCacheControlRuleActionParametersNoCacheSetDirective struct{…} Set the directive with optional qualifiers.
Operation PhaseUpdateResponseEnvelopeResultRulesSetCacheControlRuleActionParametersNoCacheSetDirectiveOperation The operation to perform on the cache-control directive. One of the following: const PhaseUpdateResponseEnvelopeResultRulesSetCacheControlRuleActionParametersNoCacheSetDirectiveOperationSet PhaseUpdateResponseEnvelopeResultRulesSetCacheControlRuleActionParametersNoCacheSetDirectiveOperation = "set" Link to this property const PhaseUpdateResponseEnvelopeResultRulesSetCacheControlRuleActionParametersNoCacheSetDirectiveOperationRemove PhaseUpdateResponseEnvelopeResultRulesSetCacheControlRuleActionParametersNoCacheSetDirectiveOperation = "remove" Link to this property
Link to this property CloudflareOnly boolOptional Whether the directive should only be applied to the Cloudflare CDN cache. Link to this property Qualifiers \[]stringOptional 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
type PhaseUpdateResponseEnvelopeResultRulesSetCacheControlRuleActionParametersNoCacheRemoveDirective struct{…} Remove the directive.
Operation PhaseUpdateResponseEnvelopeResultRulesSetCacheControlRuleActionParametersNoCacheRemoveDirectiveOperation The operation to perform on the cache-control directive. One of the following: const PhaseUpdateResponseEnvelopeResultRulesSetCacheControlRuleActionParametersNoCacheRemoveDirectiveOperationSet PhaseUpdateResponseEnvelopeResultRulesSetCacheControlRuleActionParametersNoCacheRemoveDirectiveOperation = "set" Link to this property const PhaseUpdateResponseEnvelopeResultRulesSetCacheControlRuleActionParametersNoCacheRemoveDirectiveOperationRemove PhaseUpdateResponseEnvelopeResultRulesSetCacheControlRuleActionParametersNoCacheRemoveDirectiveOperation = "remove" Link to this property
Link to this property CloudflareOnly boolOptional Whether the directive should only be applied to the Cloudflare CDN cache. Link to this property
Link to this property
Link to this property
NoStore PhaseUpdateResponseEnvelopeResultRulesSetCacheControlRuleActionParametersNoStoreOptional A cache-control directive configuration. One of the following:
type PhaseUpdateResponseEnvelopeResultRulesSetCacheControlRuleActionParametersNoStoreSetDirective struct{…} Set the directive.
Operation PhaseUpdateResponseEnvelopeResultRulesSetCacheControlRuleActionParametersNoStoreSetDirectiveOperation The operation to perform on the cache-control directive. One of the following: const PhaseUpdateResponseEnvelopeResultRulesSetCacheControlRuleActionParametersNoStoreSetDirectiveOperationSet PhaseUpdateResponseEnvelopeResultRulesSetCacheControlRuleActionParametersNoStoreSetDirectiveOperation = "set" Link to this property const PhaseUpdateResponseEnvelopeResultRulesSetCacheControlRuleActionParametersNoStoreSetDirectiveOperationRemove PhaseUpdateResponseEnvelopeResultRulesSetCacheControlRuleActionParametersNoStoreSetDirectiveOperation = "remove" Link to this property
Link to this property CloudflareOnly boolOptional Whether the directive should only be applied to the Cloudflare CDN cache. Link to this property
Link to this property
type PhaseUpdateResponseEnvelopeResultRulesSetCacheControlRuleActionParametersNoStoreRemoveDirective struct{…} Remove the directive.
Operation PhaseUpdateResponseEnvelopeResultRulesSetCacheControlRuleActionParametersNoStoreRemoveDirectiveOperation The operation to perform on the cache-control directive. One of the following: const PhaseUpdateResponseEnvelopeResultRulesSetCacheControlRuleActionParametersNoStoreRemoveDirectiveOperationSet PhaseUpdateResponseEnvelopeResultRulesSetCacheControlRuleActionParametersNoStoreRemoveDirectiveOperation = "set" Link to this property const PhaseUpdateResponseEnvelopeResultRulesSetCacheControlRuleActionParametersNoStoreRemoveDirectiveOperationRemove PhaseUpdateResponseEnvelopeResultRulesSetCacheControlRuleActionParametersNoStoreRemoveDirectiveOperation = "remove" Link to this property
Link to this property CloudflareOnly boolOptional Whether the directive should only be applied to the Cloudflare CDN cache. Link to this property
Link to this property
Link to this property
NoTransform PhaseUpdateResponseEnvelopeResultRulesSetCacheControlRuleActionParametersNoTransformOptional A cache-control directive configuration. One of the following:
type PhaseUpdateResponseEnvelopeResultRulesSetCacheControlRuleActionParametersNoTransformSetDirective struct{…} Set the directive.
Operation PhaseUpdateResponseEnvelopeResultRulesSetCacheControlRuleActionParametersNoTransformSetDirectiveOperation The operation to perform on the cache-control directive. One of the following: const PhaseUpdateResponseEnvelopeResultRulesSetCacheControlRuleActionParametersNoTransformSetDirectiveOperationSet PhaseUpdateResponseEnvelopeResultRulesSetCacheControlRuleActionParametersNoTransformSetDirectiveOperation = "set" Link to this property const PhaseUpdateResponseEnvelopeResultRulesSetCacheControlRuleActionParametersNoTransformSetDirectiveOperationRemove PhaseUpdateResponseEnvelopeResultRulesSetCacheControlRuleActionParametersNoTransformSetDirectiveOperation = "remove" Link to this property
Link to this property CloudflareOnly boolOptional Whether the directive should only be applied to the Cloudflare CDN cache. Link to this property
Link to this property
type PhaseUpdateResponseEnvelopeResultRulesSetCacheControlRuleActionParametersNoTransformRemoveDirective struct{…} Remove the directive.
Operation PhaseUpdateResponseEnvelopeResultRulesSetCacheControlRuleActionParametersNoTransformRemoveDirectiveOperation The operation to perform on the cache-control directive. One of the following: const PhaseUpdateResponseEnvelopeResultRulesSetCacheControlRuleActionParametersNoTransformRemoveDirectiveOperationSet PhaseUpdateResponseEnvelopeResultRulesSetCacheControlRuleActionParametersNoTransformRemoveDirectiveOperation = "set" Link to this property const PhaseUpdateResponseEnvelopeResultRulesSetCacheControlRuleActionParametersNoTransformRemoveDirectiveOperationRemove PhaseUpdateResponseEnvelopeResultRulesSetCacheControlRuleActionParametersNoTransformRemoveDirectiveOperation = "remove" Link to this property
Link to this property CloudflareOnly boolOptional 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 PhaseUpdateResponseEnvelopeResultRulesSetCacheControlRuleActionParametersPrivateOptional A cache-control directive configuration that accepts optional qualifiers (header names). One of the following:
type PhaseUpdateResponseEnvelopeResultRulesSetCacheControlRuleActionParametersPrivateSetDirective struct{…} Set the directive with optional qualifiers.
Operation PhaseUpdateResponseEnvelopeResultRulesSetCacheControlRuleActionParametersPrivateSetDirectiveOperation The operation to perform on the cache-control directive. One of the following: const PhaseUpdateResponseEnvelopeResultRulesSetCacheControlRuleActionParametersPrivateSetDirectiveOperationSet PhaseUpdateResponseEnvelopeResultRulesSetCacheControlRuleActionParametersPrivateSetDirectiveOperation = "set" Link to this property const PhaseUpdateResponseEnvelopeResultRulesSetCacheControlRuleActionParametersPrivateSetDirectiveOperationRemove PhaseUpdateResponseEnvelopeResultRulesSetCacheControlRuleActionParametersPrivateSetDirectiveOperation = "remove" Link to this property
Link to this property CloudflareOnly boolOptional Whether the directive should only be applied to the Cloudflare CDN cache. Link to this property Qualifiers \[]stringOptional 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
type PhaseUpdateResponseEnvelopeResultRulesSetCacheControlRuleActionParametersPrivateRemoveDirective struct{…} Remove the directive.
Operation PhaseUpdateResponseEnvelopeResultRulesSetCacheControlRuleActionParametersPrivateRemoveDirectiveOperation The operation to perform on the cache-control directive. One of the following: const PhaseUpdateResponseEnvelopeResultRulesSetCacheControlRuleActionParametersPrivateRemoveDirectiveOperationSet PhaseUpdateResponseEnvelopeResultRulesSetCacheControlRuleActionParametersPrivateRemoveDirectiveOperation = "set" Link to this property const PhaseUpdateResponseEnvelopeResultRulesSetCacheControlRuleActionParametersPrivateRemoveDirectiveOperationRemove PhaseUpdateResponseEnvelopeResultRulesSetCacheControlRuleActionParametersPrivateRemoveDirectiveOperation = "remove" Link to this property
Link to this property CloudflareOnly boolOptional Whether the directive should only be applied to the Cloudflare CDN cache. Link to this property
Link to this property
Link to this property
ProxyRevalidate PhaseUpdateResponseEnvelopeResultRulesSetCacheControlRuleActionParametersProxyRevalidateOptional A cache-control directive configuration. One of the following:
type PhaseUpdateResponseEnvelopeResultRulesSetCacheControlRuleActionParametersProxyRevalidateSetDirective struct{…} Set the directive.
Operation PhaseUpdateResponseEnvelopeResultRulesSetCacheControlRuleActionParametersProxyRevalidateSetDirectiveOperation The operation to perform on the cache-control directive. One of the following: const PhaseUpdateResponseEnvelopeResultRulesSetCacheControlRuleActionParametersProxyRevalidateSetDirectiveOperationSet PhaseUpdateResponseEnvelopeResultRulesSetCacheControlRuleActionParametersProxyRevalidateSetDirectiveOperation = "set" Link to this property const PhaseUpdateResponseEnvelopeResultRulesSetCacheControlRuleActionParametersProxyRevalidateSetDirectiveOperationRemove PhaseUpdateResponseEnvelopeResultRulesSetCacheControlRuleActionParametersProxyRevalidateSetDirectiveOperation = "remove" Link to this property
Link to this property CloudflareOnly boolOptional Whether the directive should only be applied to the Cloudflare CDN cache. Link to this property
Link to this property
type PhaseUpdateResponseEnvelopeResultRulesSetCacheControlRuleActionParametersProxyRevalidateRemoveDirective struct{…} Remove the directive.
Operation PhaseUpdateResponseEnvelopeResultRulesSetCacheControlRuleActionParametersProxyRevalidateRemoveDirectiveOperation The operation to perform on the cache-control directive. One of the following: const PhaseUpdateResponseEnvelopeResultRulesSetCacheControlRuleActionParametersProxyRevalidateRemoveDirectiveOperationSet PhaseUpdateResponseEnvelopeResultRulesSetCacheControlRuleActionParametersProxyRevalidateRemoveDirectiveOperation = "set" Link to this property const PhaseUpdateResponseEnvelopeResultRulesSetCacheControlRuleActionParametersProxyRevalidateRemoveDirectiveOperationRemove PhaseUpdateResponseEnvelopeResultRulesSetCacheControlRuleActionParametersProxyRevalidateRemoveDirectiveOperation = "remove" Link to this property
Link to this property CloudflareOnly boolOptional 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 PhaseUpdateResponseEnvelopeResultRulesSetCacheControlRuleActionParametersPublicOptional A cache-control directive configuration. One of the following:
type PhaseUpdateResponseEnvelopeResultRulesSetCacheControlRuleActionParametersPublicSetDirective struct{…} Set the directive.
Operation PhaseUpdateResponseEnvelopeResultRulesSetCacheControlRuleActionParametersPublicSetDirectiveOperation The operation to perform on the cache-control directive. One of the following: const PhaseUpdateResponseEnvelopeResultRulesSetCacheControlRuleActionParametersPublicSetDirectiveOperationSet PhaseUpdateResponseEnvelopeResultRulesSetCacheControlRuleActionParametersPublicSetDirectiveOperation = "set" Link to this property const PhaseUpdateResponseEnvelopeResultRulesSetCacheControlRuleActionParametersPublicSetDirectiveOperationRemove PhaseUpdateResponseEnvelopeResultRulesSetCacheControlRuleActionParametersPublicSetDirectiveOperation = "remove" Link to this property
Link to this property CloudflareOnly boolOptional Whether the directive should only be applied to the Cloudflare CDN cache. Link to this property
Link to this property
type PhaseUpdateResponseEnvelopeResultRulesSetCacheControlRuleActionParametersPublicRemoveDirective struct{…} Remove the directive.
Operation PhaseUpdateResponseEnvelopeResultRulesSetCacheControlRuleActionParametersPublicRemoveDirectiveOperation The operation to perform on the cache-control directive. One of the following: const PhaseUpdateResponseEnvelopeResultRulesSetCacheControlRuleActionParametersPublicRemoveDirectiveOperationSet PhaseUpdateResponseEnvelopeResultRulesSetCacheControlRuleActionParametersPublicRemoveDirectiveOperation = "set" Link to this property const PhaseUpdateResponseEnvelopeResultRulesSetCacheControlRuleActionParametersPublicRemoveDirectiveOperationRemove PhaseUpdateResponseEnvelopeResultRulesSetCacheControlRuleActionParametersPublicRemoveDirectiveOperation = "remove" Link to this property
Link to this property CloudflareOnly boolOptional Whether the directive should only be applied to the Cloudflare CDN cache. Link to this property
Link to this property
Link to this property
SMaxage PhaseUpdateResponseEnvelopeResultRulesSetCacheControlRuleActionParametersSMaxageOptional A cache-control directive configuration that accepts a duration value in seconds. One of the following:
type PhaseUpdateResponseEnvelopeResultRulesSetCacheControlRuleActionParametersSMaxageSetDirective struct{…} Set the directive with a duration value in seconds.
Operation PhaseUpdateResponseEnvelopeResultRulesSetCacheControlRuleActionParametersSMaxageSetDirectiveOperation The operation to perform on the cache-control directive. One of the following: const PhaseUpdateResponseEnvelopeResultRulesSetCacheControlRuleActionParametersSMaxageSetDirectiveOperationSet PhaseUpdateResponseEnvelopeResultRulesSetCacheControlRuleActionParametersSMaxageSetDirectiveOperation = "set" Link to this property const PhaseUpdateResponseEnvelopeResultRulesSetCacheControlRuleActionParametersSMaxageSetDirectiveOperationRemove PhaseUpdateResponseEnvelopeResultRulesSetCacheControlRuleActionParametersSMaxageSetDirectiveOperation = "remove" Link to this property
Link to this property Value int64 The duration value in seconds for the directive. minimum0 Link to this property CloudflareOnly boolOptional Whether the directive should only be applied to the Cloudflare CDN cache. Link to this property
Link to this property
type PhaseUpdateResponseEnvelopeResultRulesSetCacheControlRuleActionParametersSMaxageRemoveDirective struct{…} Remove the directive.
Operation PhaseUpdateResponseEnvelopeResultRulesSetCacheControlRuleActionParametersSMaxageRemoveDirectiveOperation The operation to perform on the cache-control directive. One of the following: const PhaseUpdateResponseEnvelopeResultRulesSetCacheControlRuleActionParametersSMaxageRemoveDirectiveOperationSet PhaseUpdateResponseEnvelopeResultRulesSetCacheControlRuleActionParametersSMaxageRemoveDirectiveOperation = "set" Link to this property const PhaseUpdateResponseEnvelopeResultRulesSetCacheControlRuleActionParametersSMaxageRemoveDirectiveOperationRemove PhaseUpdateResponseEnvelopeResultRulesSetCacheControlRuleActionParametersSMaxageRemoveDirectiveOperation = "remove" Link to this property
Link to this property CloudflareOnly boolOptional Whether the directive should only be applied to the Cloudflare CDN cache. Link to this property
Link to this property
Link to this property
StaleIfError PhaseUpdateResponseEnvelopeResultRulesSetCacheControlRuleActionParametersStaleIfErrorOptional A cache-control directive configuration that accepts a duration value in seconds. One of the following:
type PhaseUpdateResponseEnvelopeResultRulesSetCacheControlRuleActionParametersStaleIfErrorSetDirective struct{…} Set the directive with a duration value in seconds.
Operation PhaseUpdateResponseEnvelopeResultRulesSetCacheControlRuleActionParametersStaleIfErrorSetDirectiveOperation The operation to perform on the cache-control directive. One of the following: const PhaseUpdateResponseEnvelopeResultRulesSetCacheControlRuleActionParametersStaleIfErrorSetDirectiveOperationSet PhaseUpdateResponseEnvelopeResultRulesSetCacheControlRuleActionParametersStaleIfErrorSetDirectiveOperation = "set" Link to this property const PhaseUpdateResponseEnvelopeResultRulesSetCacheControlRuleActionParametersStaleIfErrorSetDirectiveOperationRemove PhaseUpdateResponseEnvelopeResultRulesSetCacheControlRuleActionParametersStaleIfErrorSetDirectiveOperation = "remove" Link to this property
Link to this property Value int64 The duration value in seconds for the directive. minimum0 Link to this property CloudflareOnly boolOptional Whether the directive should only be applied to the Cloudflare CDN cache. Link to this property
Link to this property
type PhaseUpdateResponseEnvelopeResultRulesSetCacheControlRuleActionParametersStaleIfErrorRemoveDirective struct{…} Remove the directive.
Operation PhaseUpdateResponseEnvelopeResultRulesSetCacheControlRuleActionParametersStaleIfErrorRemoveDirectiveOperation The operation to perform on the cache-control directive. One of the following: const PhaseUpdateResponseEnvelopeResultRulesSetCacheControlRuleActionParametersStaleIfErrorRemoveDirectiveOperationSet PhaseUpdateResponseEnvelopeResultRulesSetCacheControlRuleActionParametersStaleIfErrorRemoveDirectiveOperation = "set" Link to this property const PhaseUpdateResponseEnvelopeResultRulesSetCacheControlRuleActionParametersStaleIfErrorRemoveDirectiveOperationRemove PhaseUpdateResponseEnvelopeResultRulesSetCacheControlRuleActionParametersStaleIfErrorRemoveDirectiveOperation = "remove" Link to this property
Link to this property CloudflareOnly boolOptional Whether the directive should only be applied to the Cloudflare CDN cache. Link to this property
Link to this property
Link to this property
StaleWhileRevalidate PhaseUpdateResponseEnvelopeResultRulesSetCacheControlRuleActionParametersStaleWhileRevalidateOptional A cache-control directive configuration that accepts a duration value in seconds. One of the following:
type PhaseUpdateResponseEnvelopeResultRulesSetCacheControlRuleActionParametersStaleWhileRevalidateSetDirective struct{…} Set the directive with a duration value in seconds.
Operation PhaseUpdateResponseEnvelopeResultRulesSetCacheControlRuleActionParametersStaleWhileRevalidateSetDirectiveOperation The operation to perform on the cache-control directive. One of the following: const PhaseUpdateResponseEnvelopeResultRulesSetCacheControlRuleActionParametersStaleWhileRevalidateSetDirectiveOperationSet PhaseUpdateResponseEnvelopeResultRulesSetCacheControlRuleActionParametersStaleWhileRevalidateSetDirectiveOperation = "set" Link to this property const PhaseUpdateResponseEnvelopeResultRulesSetCacheControlRuleActionParametersStaleWhileRevalidateSetDirectiveOperationRemove PhaseUpdateResponseEnvelopeResultRulesSetCacheControlRuleActionParametersStaleWhileRevalidateSetDirectiveOperation = "remove" Link to this property
Link to this property Value int64 The duration value in seconds for the directive. minimum0 Link to this property CloudflareOnly boolOptional Whether the directive should only be applied to the Cloudflare CDN cache. Link to this property
Link to this property
type PhaseUpdateResponseEnvelopeResultRulesSetCacheControlRuleActionParametersStaleWhileRevalidateRemoveDirective struct{…} Remove the directive.
Operation PhaseUpdateResponseEnvelopeResultRulesSetCacheControlRuleActionParametersStaleWhileRevalidateRemoveDirectiveOperation The operation to perform on the cache-control directive. One of the following: const PhaseUpdateResponseEnvelopeResultRulesSetCacheControlRuleActionParametersStaleWhileRevalidateRemoveDirectiveOperationSet PhaseUpdateResponseEnvelopeResultRulesSetCacheControlRuleActionParametersStaleWhileRevalidateRemoveDirectiveOperation = "set" Link to this property const PhaseUpdateResponseEnvelopeResultRulesSetCacheControlRuleActionParametersStaleWhileRevalidateRemoveDirectiveOperationRemove PhaseUpdateResponseEnvelopeResultRulesSetCacheControlRuleActionParametersStaleWhileRevalidateRemoveDirectiveOperation = "remove" Link to this property
Link to this property CloudflareOnly boolOptional 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 \[]stringOptional The categories of the rule. Link to this property Description stringOptional An informative description of the rule. Link to this property
ExposedCredentialCheck PhaseUpdateResponseEnvelopeResultRulesSetCacheControlRuleExposedCredentialCheckOptional Configuration for exposed credential checking. PasswordExpression string An expression that selects the password used in the credentials check. minLength1 Link to this property UsernameExpression string An expression that selects the user ID used in the credentials check. minLength1 Link to this property
Link to this property
Logging LoggingOptional An object configuring the rule’s logging behavior. Enabled bool Whether to generate a log when the rule matches. Link to this property
Link to this property
Ratelimit PhaseUpdateResponseEnvelopeResultRulesSetCacheControlRuleRatelimitOptional An object configuring the rule’s rate limit behavior. Characteristics \[]string Characteristics of the request on which the rate limit counter will be incremented. Link to this property Period int64 Period in seconds over which the counter is being incremented. minimum0 Link to this property CountingExpression stringOptional 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 MitigationTimeout int64Optional Period of time in seconds after which the action will be disabled following its first execution. Link to this property RequestsPerPeriod int64Optional The threshold of requests per period after which the action will be executed for the first time. minimum1 Link to this property RequestsToOrigin boolOptional Whether counting is only performed when an origin is reached. Link to this property ScorePerPeriod int64Optional The score threshold per period for which the action will be executed the first time. Link to this property ScoreResponseHeaderName stringOptional 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
type PhaseUpdateResponseEnvelopeResultRulesSetCacheSettingsRule struct{…} ID string Link to this property Action string Link to this property Enabled bool Link to this property Expression string Link to this property Ref string Link to this property
Link to this property
type PhaseUpdateResponseEnvelopeResultRulesSetCacheTagsRule struct{…} ID string The unique ID of the rule. Link to this property Action PhaseUpdateResponseEnvelopeResultRulesSetCacheTagsRuleAction The action to perform when the rule matches. Link to this property Enabled bool Link to this property Expression string The expression defining which traffic will match the rule. minLength1 Link to this property LastUpdated Time 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
ActionParameters PhaseUpdateResponseEnvelopeResultRulesSetCacheTagsRuleActionParametersOptional The parameters configuring the rule’s action. One of the following:
type PhaseUpdateResponseEnvelopeResultRulesSetCacheTagsRuleActionParametersAddCacheTagsValues struct{…} Add cache tags using a list of values.
Operation PhaseUpdateResponseEnvelopeResultRulesSetCacheTagsRuleActionParametersAddCacheTagsValuesOperation The operation to perform on the cache tags. One of the following: const PhaseUpdateResponseEnvelopeResultRulesSetCacheTagsRuleActionParametersAddCacheTagsValuesOperationAdd PhaseUpdateResponseEnvelopeResultRulesSetCacheTagsRuleActionParametersAddCacheTagsValuesOperation = "add" Link to this property const PhaseUpdateResponseEnvelopeResultRulesSetCacheTagsRuleActionParametersAddCacheTagsValuesOperationRemove PhaseUpdateResponseEnvelopeResultRulesSetCacheTagsRuleActionParametersAddCacheTagsValuesOperation = "remove" Link to this property const PhaseUpdateResponseEnvelopeResultRulesSetCacheTagsRuleActionParametersAddCacheTagsValuesOperationSet PhaseUpdateResponseEnvelopeResultRulesSetCacheTagsRuleActionParametersAddCacheTagsValuesOperation = "set" Link to this property
Link to this property Values \[]string A list of cache tag values. Link to this property
Link to this property
type PhaseUpdateResponseEnvelopeResultRulesSetCacheTagsRuleActionParametersAddCacheTagsExpression struct{…} 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 PhaseUpdateResponseEnvelopeResultRulesSetCacheTagsRuleActionParametersAddCacheTagsExpressionOperation The operation to perform on the cache tags. One of the following: const PhaseUpdateResponseEnvelopeResultRulesSetCacheTagsRuleActionParametersAddCacheTagsExpressionOperationAdd PhaseUpdateResponseEnvelopeResultRulesSetCacheTagsRuleActionParametersAddCacheTagsExpressionOperation = "add" Link to this property const PhaseUpdateResponseEnvelopeResultRulesSetCacheTagsRuleActionParametersAddCacheTagsExpressionOperationRemove PhaseUpdateResponseEnvelopeResultRulesSetCacheTagsRuleActionParametersAddCacheTagsExpressionOperation = "remove" Link to this property const PhaseUpdateResponseEnvelopeResultRulesSetCacheTagsRuleActionParametersAddCacheTagsExpressionOperationSet PhaseUpdateResponseEnvelopeResultRulesSetCacheTagsRuleActionParametersAddCacheTagsExpressionOperation = "set" Link to this property
Link to this property
Link to this property
type PhaseUpdateResponseEnvelopeResultRulesSetCacheTagsRuleActionParametersRemoveCacheTagsValues struct{…} Remove cache tags using a list of values.
Operation PhaseUpdateResponseEnvelopeResultRulesSetCacheTagsRuleActionParametersRemoveCacheTagsValuesOperation The operation to perform on the cache tags. One of the following: const PhaseUpdateResponseEnvelopeResultRulesSetCacheTagsRuleActionParametersRemoveCacheTagsValuesOperationAdd PhaseUpdateResponseEnvelopeResultRulesSetCacheTagsRuleActionParametersRemoveCacheTagsValuesOperation = "add" Link to this property const PhaseUpdateResponseEnvelopeResultRulesSetCacheTagsRuleActionParametersRemoveCacheTagsValuesOperationRemove PhaseUpdateResponseEnvelopeResultRulesSetCacheTagsRuleActionParametersRemoveCacheTagsValuesOperation = "remove" Link to this property const PhaseUpdateResponseEnvelopeResultRulesSetCacheTagsRuleActionParametersRemoveCacheTagsValuesOperationSet PhaseUpdateResponseEnvelopeResultRulesSetCacheTagsRuleActionParametersRemoveCacheTagsValuesOperation = "set" Link to this property
Link to this property Values \[]string A list of cache tag values. Link to this property
Link to this property
type PhaseUpdateResponseEnvelopeResultRulesSetCacheTagsRuleActionParametersRemoveCacheTagsExpression struct{…} 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 PhaseUpdateResponseEnvelopeResultRulesSetCacheTagsRuleActionParametersRemoveCacheTagsExpressionOperation The operation to perform on the cache tags. One of the following: const PhaseUpdateResponseEnvelopeResultRulesSetCacheTagsRuleActionParametersRemoveCacheTagsExpressionOperationAdd PhaseUpdateResponseEnvelopeResultRulesSetCacheTagsRuleActionParametersRemoveCacheTagsExpressionOperation = "add" Link to this property const PhaseUpdateResponseEnvelopeResultRulesSetCacheTagsRuleActionParametersRemoveCacheTagsExpressionOperationRemove PhaseUpdateResponseEnvelopeResultRulesSetCacheTagsRuleActionParametersRemoveCacheTagsExpressionOperation = "remove" Link to this property const PhaseUpdateResponseEnvelopeResultRulesSetCacheTagsRuleActionParametersRemoveCacheTagsExpressionOperationSet PhaseUpdateResponseEnvelopeResultRulesSetCacheTagsRuleActionParametersRemoveCacheTagsExpressionOperation = "set" Link to this property
Link to this property
Link to this property
type PhaseUpdateResponseEnvelopeResultRulesSetCacheTagsRuleActionParametersSetCacheTagsValues struct{…} Set cache tags using a list of values.
Operation PhaseUpdateResponseEnvelopeResultRulesSetCacheTagsRuleActionParametersSetCacheTagsValuesOperation The operation to perform on the cache tags. One of the following: const PhaseUpdateResponseEnvelopeResultRulesSetCacheTagsRuleActionParametersSetCacheTagsValuesOperationAdd PhaseUpdateResponseEnvelopeResultRulesSetCacheTagsRuleActionParametersSetCacheTagsValuesOperation = "add" Link to this property const PhaseUpdateResponseEnvelopeResultRulesSetCacheTagsRuleActionParametersSetCacheTagsValuesOperationRemove PhaseUpdateResponseEnvelopeResultRulesSetCacheTagsRuleActionParametersSetCacheTagsValuesOperation = "remove" Link to this property const PhaseUpdateResponseEnvelopeResultRulesSetCacheTagsRuleActionParametersSetCacheTagsValuesOperationSet PhaseUpdateResponseEnvelopeResultRulesSetCacheTagsRuleActionParametersSetCacheTagsValuesOperation = "set" Link to this property
Link to this property Values \[]string A list of cache tag values. Link to this property
Link to this property
type PhaseUpdateResponseEnvelopeResultRulesSetCacheTagsRuleActionParametersSetCacheTagsExpression struct{…} 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 PhaseUpdateResponseEnvelopeResultRulesSetCacheTagsRuleActionParametersSetCacheTagsExpressionOperation The operation to perform on the cache tags. One of the following: const PhaseUpdateResponseEnvelopeResultRulesSetCacheTagsRuleActionParametersSetCacheTagsExpressionOperationAdd PhaseUpdateResponseEnvelopeResultRulesSetCacheTagsRuleActionParametersSetCacheTagsExpressionOperation = "add" Link to this property const PhaseUpdateResponseEnvelopeResultRulesSetCacheTagsRuleActionParametersSetCacheTagsExpressionOperationRemove PhaseUpdateResponseEnvelopeResultRulesSetCacheTagsRuleActionParametersSetCacheTagsExpressionOperation = "remove" Link to this property const PhaseUpdateResponseEnvelopeResultRulesSetCacheTagsRuleActionParametersSetCacheTagsExpressionOperationSet PhaseUpdateResponseEnvelopeResultRulesSetCacheTagsRuleActionParametersSetCacheTagsExpressionOperation = "set" Link to this property
Link to this property
Link to this property
Link to this property Categories \[]stringOptional The categories of the rule. Link to this property Description stringOptional An informative description of the rule. Link to this property
ExposedCredentialCheck PhaseUpdateResponseEnvelopeResultRulesSetCacheTagsRuleExposedCredentialCheckOptional Configuration for exposed credential checking. PasswordExpression string An expression that selects the password used in the credentials check. minLength1 Link to this property UsernameExpression string An expression that selects the user ID used in the credentials check. minLength1 Link to this property
Link to this property
Logging LoggingOptional An object configuring the rule’s logging behavior. Enabled bool Whether to generate a log when the rule matches. Link to this property
Link to this property
Ratelimit PhaseUpdateResponseEnvelopeResultRulesSetCacheTagsRuleRatelimitOptional An object configuring the rule’s rate limit behavior. Characteristics \[]string Characteristics of the request on which the rate limit counter will be incremented. Link to this property Period int64 Period in seconds over which the counter is being incremented. minimum0 Link to this property CountingExpression stringOptional 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 MitigationTimeout int64Optional Period of time in seconds after which the action will be disabled following its first execution. Link to this property RequestsPerPeriod int64Optional The threshold of requests per period after which the action will be executed for the first time. minimum1 Link to this property RequestsToOrigin boolOptional Whether counting is only performed when an origin is reached. Link to this property ScorePerPeriod int64Optional The score threshold per period for which the action will be executed the first time. Link to this property ScoreResponseHeaderName stringOptional 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
type PhaseUpdateResponseEnvelopeResultRulesSetConfigurationRule struct{…} ID string Link to this property Action string Link to this property Enabled bool Link to this property Expression string Link to this property Ref string Link to this property
Link to this property
type PhaseUpdateResponseEnvelopeResultRulesSkipRule struct{…} ID string Link to this property Action string Link to this property Enabled bool Link to this property Expression string Link to this property Ref string Link to this property
Link to this property
type PhaseUpdateResponseEnvelopeResultRulesTransformResponseHTMLRule struct{…} ID string The unique ID of the rule. Link to this property Action PhaseUpdateResponseEnvelopeResultRulesTransformResponseHTMLRuleAction The action to perform when the rule matches. Link to this property Enabled bool Link to this property Expression string The expression defining which traffic will match the rule. minLength1 Link to this property LastUpdated Time 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
ActionParameters PhaseUpdateResponseEnvelopeResultRulesTransformResponseHTMLRuleActionParametersOptional The parameters configuring the rule’s action. LinkMaze unknown Enables the link maze transformation on the response. Link to this property
Link to this property Categories \[]stringOptional The categories of the rule. Link to this property Description stringOptional An informative description of the rule. Link to this property
ExposedCredentialCheck PhaseUpdateResponseEnvelopeResultRulesTransformResponseHTMLRuleExposedCredentialCheckOptional Configuration for exposed credential checking. PasswordExpression string An expression that selects the password used in the credentials check. minLength1 Link to this property UsernameExpression string An expression that selects the user ID used in the credentials check. minLength1 Link to this property
Link to this property
Logging LoggingOptional An object configuring the rule’s logging behavior. Enabled bool Whether to generate a log when the rule matches. Link to this property
Link to this property
Ratelimit PhaseUpdateResponseEnvelopeResultRulesTransformResponseHTMLRuleRatelimitOptional An object configuring the rule’s rate limit behavior. Characteristics \[]string Characteristics of the request on which the rate limit counter will be incremented. Link to this property Period int64 Period in seconds over which the counter is being incremented. minimum0 Link to this property CountingExpression stringOptional 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 MitigationTimeout int64Optional Period of time in seconds after which the action will be disabled following its first execution. Link to this property RequestsPerPeriod int64Optional The threshold of requests per period after which the action will be executed for the first time. minimum1 Link to this property RequestsToOrigin boolOptional Whether counting is only performed when an origin is reached. Link to this property ScorePerPeriod int64Optional The score threshold per period for which the action will be executed the first time. Link to this property ScoreResponseHeaderName stringOptional 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 stringOptional An informative description of the ruleset. Link to this property
Link to this property
[Link to this property](<#(resource)%20rulesets.phases%20%3E%20(method)%20update%20%3E%20(network%20schema)%20%3E%20(property)%20result>) ### Update an account or zone entry point ruleset Go HTTPTypeScriptPythonGoTerraform ``` package main import ( "context" "fmt" "github.com/cloudflare/cloudflare-go" "github.com/cloudflare/cloudflare-go/option" "github.com/cloudflare/cloudflare-go/rulesets" ) func main() { client := cloudflare.NewClient( option.WithAPIToken("Sn3lZJTBX6kkg7OdcBUAxOO963GEIyGQqnFTOFYY"), ) phase, err := client.Rulesets.Phases.Update( context.TODO(), rulesets.PhaseHTTPRequestFirewallCustom, rulesets.PhaseUpdateParams{ }, ) if err != nil { panic(err.Error()) } fmt.Printf("%+v\n", phase) } ``` 200 example ``` { "errors": [ { "message": "something bad happened", "code": 10000, "source": { "pointer": "/rules/0/action" } } ], "messages": [ { "message": "something bad happened", "code": 10000, "source": { "pointer": "/rules/0/action" } } ], "result": { "id": "2f2feab2026849078ba485f918791bdc", "kind": "root", "last_updated": "2000-01-01T00:00:00Z", "name": "My ruleset", "phase": "http_request_firewall_custom", "rules": [ { "last_updated": "2000-01-01T00:00:00Z", "version": "1", "id": "id", "action": "action", "action_parameters": { "response": { "content": "{\n \"success\": false,\n \"error\": \"you have been blocked\"\n}", "content_type": "application/json", "status_code": 400 } }, "categories": [ "directory-traversal" ], "description": "Block the request.", "enabled": true, "exposed_credential_check": { "password_expression": "url_decode(http.request.body.form[\\\"password\\\"][0])", "username_expression": "url_decode(http.request.body.form[\\\"username\\\"][0])" }, "expression": "expression", "logging": { "enabled": true }, "ratelimit": { "characteristics": [ "cf.colo.id" ], "period": 60, "counting_expression": "http.request.body.raw eq \"abcd\"", "mitigation_timeout": 600, "requests_per_period": 1000, "requests_to_origin": true, "score_per_period": 400, "score_response_header_name": "my-score" }, "ref": "ref" } ], "version": "1", "description": "A description for my ruleset." }, "success": true } ``` ##### Returns Examples 200 example ``` { "errors": [ { "message": "something bad happened", "code": 10000, "source": { "pointer": "/rules/0/action" } } ], "messages": [ { "message": "something bad happened", "code": 10000, "source": { "pointer": "/rules/0/action" } } ], "result": { "id": "2f2feab2026849078ba485f918791bdc", "kind": "root", "last_updated": "2000-01-01T00:00:00Z", "name": "My ruleset", "phase": "http_request_firewall_custom", "rules": [ { "last_updated": "2000-01-01T00:00:00Z", "version": "1", "id": "id", "action": "action", "action_parameters": { "response": { "content": "{\n \"success\": false,\n \"error\": \"you have been blocked\"\n}", "content_type": "application/json", "status_code": 400 } }, "categories": [ "directory-traversal" ], "description": "Block the request.", "enabled": true, "exposed_credential_check": { "password_expression": "url_decode(http.request.body.form[\\\"password\\\"][0])", "username_expression": "url_decode(http.request.body.form[\\\"username\\\"][0])" }, "expression": "expression", "logging": { "enabled": true }, "ratelimit": { "characteristics": [ "cf.colo.id" ], "period": 60, "counting_expression": "http.request.body.raw eq \"abcd\"", "mitigation_timeout": 600, "requests_per_period": 1000, "requests_to_origin": true, "score_per_period": 400, "score_response_header_name": "my-score" }, "ref": "ref" } ], "version": "1", "description": "A description for my ruleset." }, "success": true } ```