--- title: Create an account or zone ruleset --- [Skip to content](#_top) [API Reference](https://developers.cloudflare.com/api/go) [Rulesets](https://developers.cloudflare.com/api/go/resources/rulesets) Copy Markdown Open in **Claude**Open in **ChatGPT**Open in **Cursor** --- **Copy Markdown****View as Markdown** # Create an account or zone ruleset client.Rulesets.New(ctx, params) (\*RulesetNewResponseEnvelopeResult, error) POST/{accounts\_or\_zones}/{account\_or\_zone\_id}/rulesets Creates a ruleset. ##### Security

API Token

The preferred authorization scheme for interacting with the Cloudflare API. Create a token. **Example:**Authorization: Bearer Sn3lZJTBX6kkg7OdcBUAxOO963GEIyGQqnFTOFYY

API Email + API Key

The previous authorization scheme for interacting with the Cloudflare API, used in conjunction with a Global API key. **Example:**X-Auth-Email: user@example.com The previous authorization scheme for interacting with the Cloudflare API. When possible, use API tokens instead of Global API keys. **Example:**X-Auth-Key: 144c9defac04969c7bfad8efaa8ea194

##### Accepted Permissions (at least one required) `Mass URL Redirects Write``Magic Firewall Write``L4 DDoS Managed Ruleset Write``Transform Rules Write``Select Configuration Write``Account WAF Write``Account Rulesets Write``Logs Write` ##### ParametersExpand Collapse

params RulesetNewParams

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 Kind param.Field\[Kind]Optional Body param: The kind 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 Phase param.Field\[Phase]Optional Body param: The phase of the ruleset. Link to this property

Rules param.Field\[\[]RulesetNewParamsRule]Optional Body param: The list of rules in the ruleset.

type BlockRuleParam struct{…}

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 RulesetNewParamsRulesRulesetsChallengeRule 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 RulesetNewParamsRulesRulesetsChallengeRuleActionOptional 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 RulesetNewParamsRulesRulesetsChallengeRuleExposedCredentialCheckOptional Configuration for exposed credential checking.

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 RulesetNewParamsRulesRulesetsChallengeRuleRatelimitOptional An object configuring the rule’s rate limit behavior.

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{…}

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

ExposedCredentialCheck CompressResponseRuleExposedCredentialCheckOptional Configuration for exposed credential checking.

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.

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.

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.

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{…}

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

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

ExposedCredentialCheck ExecuteRuleExposedCredentialCheckOptional Configuration for exposed credential checking.

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.

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.

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.

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 RulesetNewParamsRulesRulesetsJSChallengeRule 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 RulesetNewParamsRulesRulesetsJSChallengeRuleActionOptional 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 RulesetNewParamsRulesRulesetsJSChallengeRuleExposedCredentialCheckOptional Configuration for exposed credential checking.

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 RulesetNewParamsRulesRulesetsJSChallengeRuleRatelimitOptional An object configuring the rule’s rate limit behavior.

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.

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.

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{…}

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

ExposedCredentialCheck LogCustomFieldRuleExposedCredentialCheckOptional Configuration for exposed credential checking.

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.

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.

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.

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{…}

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

ExposedCredentialCheck RedirectRuleExposedCredentialCheckOptional Configuration for exposed credential checking.

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.

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{…}

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

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

ExposedCredentialCheck RewriteRuleExposedCredentialCheckOptional Configuration for exposed credential checking.

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.

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{…}

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

ExposedCredentialCheck RouteRuleExposedCredentialCheckOptional Configuration for exposed credential checking.

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.

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{…}

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

ExposedCredentialCheck ScoreRuleExposedCredentialCheckOptional Configuration for exposed credential checking.

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.

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{…}

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

ExposedCredentialCheck ServeErrorRuleExposedCredentialCheckOptional Configuration for exposed credential checking.

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.

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 RulesetNewParamsRulesRulesetsSetCacheControlRule struct{…}

ActionParameters RulesetNewParamsRulesRulesetsSetCacheControlRuleActionParametersOptional The parameters configuring the rule’s action.

Immutable RulesetNewParamsRulesRulesetsSetCacheControlRuleActionParametersImmutableOptional A cache-control directive configuration.

One of the following:

type RulesetNewParamsRulesRulesetsSetCacheControlRuleActionParametersImmutableSetDirective struct{…} Set the directive.

Operation RulesetNewParamsRulesRulesetsSetCacheControlRuleActionParametersImmutableSetDirectiveOperation The operation to perform on the cache-control directive.

One of the following: const RulesetNewParamsRulesRulesetsSetCacheControlRuleActionParametersImmutableSetDirectiveOperationSet RulesetNewParamsRulesRulesetsSetCacheControlRuleActionParametersImmutableSetDirectiveOperation = "set" Link to this property const RulesetNewParamsRulesRulesetsSetCacheControlRuleActionParametersImmutableSetDirectiveOperationRemove RulesetNewParamsRulesRulesetsSetCacheControlRuleActionParametersImmutableSetDirectiveOperation = "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 RulesetNewParamsRulesRulesetsSetCacheControlRuleActionParametersImmutableRemoveDirective struct{…} Remove the directive.

Operation RulesetNewParamsRulesRulesetsSetCacheControlRuleActionParametersImmutableRemoveDirectiveOperation The operation to perform on the cache-control directive.

One of the following: const RulesetNewParamsRulesRulesetsSetCacheControlRuleActionParametersImmutableRemoveDirectiveOperationSet RulesetNewParamsRulesRulesetsSetCacheControlRuleActionParametersImmutableRemoveDirectiveOperation = "set" Link to this property const RulesetNewParamsRulesRulesetsSetCacheControlRuleActionParametersImmutableRemoveDirectiveOperationRemove RulesetNewParamsRulesRulesetsSetCacheControlRuleActionParametersImmutableRemoveDirectiveOperation = "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

MaxAge RulesetNewParamsRulesRulesetsSetCacheControlRuleActionParametersMaxAgeOptional A cache-control directive configuration that accepts a duration value in seconds.

One of the following:

type RulesetNewParamsRulesRulesetsSetCacheControlRuleActionParametersMaxAgeSetDirective struct{…} Set the directive with a duration value in seconds.

Operation RulesetNewParamsRulesRulesetsSetCacheControlRuleActionParametersMaxAgeSetDirectiveOperation The operation to perform on the cache-control directive.

One of the following: const RulesetNewParamsRulesRulesetsSetCacheControlRuleActionParametersMaxAgeSetDirectiveOperationSet RulesetNewParamsRulesRulesetsSetCacheControlRuleActionParametersMaxAgeSetDirectiveOperation = "set" Link to this property const RulesetNewParamsRulesRulesetsSetCacheControlRuleActionParametersMaxAgeSetDirectiveOperationRemove RulesetNewParamsRulesRulesetsSetCacheControlRuleActionParametersMaxAgeSetDirectiveOperation = "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 RulesetNewParamsRulesRulesetsSetCacheControlRuleActionParametersMaxAgeRemoveDirective struct{…} Remove the directive.

Operation RulesetNewParamsRulesRulesetsSetCacheControlRuleActionParametersMaxAgeRemoveDirectiveOperation The operation to perform on the cache-control directive.

One of the following: const RulesetNewParamsRulesRulesetsSetCacheControlRuleActionParametersMaxAgeRemoveDirectiveOperationSet RulesetNewParamsRulesRulesetsSetCacheControlRuleActionParametersMaxAgeRemoveDirectiveOperation = "set" Link to this property const RulesetNewParamsRulesRulesetsSetCacheControlRuleActionParametersMaxAgeRemoveDirectiveOperationRemove RulesetNewParamsRulesRulesetsSetCacheControlRuleActionParametersMaxAgeRemoveDirectiveOperation = "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

MustRevalidate RulesetNewParamsRulesRulesetsSetCacheControlRuleActionParametersMustRevalidateOptional A cache-control directive configuration.

One of the following:

type RulesetNewParamsRulesRulesetsSetCacheControlRuleActionParametersMustRevalidateSetDirective struct{…} Set the directive.

Operation RulesetNewParamsRulesRulesetsSetCacheControlRuleActionParametersMustRevalidateSetDirectiveOperation The operation to perform on the cache-control directive.

One of the following: const RulesetNewParamsRulesRulesetsSetCacheControlRuleActionParametersMustRevalidateSetDirectiveOperationSet RulesetNewParamsRulesRulesetsSetCacheControlRuleActionParametersMustRevalidateSetDirectiveOperation = "set" Link to this property const RulesetNewParamsRulesRulesetsSetCacheControlRuleActionParametersMustRevalidateSetDirectiveOperationRemove RulesetNewParamsRulesRulesetsSetCacheControlRuleActionParametersMustRevalidateSetDirectiveOperation = "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 RulesetNewParamsRulesRulesetsSetCacheControlRuleActionParametersMustRevalidateRemoveDirective struct{…} Remove the directive.

Operation RulesetNewParamsRulesRulesetsSetCacheControlRuleActionParametersMustRevalidateRemoveDirectiveOperation The operation to perform on the cache-control directive.

One of the following: const RulesetNewParamsRulesRulesetsSetCacheControlRuleActionParametersMustRevalidateRemoveDirectiveOperationSet RulesetNewParamsRulesRulesetsSetCacheControlRuleActionParametersMustRevalidateRemoveDirectiveOperation = "set" Link to this property const RulesetNewParamsRulesRulesetsSetCacheControlRuleActionParametersMustRevalidateRemoveDirectiveOperationRemove RulesetNewParamsRulesRulesetsSetCacheControlRuleActionParametersMustRevalidateRemoveDirectiveOperation = "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

MustUnderstand RulesetNewParamsRulesRulesetsSetCacheControlRuleActionParametersMustUnderstandOptional A cache-control directive configuration.

One of the following:

type RulesetNewParamsRulesRulesetsSetCacheControlRuleActionParametersMustUnderstandSetDirective struct{…} Set the directive.

Operation RulesetNewParamsRulesRulesetsSetCacheControlRuleActionParametersMustUnderstandSetDirectiveOperation The operation to perform on the cache-control directive.

One of the following: const RulesetNewParamsRulesRulesetsSetCacheControlRuleActionParametersMustUnderstandSetDirectiveOperationSet RulesetNewParamsRulesRulesetsSetCacheControlRuleActionParametersMustUnderstandSetDirectiveOperation = "set" Link to this property const RulesetNewParamsRulesRulesetsSetCacheControlRuleActionParametersMustUnderstandSetDirectiveOperationRemove RulesetNewParamsRulesRulesetsSetCacheControlRuleActionParametersMustUnderstandSetDirectiveOperation = "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 RulesetNewParamsRulesRulesetsSetCacheControlRuleActionParametersMustUnderstandRemoveDirective struct{…} Remove the directive.

Operation RulesetNewParamsRulesRulesetsSetCacheControlRuleActionParametersMustUnderstandRemoveDirectiveOperation The operation to perform on the cache-control directive.

One of the following: const RulesetNewParamsRulesRulesetsSetCacheControlRuleActionParametersMustUnderstandRemoveDirectiveOperationSet RulesetNewParamsRulesRulesetsSetCacheControlRuleActionParametersMustUnderstandRemoveDirectiveOperation = "set" Link to this property const RulesetNewParamsRulesRulesetsSetCacheControlRuleActionParametersMustUnderstandRemoveDirectiveOperationRemove RulesetNewParamsRulesRulesetsSetCacheControlRuleActionParametersMustUnderstandRemoveDirectiveOperation = "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

NoCache RulesetNewParamsRulesRulesetsSetCacheControlRuleActionParametersNoCacheOptional A cache-control directive configuration that accepts optional qualifiers (header names).

One of the following:

type RulesetNewParamsRulesRulesetsSetCacheControlRuleActionParametersNoCacheSetDirective struct{…} Set the directive with optional qualifiers.

Operation RulesetNewParamsRulesRulesetsSetCacheControlRuleActionParametersNoCacheSetDirectiveOperation The operation to perform on the cache-control directive.

One of the following: const RulesetNewParamsRulesRulesetsSetCacheControlRuleActionParametersNoCacheSetDirectiveOperationSet RulesetNewParamsRulesRulesetsSetCacheControlRuleActionParametersNoCacheSetDirectiveOperation = "set" Link to this property const RulesetNewParamsRulesRulesetsSetCacheControlRuleActionParametersNoCacheSetDirectiveOperationRemove RulesetNewParamsRulesRulesetsSetCacheControlRuleActionParametersNoCacheSetDirectiveOperation = "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 RulesetNewParamsRulesRulesetsSetCacheControlRuleActionParametersNoCacheRemoveDirective struct{…} Remove the directive.

Operation RulesetNewParamsRulesRulesetsSetCacheControlRuleActionParametersNoCacheRemoveDirectiveOperation The operation to perform on the cache-control directive.

One of the following: const RulesetNewParamsRulesRulesetsSetCacheControlRuleActionParametersNoCacheRemoveDirectiveOperationSet RulesetNewParamsRulesRulesetsSetCacheControlRuleActionParametersNoCacheRemoveDirectiveOperation = "set" Link to this property const RulesetNewParamsRulesRulesetsSetCacheControlRuleActionParametersNoCacheRemoveDirectiveOperationRemove RulesetNewParamsRulesRulesetsSetCacheControlRuleActionParametersNoCacheRemoveDirectiveOperation = "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

NoStore RulesetNewParamsRulesRulesetsSetCacheControlRuleActionParametersNoStoreOptional A cache-control directive configuration.

One of the following:

type RulesetNewParamsRulesRulesetsSetCacheControlRuleActionParametersNoStoreSetDirective struct{…} Set the directive.

Operation RulesetNewParamsRulesRulesetsSetCacheControlRuleActionParametersNoStoreSetDirectiveOperation The operation to perform on the cache-control directive.

One of the following: const RulesetNewParamsRulesRulesetsSetCacheControlRuleActionParametersNoStoreSetDirectiveOperationSet RulesetNewParamsRulesRulesetsSetCacheControlRuleActionParametersNoStoreSetDirectiveOperation = "set" Link to this property const RulesetNewParamsRulesRulesetsSetCacheControlRuleActionParametersNoStoreSetDirectiveOperationRemove RulesetNewParamsRulesRulesetsSetCacheControlRuleActionParametersNoStoreSetDirectiveOperation = "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 RulesetNewParamsRulesRulesetsSetCacheControlRuleActionParametersNoStoreRemoveDirective struct{…} Remove the directive.

Operation RulesetNewParamsRulesRulesetsSetCacheControlRuleActionParametersNoStoreRemoveDirectiveOperation The operation to perform on the cache-control directive.

One of the following: const RulesetNewParamsRulesRulesetsSetCacheControlRuleActionParametersNoStoreRemoveDirectiveOperationSet RulesetNewParamsRulesRulesetsSetCacheControlRuleActionParametersNoStoreRemoveDirectiveOperation = "set" Link to this property const RulesetNewParamsRulesRulesetsSetCacheControlRuleActionParametersNoStoreRemoveDirectiveOperationRemove RulesetNewParamsRulesRulesetsSetCacheControlRuleActionParametersNoStoreRemoveDirectiveOperation = "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

NoTransform RulesetNewParamsRulesRulesetsSetCacheControlRuleActionParametersNoTransformOptional A cache-control directive configuration.

One of the following:

type RulesetNewParamsRulesRulesetsSetCacheControlRuleActionParametersNoTransformSetDirective struct{…} Set the directive.

Operation RulesetNewParamsRulesRulesetsSetCacheControlRuleActionParametersNoTransformSetDirectiveOperation The operation to perform on the cache-control directive.

One of the following: const RulesetNewParamsRulesRulesetsSetCacheControlRuleActionParametersNoTransformSetDirectiveOperationSet RulesetNewParamsRulesRulesetsSetCacheControlRuleActionParametersNoTransformSetDirectiveOperation = "set" Link to this property const RulesetNewParamsRulesRulesetsSetCacheControlRuleActionParametersNoTransformSetDirectiveOperationRemove RulesetNewParamsRulesRulesetsSetCacheControlRuleActionParametersNoTransformSetDirectiveOperation = "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 RulesetNewParamsRulesRulesetsSetCacheControlRuleActionParametersNoTransformRemoveDirective struct{…} Remove the directive.

Operation RulesetNewParamsRulesRulesetsSetCacheControlRuleActionParametersNoTransformRemoveDirectiveOperation The operation to perform on the cache-control directive.

One of the following: const RulesetNewParamsRulesRulesetsSetCacheControlRuleActionParametersNoTransformRemoveDirectiveOperationSet RulesetNewParamsRulesRulesetsSetCacheControlRuleActionParametersNoTransformRemoveDirectiveOperation = "set" Link to this property const RulesetNewParamsRulesRulesetsSetCacheControlRuleActionParametersNoTransformRemoveDirectiveOperationRemove RulesetNewParamsRulesRulesetsSetCacheControlRuleActionParametersNoTransformRemoveDirectiveOperation = "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

Private RulesetNewParamsRulesRulesetsSetCacheControlRuleActionParametersPrivateOptional A cache-control directive configuration that accepts optional qualifiers (header names).

One of the following:

type RulesetNewParamsRulesRulesetsSetCacheControlRuleActionParametersPrivateSetDirective struct{…} Set the directive with optional qualifiers.

Operation RulesetNewParamsRulesRulesetsSetCacheControlRuleActionParametersPrivateSetDirectiveOperation The operation to perform on the cache-control directive.

One of the following: const RulesetNewParamsRulesRulesetsSetCacheControlRuleActionParametersPrivateSetDirectiveOperationSet RulesetNewParamsRulesRulesetsSetCacheControlRuleActionParametersPrivateSetDirectiveOperation = "set" Link to this property const RulesetNewParamsRulesRulesetsSetCacheControlRuleActionParametersPrivateSetDirectiveOperationRemove RulesetNewParamsRulesRulesetsSetCacheControlRuleActionParametersPrivateSetDirectiveOperation = "remove" Link to this property

Link to this property

type RulesetNewParamsRulesRulesetsSetCacheControlRuleActionParametersPrivateRemoveDirective struct{…} Remove the directive.

Operation RulesetNewParamsRulesRulesetsSetCacheControlRuleActionParametersPrivateRemoveDirectiveOperation The operation to perform on the cache-control directive.

One of the following: const RulesetNewParamsRulesRulesetsSetCacheControlRuleActionParametersPrivateRemoveDirectiveOperationSet RulesetNewParamsRulesRulesetsSetCacheControlRuleActionParametersPrivateRemoveDirectiveOperation = "set" Link to this property const RulesetNewParamsRulesRulesetsSetCacheControlRuleActionParametersPrivateRemoveDirectiveOperationRemove RulesetNewParamsRulesRulesetsSetCacheControlRuleActionParametersPrivateRemoveDirectiveOperation = "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

ProxyRevalidate RulesetNewParamsRulesRulesetsSetCacheControlRuleActionParametersProxyRevalidateOptional A cache-control directive configuration.

One of the following:

type RulesetNewParamsRulesRulesetsSetCacheControlRuleActionParametersProxyRevalidateSetDirective struct{…} Set the directive.

Operation RulesetNewParamsRulesRulesetsSetCacheControlRuleActionParametersProxyRevalidateSetDirectiveOperation The operation to perform on the cache-control directive.

One of the following: const RulesetNewParamsRulesRulesetsSetCacheControlRuleActionParametersProxyRevalidateSetDirectiveOperationSet RulesetNewParamsRulesRulesetsSetCacheControlRuleActionParametersProxyRevalidateSetDirectiveOperation = "set" Link to this property const RulesetNewParamsRulesRulesetsSetCacheControlRuleActionParametersProxyRevalidateSetDirectiveOperationRemove RulesetNewParamsRulesRulesetsSetCacheControlRuleActionParametersProxyRevalidateSetDirectiveOperation = "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 RulesetNewParamsRulesRulesetsSetCacheControlRuleActionParametersProxyRevalidateRemoveDirective struct{…} Remove the directive.

Operation RulesetNewParamsRulesRulesetsSetCacheControlRuleActionParametersProxyRevalidateRemoveDirectiveOperation The operation to perform on the cache-control directive.

One of the following: const RulesetNewParamsRulesRulesetsSetCacheControlRuleActionParametersProxyRevalidateRemoveDirectiveOperationSet RulesetNewParamsRulesRulesetsSetCacheControlRuleActionParametersProxyRevalidateRemoveDirectiveOperation = "set" Link to this property const RulesetNewParamsRulesRulesetsSetCacheControlRuleActionParametersProxyRevalidateRemoveDirectiveOperationRemove RulesetNewParamsRulesRulesetsSetCacheControlRuleActionParametersProxyRevalidateRemoveDirectiveOperation = "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

Public RulesetNewParamsRulesRulesetsSetCacheControlRuleActionParametersPublicOptional A cache-control directive configuration.

One of the following:

type RulesetNewParamsRulesRulesetsSetCacheControlRuleActionParametersPublicSetDirective struct{…} Set the directive.

Operation RulesetNewParamsRulesRulesetsSetCacheControlRuleActionParametersPublicSetDirectiveOperation The operation to perform on the cache-control directive.

One of the following: const RulesetNewParamsRulesRulesetsSetCacheControlRuleActionParametersPublicSetDirectiveOperationSet RulesetNewParamsRulesRulesetsSetCacheControlRuleActionParametersPublicSetDirectiveOperation = "set" Link to this property const RulesetNewParamsRulesRulesetsSetCacheControlRuleActionParametersPublicSetDirectiveOperationRemove RulesetNewParamsRulesRulesetsSetCacheControlRuleActionParametersPublicSetDirectiveOperation = "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 RulesetNewParamsRulesRulesetsSetCacheControlRuleActionParametersPublicRemoveDirective struct{…} Remove the directive.

Operation RulesetNewParamsRulesRulesetsSetCacheControlRuleActionParametersPublicRemoveDirectiveOperation The operation to perform on the cache-control directive.

One of the following: const RulesetNewParamsRulesRulesetsSetCacheControlRuleActionParametersPublicRemoveDirectiveOperationSet RulesetNewParamsRulesRulesetsSetCacheControlRuleActionParametersPublicRemoveDirectiveOperation = "set" Link to this property const RulesetNewParamsRulesRulesetsSetCacheControlRuleActionParametersPublicRemoveDirectiveOperationRemove RulesetNewParamsRulesRulesetsSetCacheControlRuleActionParametersPublicRemoveDirectiveOperation = "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

SMaxage RulesetNewParamsRulesRulesetsSetCacheControlRuleActionParametersSMaxageOptional A cache-control directive configuration that accepts a duration value in seconds.

One of the following:

type RulesetNewParamsRulesRulesetsSetCacheControlRuleActionParametersSMaxageSetDirective struct{…} Set the directive with a duration value in seconds.

Operation RulesetNewParamsRulesRulesetsSetCacheControlRuleActionParametersSMaxageSetDirectiveOperation The operation to perform on the cache-control directive.

One of the following: const RulesetNewParamsRulesRulesetsSetCacheControlRuleActionParametersSMaxageSetDirectiveOperationSet RulesetNewParamsRulesRulesetsSetCacheControlRuleActionParametersSMaxageSetDirectiveOperation = "set" Link to this property const RulesetNewParamsRulesRulesetsSetCacheControlRuleActionParametersSMaxageSetDirectiveOperationRemove RulesetNewParamsRulesRulesetsSetCacheControlRuleActionParametersSMaxageSetDirectiveOperation = "remove" Link to this property

Link to this property

type RulesetNewParamsRulesRulesetsSetCacheControlRuleActionParametersSMaxageRemoveDirective struct{…} Remove the directive.

Operation RulesetNewParamsRulesRulesetsSetCacheControlRuleActionParametersSMaxageRemoveDirectiveOperation The operation to perform on the cache-control directive.

One of the following: const RulesetNewParamsRulesRulesetsSetCacheControlRuleActionParametersSMaxageRemoveDirectiveOperationSet RulesetNewParamsRulesRulesetsSetCacheControlRuleActionParametersSMaxageRemoveDirectiveOperation = "set" Link to this property const RulesetNewParamsRulesRulesetsSetCacheControlRuleActionParametersSMaxageRemoveDirectiveOperationRemove RulesetNewParamsRulesRulesetsSetCacheControlRuleActionParametersSMaxageRemoveDirectiveOperation = "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

StaleIfError RulesetNewParamsRulesRulesetsSetCacheControlRuleActionParametersStaleIfErrorOptional A cache-control directive configuration that accepts a duration value in seconds.

One of the following:

type RulesetNewParamsRulesRulesetsSetCacheControlRuleActionParametersStaleIfErrorSetDirective struct{…} Set the directive with a duration value in seconds.

Operation RulesetNewParamsRulesRulesetsSetCacheControlRuleActionParametersStaleIfErrorSetDirectiveOperation The operation to perform on the cache-control directive.

One of the following: const RulesetNewParamsRulesRulesetsSetCacheControlRuleActionParametersStaleIfErrorSetDirectiveOperationSet RulesetNewParamsRulesRulesetsSetCacheControlRuleActionParametersStaleIfErrorSetDirectiveOperation = "set" Link to this property const RulesetNewParamsRulesRulesetsSetCacheControlRuleActionParametersStaleIfErrorSetDirectiveOperationRemove RulesetNewParamsRulesRulesetsSetCacheControlRuleActionParametersStaleIfErrorSetDirectiveOperation = "remove" Link to this property

Link to this property

type RulesetNewParamsRulesRulesetsSetCacheControlRuleActionParametersStaleIfErrorRemoveDirective struct{…} Remove the directive.

Operation RulesetNewParamsRulesRulesetsSetCacheControlRuleActionParametersStaleIfErrorRemoveDirectiveOperation The operation to perform on the cache-control directive.

One of the following: const RulesetNewParamsRulesRulesetsSetCacheControlRuleActionParametersStaleIfErrorRemoveDirectiveOperationSet RulesetNewParamsRulesRulesetsSetCacheControlRuleActionParametersStaleIfErrorRemoveDirectiveOperation = "set" Link to this property const RulesetNewParamsRulesRulesetsSetCacheControlRuleActionParametersStaleIfErrorRemoveDirectiveOperationRemove RulesetNewParamsRulesRulesetsSetCacheControlRuleActionParametersStaleIfErrorRemoveDirectiveOperation = "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

StaleWhileRevalidate RulesetNewParamsRulesRulesetsSetCacheControlRuleActionParametersStaleWhileRevalidateOptional A cache-control directive configuration that accepts a duration value in seconds.

One of the following:

type RulesetNewParamsRulesRulesetsSetCacheControlRuleActionParametersStaleWhileRevalidateSetDirective struct{…} Set the directive with a duration value in seconds.

Operation RulesetNewParamsRulesRulesetsSetCacheControlRuleActionParametersStaleWhileRevalidateSetDirectiveOperation The operation to perform on the cache-control directive.

One of the following: const RulesetNewParamsRulesRulesetsSetCacheControlRuleActionParametersStaleWhileRevalidateSetDirectiveOperationSet RulesetNewParamsRulesRulesetsSetCacheControlRuleActionParametersStaleWhileRevalidateSetDirectiveOperation = "set" Link to this property const RulesetNewParamsRulesRulesetsSetCacheControlRuleActionParametersStaleWhileRevalidateSetDirectiveOperationRemove RulesetNewParamsRulesRulesetsSetCacheControlRuleActionParametersStaleWhileRevalidateSetDirectiveOperation = "remove" Link to this property

Link to this property

type RulesetNewParamsRulesRulesetsSetCacheControlRuleActionParametersStaleWhileRevalidateRemoveDirective struct{…} Remove the directive.

Operation RulesetNewParamsRulesRulesetsSetCacheControlRuleActionParametersStaleWhileRevalidateRemoveDirectiveOperation The operation to perform on the cache-control directive.

One of the following: const RulesetNewParamsRulesRulesetsSetCacheControlRuleActionParametersStaleWhileRevalidateRemoveDirectiveOperationSet RulesetNewParamsRulesRulesetsSetCacheControlRuleActionParametersStaleWhileRevalidateRemoveDirectiveOperation = "set" Link to this property const RulesetNewParamsRulesRulesetsSetCacheControlRuleActionParametersStaleWhileRevalidateRemoveDirectiveOperationRemove RulesetNewParamsRulesRulesetsSetCacheControlRuleActionParametersStaleWhileRevalidateRemoveDirectiveOperation = "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

ExposedCredentialCheck RulesetNewParamsRulesRulesetsSetCacheControlRuleExposedCredentialCheckOptional Configuration for exposed credential checking.

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 RulesetNewParamsRulesRulesetsSetCacheControlRuleRatelimitOptional An object configuring the rule’s rate limit behavior.

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{…}

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

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 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

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

ExposedCredentialCheck SetCacheSettingsRuleExposedCredentialCheckOptional Configuration for exposed credential checking.

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.

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 RulesetNewParamsRulesRulesetsSetCacheTagsRule struct{…}

ActionParameters RulesetNewParamsRulesRulesetsSetCacheTagsRuleActionParametersOptional The parameters configuring the rule’s action.

One of the following:

type RulesetNewParamsRulesRulesetsSetCacheTagsRuleActionParametersAddCacheTagsValues struct{…} Add cache tags using a list of values.

Operation RulesetNewParamsRulesRulesetsSetCacheTagsRuleActionParametersAddCacheTagsValuesOperation The operation to perform on the cache tags.

One of the following: const RulesetNewParamsRulesRulesetsSetCacheTagsRuleActionParametersAddCacheTagsValuesOperationAdd RulesetNewParamsRulesRulesetsSetCacheTagsRuleActionParametersAddCacheTagsValuesOperation = "add" Link to this property const RulesetNewParamsRulesRulesetsSetCacheTagsRuleActionParametersAddCacheTagsValuesOperationRemove RulesetNewParamsRulesRulesetsSetCacheTagsRuleActionParametersAddCacheTagsValuesOperation = "remove" Link to this property const RulesetNewParamsRulesRulesetsSetCacheTagsRuleActionParametersAddCacheTagsValuesOperationSet RulesetNewParamsRulesRulesetsSetCacheTagsRuleActionParametersAddCacheTagsValuesOperation = "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 RulesetNewParamsRulesRulesetsSetCacheTagsRuleActionParametersAddCacheTagsExpression 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 RulesetNewParamsRulesRulesetsSetCacheTagsRuleActionParametersAddCacheTagsExpressionOperation The operation to perform on the cache tags.

One of the following: const RulesetNewParamsRulesRulesetsSetCacheTagsRuleActionParametersAddCacheTagsExpressionOperationAdd RulesetNewParamsRulesRulesetsSetCacheTagsRuleActionParametersAddCacheTagsExpressionOperation = "add" Link to this property const RulesetNewParamsRulesRulesetsSetCacheTagsRuleActionParametersAddCacheTagsExpressionOperationRemove RulesetNewParamsRulesRulesetsSetCacheTagsRuleActionParametersAddCacheTagsExpressionOperation = "remove" Link to this property const RulesetNewParamsRulesRulesetsSetCacheTagsRuleActionParametersAddCacheTagsExpressionOperationSet RulesetNewParamsRulesRulesetsSetCacheTagsRuleActionParametersAddCacheTagsExpressionOperation = "set" Link to this property

Link to this property

type RulesetNewParamsRulesRulesetsSetCacheTagsRuleActionParametersRemoveCacheTagsValues struct{…} Remove cache tags using a list of values.

Operation RulesetNewParamsRulesRulesetsSetCacheTagsRuleActionParametersRemoveCacheTagsValuesOperation The operation to perform on the cache tags.

One of the following: const RulesetNewParamsRulesRulesetsSetCacheTagsRuleActionParametersRemoveCacheTagsValuesOperationAdd RulesetNewParamsRulesRulesetsSetCacheTagsRuleActionParametersRemoveCacheTagsValuesOperation = "add" Link to this property const RulesetNewParamsRulesRulesetsSetCacheTagsRuleActionParametersRemoveCacheTagsValuesOperationRemove RulesetNewParamsRulesRulesetsSetCacheTagsRuleActionParametersRemoveCacheTagsValuesOperation = "remove" Link to this property const RulesetNewParamsRulesRulesetsSetCacheTagsRuleActionParametersRemoveCacheTagsValuesOperationSet RulesetNewParamsRulesRulesetsSetCacheTagsRuleActionParametersRemoveCacheTagsValuesOperation = "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 RulesetNewParamsRulesRulesetsSetCacheTagsRuleActionParametersRemoveCacheTagsExpression 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 RulesetNewParamsRulesRulesetsSetCacheTagsRuleActionParametersRemoveCacheTagsExpressionOperation The operation to perform on the cache tags.

One of the following: const RulesetNewParamsRulesRulesetsSetCacheTagsRuleActionParametersRemoveCacheTagsExpressionOperationAdd RulesetNewParamsRulesRulesetsSetCacheTagsRuleActionParametersRemoveCacheTagsExpressionOperation = "add" Link to this property const RulesetNewParamsRulesRulesetsSetCacheTagsRuleActionParametersRemoveCacheTagsExpressionOperationRemove RulesetNewParamsRulesRulesetsSetCacheTagsRuleActionParametersRemoveCacheTagsExpressionOperation = "remove" Link to this property const RulesetNewParamsRulesRulesetsSetCacheTagsRuleActionParametersRemoveCacheTagsExpressionOperationSet RulesetNewParamsRulesRulesetsSetCacheTagsRuleActionParametersRemoveCacheTagsExpressionOperation = "set" Link to this property

Link to this property

type RulesetNewParamsRulesRulesetsSetCacheTagsRuleActionParametersSetCacheTagsValues struct{…} Set cache tags using a list of values.

Operation RulesetNewParamsRulesRulesetsSetCacheTagsRuleActionParametersSetCacheTagsValuesOperation The operation to perform on the cache tags.

One of the following: const RulesetNewParamsRulesRulesetsSetCacheTagsRuleActionParametersSetCacheTagsValuesOperationAdd RulesetNewParamsRulesRulesetsSetCacheTagsRuleActionParametersSetCacheTagsValuesOperation = "add" Link to this property const RulesetNewParamsRulesRulesetsSetCacheTagsRuleActionParametersSetCacheTagsValuesOperationRemove RulesetNewParamsRulesRulesetsSetCacheTagsRuleActionParametersSetCacheTagsValuesOperation = "remove" Link to this property const RulesetNewParamsRulesRulesetsSetCacheTagsRuleActionParametersSetCacheTagsValuesOperationSet RulesetNewParamsRulesRulesetsSetCacheTagsRuleActionParametersSetCacheTagsValuesOperation = "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 RulesetNewParamsRulesRulesetsSetCacheTagsRuleActionParametersSetCacheTagsExpression 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 RulesetNewParamsRulesRulesetsSetCacheTagsRuleActionParametersSetCacheTagsExpressionOperation The operation to perform on the cache tags.

One of the following: const RulesetNewParamsRulesRulesetsSetCacheTagsRuleActionParametersSetCacheTagsExpressionOperationAdd RulesetNewParamsRulesRulesetsSetCacheTagsRuleActionParametersSetCacheTagsExpressionOperation = "add" Link to this property const RulesetNewParamsRulesRulesetsSetCacheTagsRuleActionParametersSetCacheTagsExpressionOperationRemove RulesetNewParamsRulesRulesetsSetCacheTagsRuleActionParametersSetCacheTagsExpressionOperation = "remove" Link to this property const RulesetNewParamsRulesRulesetsSetCacheTagsRuleActionParametersSetCacheTagsExpressionOperationSet RulesetNewParamsRulesRulesetsSetCacheTagsRuleActionParametersSetCacheTagsExpressionOperation = "set" Link to this property

Link to this property

ExposedCredentialCheck RulesetNewParamsRulesRulesetsSetCacheTagsRuleExposedCredentialCheckOptional Configuration for exposed credential checking.

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 RulesetNewParamsRulesRulesetsSetCacheTagsRuleRatelimitOptional An object configuring the rule’s rate limit behavior.

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{…}

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

ExposedCredentialCheck SetConfigRuleExposedCredentialCheckOptional Configuration for exposed credential checking.

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.

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{…}

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

ExposedCredentialCheck SkipRuleExposedCredentialCheckOptional Configuration for exposed credential checking.

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.

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 RulesetNewParamsRulesRulesetsTransformResponseHTMLRule struct{…}

ActionParameters RulesetNewParamsRulesRulesetsTransformResponseHTMLRuleActionParametersOptional The parameters configuring the rule’s action.

LinkMaze unknown Enables the link maze transformation on the response. Link to this property

ExposedCredentialCheck RulesetNewParamsRulesRulesetsTransformResponseHTMLRuleExposedCredentialCheckOptional Configuration for exposed credential checking.

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 RulesetNewParamsRulesRulesetsTransformResponseHTMLRuleRatelimitOptional An object configuring the rule’s rate limit behavior.

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](<#(resource)%20rulesets%20%3E%20(method)%20create%20%3E%20(params)%20default>) ##### ReturnsExpand Collapse

type RulesetNewResponseEnvelopeResult interface{…} A result.

One of the following:

type RulesetNewResponseEnvelopeResult 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.

Link to this property

Rules \[]RulesetNewResponseEnvelopeResultRules The list of rules in the ruleset.

One of the following:

type RulesetNewResponseEnvelopeResultRulesBlockRule 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 RulesetNewResponseEnvelopeResultRulesChallengeRule struct{…}

ID string The unique ID of the rule. Link to this property Action RulesetNewResponseEnvelopeResultRulesChallengeRuleAction 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 RulesetNewResponseEnvelopeResultRulesChallengeRuleExposedCredentialCheckOptional Configuration for exposed credential checking.

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 RulesetNewResponseEnvelopeResultRulesChallengeRuleRatelimitOptional An object configuring the rule’s rate limit behavior.

Link to this property

type RulesetNewResponseEnvelopeResultRulesResponseCompressionRule 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 RulesetNewResponseEnvelopeResultRulesDDoSDynamicRule 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 RulesetNewResponseEnvelopeResultRulesExecuteRule 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 RulesetNewResponseEnvelopeResultRulesForceConnectionCloseRule 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 RulesetNewResponseEnvelopeResultRulesJavaScriptChallengeRule struct{…}

ID string The unique ID of the rule. Link to this property Action RulesetNewResponseEnvelopeResultRulesJavaScriptChallengeRuleAction 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 RulesetNewResponseEnvelopeResultRulesJavaScriptChallengeRuleExposedCredentialCheckOptional Configuration for exposed credential checking.

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 RulesetNewResponseEnvelopeResultRulesJavaScriptChallengeRuleRatelimitOptional An object configuring the rule’s rate limit behavior.

Link to this property

type RulesetNewResponseEnvelopeResultRulesLogRule 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 RulesetNewResponseEnvelopeResultRulesLogCustomFieldRule 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 RulesetNewResponseEnvelopeResultRulesManagedChallengeRule 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 RulesetNewResponseEnvelopeResultRulesRedirectRule 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 RulesetNewResponseEnvelopeResultRulesRewriteRule 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 RulesetNewResponseEnvelopeResultRulesRouteRule 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 RulesetNewResponseEnvelopeResultRulesScoreRule 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 RulesetNewResponseEnvelopeResultRulesServeErrorRule 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 RulesetNewResponseEnvelopeResultRulesSetCacheControlRule struct{…}

ID string The unique ID of the rule. Link to this property Action RulesetNewResponseEnvelopeResultRulesSetCacheControlRuleAction 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 RulesetNewResponseEnvelopeResultRulesSetCacheControlRuleActionParametersOptional The parameters configuring the rule’s action.

Immutable RulesetNewResponseEnvelopeResultRulesSetCacheControlRuleActionParametersImmutableOptional A cache-control directive configuration.

One of the following:

type RulesetNewResponseEnvelopeResultRulesSetCacheControlRuleActionParametersImmutableSetDirective struct{…} Set the directive.

Operation RulesetNewResponseEnvelopeResultRulesSetCacheControlRuleActionParametersImmutableSetDirectiveOperation The operation to perform on the cache-control directive.

One of the following: const RulesetNewResponseEnvelopeResultRulesSetCacheControlRuleActionParametersImmutableSetDirectiveOperationSet RulesetNewResponseEnvelopeResultRulesSetCacheControlRuleActionParametersImmutableSetDirectiveOperation = "set" Link to this property const RulesetNewResponseEnvelopeResultRulesSetCacheControlRuleActionParametersImmutableSetDirectiveOperationRemove RulesetNewResponseEnvelopeResultRulesSetCacheControlRuleActionParametersImmutableSetDirectiveOperation = "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 RulesetNewResponseEnvelopeResultRulesSetCacheControlRuleActionParametersImmutableRemoveDirective struct{…} Remove the directive.

Operation RulesetNewResponseEnvelopeResultRulesSetCacheControlRuleActionParametersImmutableRemoveDirectiveOperation The operation to perform on the cache-control directive.

One of the following: const RulesetNewResponseEnvelopeResultRulesSetCacheControlRuleActionParametersImmutableRemoveDirectiveOperationSet RulesetNewResponseEnvelopeResultRulesSetCacheControlRuleActionParametersImmutableRemoveDirectiveOperation = "set" Link to this property const RulesetNewResponseEnvelopeResultRulesSetCacheControlRuleActionParametersImmutableRemoveDirectiveOperationRemove RulesetNewResponseEnvelopeResultRulesSetCacheControlRuleActionParametersImmutableRemoveDirectiveOperation = "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

MaxAge RulesetNewResponseEnvelopeResultRulesSetCacheControlRuleActionParametersMaxAgeOptional A cache-control directive configuration that accepts a duration value in seconds.

One of the following:

type RulesetNewResponseEnvelopeResultRulesSetCacheControlRuleActionParametersMaxAgeSetDirective struct{…} Set the directive with a duration value in seconds.

Operation RulesetNewResponseEnvelopeResultRulesSetCacheControlRuleActionParametersMaxAgeSetDirectiveOperation The operation to perform on the cache-control directive.

One of the following: const RulesetNewResponseEnvelopeResultRulesSetCacheControlRuleActionParametersMaxAgeSetDirectiveOperationSet RulesetNewResponseEnvelopeResultRulesSetCacheControlRuleActionParametersMaxAgeSetDirectiveOperation = "set" Link to this property const RulesetNewResponseEnvelopeResultRulesSetCacheControlRuleActionParametersMaxAgeSetDirectiveOperationRemove RulesetNewResponseEnvelopeResultRulesSetCacheControlRuleActionParametersMaxAgeSetDirectiveOperation = "remove" Link to this property

Link to this property

type RulesetNewResponseEnvelopeResultRulesSetCacheControlRuleActionParametersMaxAgeRemoveDirective struct{…} Remove the directive.

Operation RulesetNewResponseEnvelopeResultRulesSetCacheControlRuleActionParametersMaxAgeRemoveDirectiveOperation The operation to perform on the cache-control directive.

One of the following: const RulesetNewResponseEnvelopeResultRulesSetCacheControlRuleActionParametersMaxAgeRemoveDirectiveOperationSet RulesetNewResponseEnvelopeResultRulesSetCacheControlRuleActionParametersMaxAgeRemoveDirectiveOperation = "set" Link to this property const RulesetNewResponseEnvelopeResultRulesSetCacheControlRuleActionParametersMaxAgeRemoveDirectiveOperationRemove RulesetNewResponseEnvelopeResultRulesSetCacheControlRuleActionParametersMaxAgeRemoveDirectiveOperation = "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

MustRevalidate RulesetNewResponseEnvelopeResultRulesSetCacheControlRuleActionParametersMustRevalidateOptional A cache-control directive configuration.

One of the following:

type RulesetNewResponseEnvelopeResultRulesSetCacheControlRuleActionParametersMustRevalidateSetDirective struct{…} Set the directive.

Operation RulesetNewResponseEnvelopeResultRulesSetCacheControlRuleActionParametersMustRevalidateSetDirectiveOperation The operation to perform on the cache-control directive.

One of the following: const RulesetNewResponseEnvelopeResultRulesSetCacheControlRuleActionParametersMustRevalidateSetDirectiveOperationSet RulesetNewResponseEnvelopeResultRulesSetCacheControlRuleActionParametersMustRevalidateSetDirectiveOperation = "set" Link to this property const RulesetNewResponseEnvelopeResultRulesSetCacheControlRuleActionParametersMustRevalidateSetDirectiveOperationRemove RulesetNewResponseEnvelopeResultRulesSetCacheControlRuleActionParametersMustRevalidateSetDirectiveOperation = "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 RulesetNewResponseEnvelopeResultRulesSetCacheControlRuleActionParametersMustRevalidateRemoveDirective struct{…} Remove the directive.

Operation RulesetNewResponseEnvelopeResultRulesSetCacheControlRuleActionParametersMustRevalidateRemoveDirectiveOperation The operation to perform on the cache-control directive.

One of the following: const RulesetNewResponseEnvelopeResultRulesSetCacheControlRuleActionParametersMustRevalidateRemoveDirectiveOperationSet RulesetNewResponseEnvelopeResultRulesSetCacheControlRuleActionParametersMustRevalidateRemoveDirectiveOperation = "set" Link to this property const RulesetNewResponseEnvelopeResultRulesSetCacheControlRuleActionParametersMustRevalidateRemoveDirectiveOperationRemove RulesetNewResponseEnvelopeResultRulesSetCacheControlRuleActionParametersMustRevalidateRemoveDirectiveOperation = "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

MustUnderstand RulesetNewResponseEnvelopeResultRulesSetCacheControlRuleActionParametersMustUnderstandOptional A cache-control directive configuration.

One of the following:

type RulesetNewResponseEnvelopeResultRulesSetCacheControlRuleActionParametersMustUnderstandSetDirective struct{…} Set the directive.

Operation RulesetNewResponseEnvelopeResultRulesSetCacheControlRuleActionParametersMustUnderstandSetDirectiveOperation The operation to perform on the cache-control directive.

One of the following: const RulesetNewResponseEnvelopeResultRulesSetCacheControlRuleActionParametersMustUnderstandSetDirectiveOperationSet RulesetNewResponseEnvelopeResultRulesSetCacheControlRuleActionParametersMustUnderstandSetDirectiveOperation = "set" Link to this property const RulesetNewResponseEnvelopeResultRulesSetCacheControlRuleActionParametersMustUnderstandSetDirectiveOperationRemove RulesetNewResponseEnvelopeResultRulesSetCacheControlRuleActionParametersMustUnderstandSetDirectiveOperation = "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 RulesetNewResponseEnvelopeResultRulesSetCacheControlRuleActionParametersMustUnderstandRemoveDirective struct{…} Remove the directive.

Operation RulesetNewResponseEnvelopeResultRulesSetCacheControlRuleActionParametersMustUnderstandRemoveDirectiveOperation The operation to perform on the cache-control directive.

One of the following: const RulesetNewResponseEnvelopeResultRulesSetCacheControlRuleActionParametersMustUnderstandRemoveDirectiveOperationSet RulesetNewResponseEnvelopeResultRulesSetCacheControlRuleActionParametersMustUnderstandRemoveDirectiveOperation = "set" Link to this property const RulesetNewResponseEnvelopeResultRulesSetCacheControlRuleActionParametersMustUnderstandRemoveDirectiveOperationRemove RulesetNewResponseEnvelopeResultRulesSetCacheControlRuleActionParametersMustUnderstandRemoveDirectiveOperation = "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

NoCache RulesetNewResponseEnvelopeResultRulesSetCacheControlRuleActionParametersNoCacheOptional A cache-control directive configuration that accepts optional qualifiers (header names).

One of the following:

type RulesetNewResponseEnvelopeResultRulesSetCacheControlRuleActionParametersNoCacheSetDirective struct{…} Set the directive with optional qualifiers.

Operation RulesetNewResponseEnvelopeResultRulesSetCacheControlRuleActionParametersNoCacheSetDirectiveOperation The operation to perform on the cache-control directive.

One of the following: const RulesetNewResponseEnvelopeResultRulesSetCacheControlRuleActionParametersNoCacheSetDirectiveOperationSet RulesetNewResponseEnvelopeResultRulesSetCacheControlRuleActionParametersNoCacheSetDirectiveOperation = "set" Link to this property const RulesetNewResponseEnvelopeResultRulesSetCacheControlRuleActionParametersNoCacheSetDirectiveOperationRemove RulesetNewResponseEnvelopeResultRulesSetCacheControlRuleActionParametersNoCacheSetDirectiveOperation = "remove" Link to this property

Link to this property

type RulesetNewResponseEnvelopeResultRulesSetCacheControlRuleActionParametersNoCacheRemoveDirective struct{…} Remove the directive.

Operation RulesetNewResponseEnvelopeResultRulesSetCacheControlRuleActionParametersNoCacheRemoveDirectiveOperation The operation to perform on the cache-control directive.

One of the following: const RulesetNewResponseEnvelopeResultRulesSetCacheControlRuleActionParametersNoCacheRemoveDirectiveOperationSet RulesetNewResponseEnvelopeResultRulesSetCacheControlRuleActionParametersNoCacheRemoveDirectiveOperation = "set" Link to this property const RulesetNewResponseEnvelopeResultRulesSetCacheControlRuleActionParametersNoCacheRemoveDirectiveOperationRemove RulesetNewResponseEnvelopeResultRulesSetCacheControlRuleActionParametersNoCacheRemoveDirectiveOperation = "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

NoStore RulesetNewResponseEnvelopeResultRulesSetCacheControlRuleActionParametersNoStoreOptional A cache-control directive configuration.

One of the following:

type RulesetNewResponseEnvelopeResultRulesSetCacheControlRuleActionParametersNoStoreSetDirective struct{…} Set the directive.

Operation RulesetNewResponseEnvelopeResultRulesSetCacheControlRuleActionParametersNoStoreSetDirectiveOperation The operation to perform on the cache-control directive.

One of the following: const RulesetNewResponseEnvelopeResultRulesSetCacheControlRuleActionParametersNoStoreSetDirectiveOperationSet RulesetNewResponseEnvelopeResultRulesSetCacheControlRuleActionParametersNoStoreSetDirectiveOperation = "set" Link to this property const RulesetNewResponseEnvelopeResultRulesSetCacheControlRuleActionParametersNoStoreSetDirectiveOperationRemove RulesetNewResponseEnvelopeResultRulesSetCacheControlRuleActionParametersNoStoreSetDirectiveOperation = "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 RulesetNewResponseEnvelopeResultRulesSetCacheControlRuleActionParametersNoStoreRemoveDirective struct{…} Remove the directive.

Operation RulesetNewResponseEnvelopeResultRulesSetCacheControlRuleActionParametersNoStoreRemoveDirectiveOperation The operation to perform on the cache-control directive.

One of the following: const RulesetNewResponseEnvelopeResultRulesSetCacheControlRuleActionParametersNoStoreRemoveDirectiveOperationSet RulesetNewResponseEnvelopeResultRulesSetCacheControlRuleActionParametersNoStoreRemoveDirectiveOperation = "set" Link to this property const RulesetNewResponseEnvelopeResultRulesSetCacheControlRuleActionParametersNoStoreRemoveDirectiveOperationRemove RulesetNewResponseEnvelopeResultRulesSetCacheControlRuleActionParametersNoStoreRemoveDirectiveOperation = "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

NoTransform RulesetNewResponseEnvelopeResultRulesSetCacheControlRuleActionParametersNoTransformOptional A cache-control directive configuration.

One of the following:

type RulesetNewResponseEnvelopeResultRulesSetCacheControlRuleActionParametersNoTransformSetDirective struct{…} Set the directive.

Operation RulesetNewResponseEnvelopeResultRulesSetCacheControlRuleActionParametersNoTransformSetDirectiveOperation The operation to perform on the cache-control directive.

One of the following: const RulesetNewResponseEnvelopeResultRulesSetCacheControlRuleActionParametersNoTransformSetDirectiveOperationSet RulesetNewResponseEnvelopeResultRulesSetCacheControlRuleActionParametersNoTransformSetDirectiveOperation = "set" Link to this property const RulesetNewResponseEnvelopeResultRulesSetCacheControlRuleActionParametersNoTransformSetDirectiveOperationRemove RulesetNewResponseEnvelopeResultRulesSetCacheControlRuleActionParametersNoTransformSetDirectiveOperation = "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 RulesetNewResponseEnvelopeResultRulesSetCacheControlRuleActionParametersNoTransformRemoveDirective struct{…} Remove the directive.

Operation RulesetNewResponseEnvelopeResultRulesSetCacheControlRuleActionParametersNoTransformRemoveDirectiveOperation The operation to perform on the cache-control directive.

One of the following: const RulesetNewResponseEnvelopeResultRulesSetCacheControlRuleActionParametersNoTransformRemoveDirectiveOperationSet RulesetNewResponseEnvelopeResultRulesSetCacheControlRuleActionParametersNoTransformRemoveDirectiveOperation = "set" Link to this property const RulesetNewResponseEnvelopeResultRulesSetCacheControlRuleActionParametersNoTransformRemoveDirectiveOperationRemove RulesetNewResponseEnvelopeResultRulesSetCacheControlRuleActionParametersNoTransformRemoveDirectiveOperation = "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

Private RulesetNewResponseEnvelopeResultRulesSetCacheControlRuleActionParametersPrivateOptional A cache-control directive configuration that accepts optional qualifiers (header names).

One of the following:

type RulesetNewResponseEnvelopeResultRulesSetCacheControlRuleActionParametersPrivateSetDirective struct{…} Set the directive with optional qualifiers.

Operation RulesetNewResponseEnvelopeResultRulesSetCacheControlRuleActionParametersPrivateSetDirectiveOperation The operation to perform on the cache-control directive.

One of the following: const RulesetNewResponseEnvelopeResultRulesSetCacheControlRuleActionParametersPrivateSetDirectiveOperationSet RulesetNewResponseEnvelopeResultRulesSetCacheControlRuleActionParametersPrivateSetDirectiveOperation = "set" Link to this property const RulesetNewResponseEnvelopeResultRulesSetCacheControlRuleActionParametersPrivateSetDirectiveOperationRemove RulesetNewResponseEnvelopeResultRulesSetCacheControlRuleActionParametersPrivateSetDirectiveOperation = "remove" Link to this property

Link to this property

type RulesetNewResponseEnvelopeResultRulesSetCacheControlRuleActionParametersPrivateRemoveDirective struct{…} Remove the directive.

Operation RulesetNewResponseEnvelopeResultRulesSetCacheControlRuleActionParametersPrivateRemoveDirectiveOperation The operation to perform on the cache-control directive.

One of the following: const RulesetNewResponseEnvelopeResultRulesSetCacheControlRuleActionParametersPrivateRemoveDirectiveOperationSet RulesetNewResponseEnvelopeResultRulesSetCacheControlRuleActionParametersPrivateRemoveDirectiveOperation = "set" Link to this property const RulesetNewResponseEnvelopeResultRulesSetCacheControlRuleActionParametersPrivateRemoveDirectiveOperationRemove RulesetNewResponseEnvelopeResultRulesSetCacheControlRuleActionParametersPrivateRemoveDirectiveOperation = "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

ProxyRevalidate RulesetNewResponseEnvelopeResultRulesSetCacheControlRuleActionParametersProxyRevalidateOptional A cache-control directive configuration.

One of the following:

type RulesetNewResponseEnvelopeResultRulesSetCacheControlRuleActionParametersProxyRevalidateSetDirective struct{…} Set the directive.

Operation RulesetNewResponseEnvelopeResultRulesSetCacheControlRuleActionParametersProxyRevalidateSetDirectiveOperation The operation to perform on the cache-control directive.

One of the following: const RulesetNewResponseEnvelopeResultRulesSetCacheControlRuleActionParametersProxyRevalidateSetDirectiveOperationSet RulesetNewResponseEnvelopeResultRulesSetCacheControlRuleActionParametersProxyRevalidateSetDirectiveOperation = "set" Link to this property const RulesetNewResponseEnvelopeResultRulesSetCacheControlRuleActionParametersProxyRevalidateSetDirectiveOperationRemove RulesetNewResponseEnvelopeResultRulesSetCacheControlRuleActionParametersProxyRevalidateSetDirectiveOperation = "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 RulesetNewResponseEnvelopeResultRulesSetCacheControlRuleActionParametersProxyRevalidateRemoveDirective struct{…} Remove the directive.

Operation RulesetNewResponseEnvelopeResultRulesSetCacheControlRuleActionParametersProxyRevalidateRemoveDirectiveOperation The operation to perform on the cache-control directive.

One of the following: const RulesetNewResponseEnvelopeResultRulesSetCacheControlRuleActionParametersProxyRevalidateRemoveDirectiveOperationSet RulesetNewResponseEnvelopeResultRulesSetCacheControlRuleActionParametersProxyRevalidateRemoveDirectiveOperation = "set" Link to this property const RulesetNewResponseEnvelopeResultRulesSetCacheControlRuleActionParametersProxyRevalidateRemoveDirectiveOperationRemove RulesetNewResponseEnvelopeResultRulesSetCacheControlRuleActionParametersProxyRevalidateRemoveDirectiveOperation = "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

Public RulesetNewResponseEnvelopeResultRulesSetCacheControlRuleActionParametersPublicOptional A cache-control directive configuration.

One of the following:

type RulesetNewResponseEnvelopeResultRulesSetCacheControlRuleActionParametersPublicSetDirective struct{…} Set the directive.

Operation RulesetNewResponseEnvelopeResultRulesSetCacheControlRuleActionParametersPublicSetDirectiveOperation The operation to perform on the cache-control directive.

One of the following: const RulesetNewResponseEnvelopeResultRulesSetCacheControlRuleActionParametersPublicSetDirectiveOperationSet RulesetNewResponseEnvelopeResultRulesSetCacheControlRuleActionParametersPublicSetDirectiveOperation = "set" Link to this property const RulesetNewResponseEnvelopeResultRulesSetCacheControlRuleActionParametersPublicSetDirectiveOperationRemove RulesetNewResponseEnvelopeResultRulesSetCacheControlRuleActionParametersPublicSetDirectiveOperation = "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 RulesetNewResponseEnvelopeResultRulesSetCacheControlRuleActionParametersPublicRemoveDirective struct{…} Remove the directive.

Operation RulesetNewResponseEnvelopeResultRulesSetCacheControlRuleActionParametersPublicRemoveDirectiveOperation The operation to perform on the cache-control directive.

One of the following: const RulesetNewResponseEnvelopeResultRulesSetCacheControlRuleActionParametersPublicRemoveDirectiveOperationSet RulesetNewResponseEnvelopeResultRulesSetCacheControlRuleActionParametersPublicRemoveDirectiveOperation = "set" Link to this property const RulesetNewResponseEnvelopeResultRulesSetCacheControlRuleActionParametersPublicRemoveDirectiveOperationRemove RulesetNewResponseEnvelopeResultRulesSetCacheControlRuleActionParametersPublicRemoveDirectiveOperation = "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

SMaxage RulesetNewResponseEnvelopeResultRulesSetCacheControlRuleActionParametersSMaxageOptional A cache-control directive configuration that accepts a duration value in seconds.

One of the following:

type RulesetNewResponseEnvelopeResultRulesSetCacheControlRuleActionParametersSMaxageSetDirective struct{…} Set the directive with a duration value in seconds.

Operation RulesetNewResponseEnvelopeResultRulesSetCacheControlRuleActionParametersSMaxageSetDirectiveOperation The operation to perform on the cache-control directive.

One of the following: const RulesetNewResponseEnvelopeResultRulesSetCacheControlRuleActionParametersSMaxageSetDirectiveOperationSet RulesetNewResponseEnvelopeResultRulesSetCacheControlRuleActionParametersSMaxageSetDirectiveOperation = "set" Link to this property const RulesetNewResponseEnvelopeResultRulesSetCacheControlRuleActionParametersSMaxageSetDirectiveOperationRemove RulesetNewResponseEnvelopeResultRulesSetCacheControlRuleActionParametersSMaxageSetDirectiveOperation = "remove" Link to this property

Link to this property

type RulesetNewResponseEnvelopeResultRulesSetCacheControlRuleActionParametersSMaxageRemoveDirective struct{…} Remove the directive.

Operation RulesetNewResponseEnvelopeResultRulesSetCacheControlRuleActionParametersSMaxageRemoveDirectiveOperation The operation to perform on the cache-control directive.

One of the following: const RulesetNewResponseEnvelopeResultRulesSetCacheControlRuleActionParametersSMaxageRemoveDirectiveOperationSet RulesetNewResponseEnvelopeResultRulesSetCacheControlRuleActionParametersSMaxageRemoveDirectiveOperation = "set" Link to this property const RulesetNewResponseEnvelopeResultRulesSetCacheControlRuleActionParametersSMaxageRemoveDirectiveOperationRemove RulesetNewResponseEnvelopeResultRulesSetCacheControlRuleActionParametersSMaxageRemoveDirectiveOperation = "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

StaleIfError RulesetNewResponseEnvelopeResultRulesSetCacheControlRuleActionParametersStaleIfErrorOptional A cache-control directive configuration that accepts a duration value in seconds.

One of the following:

type RulesetNewResponseEnvelopeResultRulesSetCacheControlRuleActionParametersStaleIfErrorSetDirective struct{…} Set the directive with a duration value in seconds.

Operation RulesetNewResponseEnvelopeResultRulesSetCacheControlRuleActionParametersStaleIfErrorSetDirectiveOperation The operation to perform on the cache-control directive.

One of the following: const RulesetNewResponseEnvelopeResultRulesSetCacheControlRuleActionParametersStaleIfErrorSetDirectiveOperationSet RulesetNewResponseEnvelopeResultRulesSetCacheControlRuleActionParametersStaleIfErrorSetDirectiveOperation = "set" Link to this property const RulesetNewResponseEnvelopeResultRulesSetCacheControlRuleActionParametersStaleIfErrorSetDirectiveOperationRemove RulesetNewResponseEnvelopeResultRulesSetCacheControlRuleActionParametersStaleIfErrorSetDirectiveOperation = "remove" Link to this property

Link to this property

type RulesetNewResponseEnvelopeResultRulesSetCacheControlRuleActionParametersStaleIfErrorRemoveDirective struct{…} Remove the directive.

Operation RulesetNewResponseEnvelopeResultRulesSetCacheControlRuleActionParametersStaleIfErrorRemoveDirectiveOperation The operation to perform on the cache-control directive.

One of the following: const RulesetNewResponseEnvelopeResultRulesSetCacheControlRuleActionParametersStaleIfErrorRemoveDirectiveOperationSet RulesetNewResponseEnvelopeResultRulesSetCacheControlRuleActionParametersStaleIfErrorRemoveDirectiveOperation = "set" Link to this property const RulesetNewResponseEnvelopeResultRulesSetCacheControlRuleActionParametersStaleIfErrorRemoveDirectiveOperationRemove RulesetNewResponseEnvelopeResultRulesSetCacheControlRuleActionParametersStaleIfErrorRemoveDirectiveOperation = "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

StaleWhileRevalidate RulesetNewResponseEnvelopeResultRulesSetCacheControlRuleActionParametersStaleWhileRevalidateOptional A cache-control directive configuration that accepts a duration value in seconds.

One of the following:

type RulesetNewResponseEnvelopeResultRulesSetCacheControlRuleActionParametersStaleWhileRevalidateSetDirective struct{…} Set the directive with a duration value in seconds.

Operation RulesetNewResponseEnvelopeResultRulesSetCacheControlRuleActionParametersStaleWhileRevalidateSetDirectiveOperation The operation to perform on the cache-control directive.

One of the following: const RulesetNewResponseEnvelopeResultRulesSetCacheControlRuleActionParametersStaleWhileRevalidateSetDirectiveOperationSet RulesetNewResponseEnvelopeResultRulesSetCacheControlRuleActionParametersStaleWhileRevalidateSetDirectiveOperation = "set" Link to this property const RulesetNewResponseEnvelopeResultRulesSetCacheControlRuleActionParametersStaleWhileRevalidateSetDirectiveOperationRemove RulesetNewResponseEnvelopeResultRulesSetCacheControlRuleActionParametersStaleWhileRevalidateSetDirectiveOperation = "remove" Link to this property

Link to this property

type RulesetNewResponseEnvelopeResultRulesSetCacheControlRuleActionParametersStaleWhileRevalidateRemoveDirective struct{…} Remove the directive.

Operation RulesetNewResponseEnvelopeResultRulesSetCacheControlRuleActionParametersStaleWhileRevalidateRemoveDirectiveOperation The operation to perform on the cache-control directive.

One of the following: const RulesetNewResponseEnvelopeResultRulesSetCacheControlRuleActionParametersStaleWhileRevalidateRemoveDirectiveOperationSet RulesetNewResponseEnvelopeResultRulesSetCacheControlRuleActionParametersStaleWhileRevalidateRemoveDirectiveOperation = "set" Link to this property const RulesetNewResponseEnvelopeResultRulesSetCacheControlRuleActionParametersStaleWhileRevalidateRemoveDirectiveOperationRemove RulesetNewResponseEnvelopeResultRulesSetCacheControlRuleActionParametersStaleWhileRevalidateRemoveDirectiveOperation = "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 Categories \[]stringOptional The categories of the rule. Link to this property Description stringOptional An informative description of the rule. Link to this property

ExposedCredentialCheck RulesetNewResponseEnvelopeResultRulesSetCacheControlRuleExposedCredentialCheckOptional Configuration for exposed credential checking.

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 RulesetNewResponseEnvelopeResultRulesSetCacheControlRuleRatelimitOptional An object configuring the rule’s rate limit behavior.

Link to this property

type RulesetNewResponseEnvelopeResultRulesSetCacheSettingsRule 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 RulesetNewResponseEnvelopeResultRulesSetCacheTagsRule struct{…}

ID string The unique ID of the rule. Link to this property Action RulesetNewResponseEnvelopeResultRulesSetCacheTagsRuleAction 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 RulesetNewResponseEnvelopeResultRulesSetCacheTagsRuleActionParametersOptional The parameters configuring the rule’s action.

One of the following:

type RulesetNewResponseEnvelopeResultRulesSetCacheTagsRuleActionParametersAddCacheTagsValues struct{…} Add cache tags using a list of values.

Operation RulesetNewResponseEnvelopeResultRulesSetCacheTagsRuleActionParametersAddCacheTagsValuesOperation The operation to perform on the cache tags.

One of the following: const RulesetNewResponseEnvelopeResultRulesSetCacheTagsRuleActionParametersAddCacheTagsValuesOperationAdd RulesetNewResponseEnvelopeResultRulesSetCacheTagsRuleActionParametersAddCacheTagsValuesOperation = "add" Link to this property const RulesetNewResponseEnvelopeResultRulesSetCacheTagsRuleActionParametersAddCacheTagsValuesOperationRemove RulesetNewResponseEnvelopeResultRulesSetCacheTagsRuleActionParametersAddCacheTagsValuesOperation = "remove" Link to this property const RulesetNewResponseEnvelopeResultRulesSetCacheTagsRuleActionParametersAddCacheTagsValuesOperationSet RulesetNewResponseEnvelopeResultRulesSetCacheTagsRuleActionParametersAddCacheTagsValuesOperation = "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 RulesetNewResponseEnvelopeResultRulesSetCacheTagsRuleActionParametersAddCacheTagsExpression 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 RulesetNewResponseEnvelopeResultRulesSetCacheTagsRuleActionParametersAddCacheTagsExpressionOperation The operation to perform on the cache tags.

One of the following: const RulesetNewResponseEnvelopeResultRulesSetCacheTagsRuleActionParametersAddCacheTagsExpressionOperationAdd RulesetNewResponseEnvelopeResultRulesSetCacheTagsRuleActionParametersAddCacheTagsExpressionOperation = "add" Link to this property const RulesetNewResponseEnvelopeResultRulesSetCacheTagsRuleActionParametersAddCacheTagsExpressionOperationRemove RulesetNewResponseEnvelopeResultRulesSetCacheTagsRuleActionParametersAddCacheTagsExpressionOperation = "remove" Link to this property const RulesetNewResponseEnvelopeResultRulesSetCacheTagsRuleActionParametersAddCacheTagsExpressionOperationSet RulesetNewResponseEnvelopeResultRulesSetCacheTagsRuleActionParametersAddCacheTagsExpressionOperation = "set" Link to this property

Link to this property

type RulesetNewResponseEnvelopeResultRulesSetCacheTagsRuleActionParametersRemoveCacheTagsValues struct{…} Remove cache tags using a list of values.

Operation RulesetNewResponseEnvelopeResultRulesSetCacheTagsRuleActionParametersRemoveCacheTagsValuesOperation The operation to perform on the cache tags.

One of the following: const RulesetNewResponseEnvelopeResultRulesSetCacheTagsRuleActionParametersRemoveCacheTagsValuesOperationAdd RulesetNewResponseEnvelopeResultRulesSetCacheTagsRuleActionParametersRemoveCacheTagsValuesOperation = "add" Link to this property const RulesetNewResponseEnvelopeResultRulesSetCacheTagsRuleActionParametersRemoveCacheTagsValuesOperationRemove RulesetNewResponseEnvelopeResultRulesSetCacheTagsRuleActionParametersRemoveCacheTagsValuesOperation = "remove" Link to this property const RulesetNewResponseEnvelopeResultRulesSetCacheTagsRuleActionParametersRemoveCacheTagsValuesOperationSet RulesetNewResponseEnvelopeResultRulesSetCacheTagsRuleActionParametersRemoveCacheTagsValuesOperation = "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 RulesetNewResponseEnvelopeResultRulesSetCacheTagsRuleActionParametersRemoveCacheTagsExpression 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 RulesetNewResponseEnvelopeResultRulesSetCacheTagsRuleActionParametersRemoveCacheTagsExpressionOperation The operation to perform on the cache tags.

One of the following: const RulesetNewResponseEnvelopeResultRulesSetCacheTagsRuleActionParametersRemoveCacheTagsExpressionOperationAdd RulesetNewResponseEnvelopeResultRulesSetCacheTagsRuleActionParametersRemoveCacheTagsExpressionOperation = "add" Link to this property const RulesetNewResponseEnvelopeResultRulesSetCacheTagsRuleActionParametersRemoveCacheTagsExpressionOperationRemove RulesetNewResponseEnvelopeResultRulesSetCacheTagsRuleActionParametersRemoveCacheTagsExpressionOperation = "remove" Link to this property const RulesetNewResponseEnvelopeResultRulesSetCacheTagsRuleActionParametersRemoveCacheTagsExpressionOperationSet RulesetNewResponseEnvelopeResultRulesSetCacheTagsRuleActionParametersRemoveCacheTagsExpressionOperation = "set" Link to this property

Link to this property

type RulesetNewResponseEnvelopeResultRulesSetCacheTagsRuleActionParametersSetCacheTagsValues struct{…} Set cache tags using a list of values.

Operation RulesetNewResponseEnvelopeResultRulesSetCacheTagsRuleActionParametersSetCacheTagsValuesOperation The operation to perform on the cache tags.

One of the following: const RulesetNewResponseEnvelopeResultRulesSetCacheTagsRuleActionParametersSetCacheTagsValuesOperationAdd RulesetNewResponseEnvelopeResultRulesSetCacheTagsRuleActionParametersSetCacheTagsValuesOperation = "add" Link to this property const RulesetNewResponseEnvelopeResultRulesSetCacheTagsRuleActionParametersSetCacheTagsValuesOperationRemove RulesetNewResponseEnvelopeResultRulesSetCacheTagsRuleActionParametersSetCacheTagsValuesOperation = "remove" Link to this property const RulesetNewResponseEnvelopeResultRulesSetCacheTagsRuleActionParametersSetCacheTagsValuesOperationSet RulesetNewResponseEnvelopeResultRulesSetCacheTagsRuleActionParametersSetCacheTagsValuesOperation = "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 RulesetNewResponseEnvelopeResultRulesSetCacheTagsRuleActionParametersSetCacheTagsExpression 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 RulesetNewResponseEnvelopeResultRulesSetCacheTagsRuleActionParametersSetCacheTagsExpressionOperation The operation to perform on the cache tags.

One of the following: const RulesetNewResponseEnvelopeResultRulesSetCacheTagsRuleActionParametersSetCacheTagsExpressionOperationAdd RulesetNewResponseEnvelopeResultRulesSetCacheTagsRuleActionParametersSetCacheTagsExpressionOperation = "add" Link to this property const RulesetNewResponseEnvelopeResultRulesSetCacheTagsRuleActionParametersSetCacheTagsExpressionOperationRemove RulesetNewResponseEnvelopeResultRulesSetCacheTagsRuleActionParametersSetCacheTagsExpressionOperation = "remove" Link to this property const RulesetNewResponseEnvelopeResultRulesSetCacheTagsRuleActionParametersSetCacheTagsExpressionOperationSet RulesetNewResponseEnvelopeResultRulesSetCacheTagsRuleActionParametersSetCacheTagsExpressionOperation = "set" 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 RulesetNewResponseEnvelopeResultRulesSetCacheTagsRuleExposedCredentialCheckOptional Configuration for exposed credential checking.

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 RulesetNewResponseEnvelopeResultRulesSetCacheTagsRuleRatelimitOptional An object configuring the rule’s rate limit behavior.

Link to this property

type RulesetNewResponseEnvelopeResultRulesSetConfigurationRule 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 RulesetNewResponseEnvelopeResultRulesSkipRule 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 RulesetNewResponseEnvelopeResultRulesTransformResponseHTMLRule struct{…}

ID string The unique ID of the rule. Link to this property Action RulesetNewResponseEnvelopeResultRulesTransformResponseHTMLRuleAction 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 RulesetNewResponseEnvelopeResultRulesTransformResponseHTMLRuleActionParametersOptional 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 RulesetNewResponseEnvelopeResultRulesTransformResponseHTMLRuleExposedCredentialCheckOptional Configuration for exposed credential checking.

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 RulesetNewResponseEnvelopeResultRulesTransformResponseHTMLRuleRatelimitOptional An object configuring the rule’s rate limit behavior.

Link to this property

Link to this property Version string The version of the ruleset. Link to this property Description stringOptional An informative description of the ruleset. Link to this property

Link to this property

[Link to this property](<#(resource)%20rulesets%20%3E%20(method)%20create%20%3E%20(network%20schema)%20%3E%20(property)%20result>) ### Create an account or zone 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"), ) ruleset, err := client.Rulesets.New(context.TODO(), rulesets.RulesetNewParams{ }) if err != nil { panic(err.Error()) } fmt.Printf("%+v\n", ruleset) } ``` 200 example ``` { "errors": [ { "message": "something bad happened", "code": 10000, "source": { "pointer": "/rules/0/action" } } ], "messages": [ { "message": "something bad happened", "code": 10000, "source": { "pointer": "/rules/0/action" } } ], "result": { "id": "2f2feab2026849078ba485f918791bdc", "kind": "root", "last_updated": "2000-01-01T00:00:00Z", "name": "My ruleset", "phase": "http_request_firewall_custom", "rules": [ { "last_updated": "2000-01-01T00:00:00Z", "version": "1", "id": "id", "action": "action", "action_parameters": { "response": { "content": "{\n \"success\": false,\n \"error\": \"you have been blocked\"\n}", "content_type": "application/json", "status_code": 400 } }, "categories": [ "directory-traversal" ], "description": "Block the request.", "enabled": true, "exposed_credential_check": { "password_expression": "url_decode(http.request.body.form[\\\"password\\\"][0])", "username_expression": "url_decode(http.request.body.form[\\\"username\\\"][0])" }, "expression": "expression", "logging": { "enabled": true }, "ratelimit": { "characteristics": [ "cf.colo.id" ], "period": 60, "counting_expression": "http.request.body.raw eq \"abcd\"", "mitigation_timeout": 600, "requests_per_period": 1000, "requests_to_origin": true, "score_per_period": 400, "score_response_header_name": "my-score" }, "ref": "ref" } ], "version": "1", "description": "A description for my ruleset." }, "success": true } ``` ##### Returns Examples 200 example ``` { "errors": [ { "message": "something bad happened", "code": 10000, "source": { "pointer": "/rules/0/action" } } ], "messages": [ { "message": "something bad happened", "code": 10000, "source": { "pointer": "/rules/0/action" } } ], "result": { "id": "2f2feab2026849078ba485f918791bdc", "kind": "root", "last_updated": "2000-01-01T00:00:00Z", "name": "My ruleset", "phase": "http_request_firewall_custom", "rules": [ { "last_updated": "2000-01-01T00:00:00Z", "version": "1", "id": "id", "action": "action", "action_parameters": { "response": { "content": "{\n \"success\": false,\n \"error\": \"you have been blocked\"\n}", "content_type": "application/json", "status_code": 400 } }, "categories": [ "directory-traversal" ], "description": "Block the request.", "enabled": true, "exposed_credential_check": { "password_expression": "url_decode(http.request.body.form[\\\"password\\\"][0])", "username_expression": "url_decode(http.request.body.form[\\\"username\\\"][0])" }, "expression": "expression", "logging": { "enabled": true }, "ratelimit": { "characteristics": [ "cf.colo.id" ], "period": 60, "counting_expression": "http.request.body.raw eq \"abcd\"", "mitigation_timeout": 600, "requests_per_period": 1000, "requests_to_origin": true, "score_per_period": 400, "score_response_header_name": "my-score" }, "ref": "ref" } ], "version": "1", "description": "A description for my ruleset." }, "success": true } ```