--- title: Create an account or zone ruleset rule --- [Skip to content](#_top) [API Reference](https://developers.cloudflare.com/api/go) [Rulesets](https://developers.cloudflare.com/api/go/resources/rulesets) [Rules](https://developers.cloudflare.com/api/go/resources/rulesets/subresources/rules) Copy Markdown Open in **Claude**Open in **ChatGPT**Open in **Cursor** --- **Copy Markdown****View as Markdown** # Create an account or zone ruleset rule client.Rulesets.Rules.New(ctx, rulesetID, params) (\*RuleNewResponseEnvelopeResult, error) POST/{accounts\_or\_zones}/{account\_or\_zone\_id}/rulesets/{ruleset\_id}/rules Adds a new rule to an account or zone ruleset. The rule will be added to the end of the existing list of rules in the ruleset by default. ##### Security

API Token

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

API Email + API Key

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

##### Accepted Permissions (at least one required) `Mass URL Redirects Write``Magic Firewall Write``L4 DDoS Managed Ruleset Write``Transform Rules Write``Select Configuration Write``Account WAF Write``Account Rulesets Write``Logs Write` ##### ParametersExpand Collapse rulesetID string The unique ID of the ruleset. [Link to this property](<#(resource)%20rulesets.rules%20%3E%20(method)%20create%20%3E%20(params)%20default%20%3E%20(param)%20ruleset_id%20%3E%20(schema)>)

params RuleNewParams

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 ID param.Field\[string]Optional Body param: The unique ID of the rule. Link to this property

Action param.Field\[RuleNewParamsBlockRuleAction]Optional Body param: The action to perform when the rule matches.

const RuleNewParamsBlockRuleActionBlock RuleNewParamsBlockRuleAction = "block" Link to this property

Link to this property

ActionParameters param.Field\[RuleNewParamsBlockRuleActionParameters]Optional Body param: The parameters configuring the rule’s action.

Response RuleNewParamsBlockRuleActionParametersResponseOptional 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 Description param.Field\[string]Optional Body param: An informative description of the rule. Link to this property Enabled param.Field\[bool]Optional Body param: Whether the rule should be executed. Link to this property

ExposedCredentialCheck param.Field\[RuleNewParamsBlockRuleExposedCredentialCheck]Optional Body param: 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 param.Field\[string]Optional Body param: The expression defining which traffic will match the rule. minLength1 Link to this property Logging param.Field\[Logging]Optional Body param: An object configuring the rule’s logging behavior. Link to this property

Position param.Field\[RuleNewParamsBlockRulePosition]Optional Body param: An object configuring where the rule will be placed.

RuleNewParamsBlockRulePositionBeforePosition

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

Link to this property

RuleNewParamsBlockRulePositionAfterPosition

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

Link to this property

RuleNewParamsBlockRulePositionIndexPosition

Index int64Optional An index at which to place the rule, where index 1 is the first rule. minimum1 Link to this property

Link to this property

Ratelimit param.Field\[RuleNewParamsBlockRuleRatelimit]Optional Body param: 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 param.Field\[string]Optional Body param: The reference of the rule (the rule’s ID by default). minLength1 Link to this property

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

type RuleNewResponseEnvelopeResult interface{…} A result.

One of the following:

type RuleNewResponseEnvelopeResult struct{…} A ruleset object.

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

Kind Kind The kind of the ruleset.

One of the following: const KindManaged Kind = "managed" Link to this property const KindCustom Kind = "custom" Link to this property const KindRoot Kind = "root" Link to this property const KindZone Kind = "zone" Link to this property

Link to this property LastUpdated Time The timestamp of when the ruleset was last modified. formatdate-time Link to this property Name string The human-readable name of the ruleset. minLength1 Link to this property

Phase Phase The phase of the ruleset.

One of the following: const PhaseDDoSL4 Phase = "ddos\_l4" Link to this property const PhaseDDoSL7 Phase = "ddos\_l7" Link to this property const PhaseHTTPConfigSettings Phase = "http\_config\_settings" Link to this property const PhaseHTTPCustomErrors Phase = "http\_custom\_errors" Link to this property const PhaseHTTPLogCustomFields Phase = "http\_log\_custom\_fields" Link to this property const PhaseHTTPRatelimit Phase = "http\_ratelimit" Link to this property const PhaseHTTPRequestCacheSettings Phase = "http\_request\_cache\_settings" Link to this property const PhaseHTTPRequestDynamicRedirect Phase = "http\_request\_dynamic\_redirect" Link to this property const PhaseHTTPRequestFirewallCustom Phase = "http\_request\_firewall\_custom" Link to this property const PhaseHTTPRequestFirewallManaged Phase = "http\_request\_firewall\_managed" Link to this property const PhaseHTTPRequestLateTransform Phase = "http\_request\_late\_transform" Link to this property const PhaseHTTPRequestOrigin Phase = "http\_request\_origin" Link to this property const PhaseHTTPRequestRedirect Phase = "http\_request\_redirect" Link to this property const PhaseHTTPRequestSanitize Phase = "http\_request\_sanitize" Link to this property const PhaseHTTPRequestSBFM Phase = "http\_request\_sbfm" Link to this property const PhaseHTTPRequestTransform Phase = "http\_request\_transform" Link to this property const PhaseHTTPResponseCacheSettings Phase = "http\_response\_cache\_settings" Link to this property const PhaseHTTPResponseCompression Phase = "http\_response\_compression" Link to this property const PhaseHTTPResponseFirewallManaged Phase = "http\_response\_firewall\_managed" Link to this property const PhaseHTTPResponseHeadersTransform Phase = "http\_response\_headers\_transform" Link to this property const PhaseMagicTransit Phase = "magic\_transit" Link to this property const PhaseMagicTransitIDsManaged Phase = "magic\_transit\_ids\_managed" Link to this property const PhaseMagicTransitManaged Phase = "magic\_transit\_managed" Link to this property const PhaseMagicTransitRatelimit Phase = "magic\_transit\_ratelimit" Link to this property

Link to this property

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

One of the following:

type RuleNewResponseEnvelopeResultRulesBlockRule 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 RuleNewResponseEnvelopeResultRulesChallengeRule struct{…}

ID string The unique ID of the rule. Link to this property Action RuleNewResponseEnvelopeResultRulesChallengeRuleAction 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 RuleNewResponseEnvelopeResultRulesChallengeRuleExposedCredentialCheckOptional 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 RuleNewResponseEnvelopeResultRulesChallengeRuleRatelimitOptional An object configuring the rule’s rate limit behavior.

Link to this property

type RuleNewResponseEnvelopeResultRulesResponseCompressionRule 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 RuleNewResponseEnvelopeResultRulesDDoSDynamicRule 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 RuleNewResponseEnvelopeResultRulesExecuteRule 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 RuleNewResponseEnvelopeResultRulesForceConnectionCloseRule 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 RuleNewResponseEnvelopeResultRulesJavaScriptChallengeRule struct{…}

ID string The unique ID of the rule. Link to this property Action RuleNewResponseEnvelopeResultRulesJavaScriptChallengeRuleAction 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 RuleNewResponseEnvelopeResultRulesJavaScriptChallengeRuleExposedCredentialCheckOptional 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 RuleNewResponseEnvelopeResultRulesJavaScriptChallengeRuleRatelimitOptional An object configuring the rule’s rate limit behavior.

Link to this property

type RuleNewResponseEnvelopeResultRulesLogRule 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 RuleNewResponseEnvelopeResultRulesLogCustomFieldRule 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 RuleNewResponseEnvelopeResultRulesManagedChallengeRule 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 RuleNewResponseEnvelopeResultRulesRedirectRule 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 RuleNewResponseEnvelopeResultRulesRewriteRule 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 RuleNewResponseEnvelopeResultRulesRouteRule 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 RuleNewResponseEnvelopeResultRulesScoreRule 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 RuleNewResponseEnvelopeResultRulesServeErrorRule 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 RuleNewResponseEnvelopeResultRulesSetCacheControlRule struct{…}

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

Immutable RuleNewResponseEnvelopeResultRulesSetCacheControlRuleActionParametersImmutableOptional A cache-control directive configuration.

One of the following:

type RuleNewResponseEnvelopeResultRulesSetCacheControlRuleActionParametersImmutableSetDirective struct{…} Set the directive.

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

One of the following: const RuleNewResponseEnvelopeResultRulesSetCacheControlRuleActionParametersImmutableSetDirectiveOperationSet RuleNewResponseEnvelopeResultRulesSetCacheControlRuleActionParametersImmutableSetDirectiveOperation = "set" Link to this property const RuleNewResponseEnvelopeResultRulesSetCacheControlRuleActionParametersImmutableSetDirectiveOperationRemove RuleNewResponseEnvelopeResultRulesSetCacheControlRuleActionParametersImmutableSetDirectiveOperation = "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 RuleNewResponseEnvelopeResultRulesSetCacheControlRuleActionParametersImmutableRemoveDirective struct{…} Remove the directive.

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

One of the following: const RuleNewResponseEnvelopeResultRulesSetCacheControlRuleActionParametersImmutableRemoveDirectiveOperationSet RuleNewResponseEnvelopeResultRulesSetCacheControlRuleActionParametersImmutableRemoveDirectiveOperation = "set" Link to this property const RuleNewResponseEnvelopeResultRulesSetCacheControlRuleActionParametersImmutableRemoveDirectiveOperationRemove RuleNewResponseEnvelopeResultRulesSetCacheControlRuleActionParametersImmutableRemoveDirectiveOperation = "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 RuleNewResponseEnvelopeResultRulesSetCacheControlRuleActionParametersMaxAgeOptional A cache-control directive configuration that accepts a duration value in seconds.

One of the following:

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

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

One of the following: const RuleNewResponseEnvelopeResultRulesSetCacheControlRuleActionParametersMaxAgeSetDirectiveOperationSet RuleNewResponseEnvelopeResultRulesSetCacheControlRuleActionParametersMaxAgeSetDirectiveOperation = "set" Link to this property const RuleNewResponseEnvelopeResultRulesSetCacheControlRuleActionParametersMaxAgeSetDirectiveOperationRemove RuleNewResponseEnvelopeResultRulesSetCacheControlRuleActionParametersMaxAgeSetDirectiveOperation = "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 RuleNewResponseEnvelopeResultRulesSetCacheControlRuleActionParametersMaxAgeRemoveDirective struct{…} Remove the directive.

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

One of the following: const RuleNewResponseEnvelopeResultRulesSetCacheControlRuleActionParametersMaxAgeRemoveDirectiveOperationSet RuleNewResponseEnvelopeResultRulesSetCacheControlRuleActionParametersMaxAgeRemoveDirectiveOperation = "set" Link to this property const RuleNewResponseEnvelopeResultRulesSetCacheControlRuleActionParametersMaxAgeRemoveDirectiveOperationRemove RuleNewResponseEnvelopeResultRulesSetCacheControlRuleActionParametersMaxAgeRemoveDirectiveOperation = "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 RuleNewResponseEnvelopeResultRulesSetCacheControlRuleActionParametersMustRevalidateOptional A cache-control directive configuration.

One of the following:

type RuleNewResponseEnvelopeResultRulesSetCacheControlRuleActionParametersMustRevalidateSetDirective struct{…} Set the directive.

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

One of the following: const RuleNewResponseEnvelopeResultRulesSetCacheControlRuleActionParametersMustRevalidateSetDirectiveOperationSet RuleNewResponseEnvelopeResultRulesSetCacheControlRuleActionParametersMustRevalidateSetDirectiveOperation = "set" Link to this property const RuleNewResponseEnvelopeResultRulesSetCacheControlRuleActionParametersMustRevalidateSetDirectiveOperationRemove RuleNewResponseEnvelopeResultRulesSetCacheControlRuleActionParametersMustRevalidateSetDirectiveOperation = "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 RuleNewResponseEnvelopeResultRulesSetCacheControlRuleActionParametersMustRevalidateRemoveDirective struct{…} Remove the directive.

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

One of the following: const RuleNewResponseEnvelopeResultRulesSetCacheControlRuleActionParametersMustRevalidateRemoveDirectiveOperationSet RuleNewResponseEnvelopeResultRulesSetCacheControlRuleActionParametersMustRevalidateRemoveDirectiveOperation = "set" Link to this property const RuleNewResponseEnvelopeResultRulesSetCacheControlRuleActionParametersMustRevalidateRemoveDirectiveOperationRemove RuleNewResponseEnvelopeResultRulesSetCacheControlRuleActionParametersMustRevalidateRemoveDirectiveOperation = "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 RuleNewResponseEnvelopeResultRulesSetCacheControlRuleActionParametersMustUnderstandOptional A cache-control directive configuration.

One of the following:

type RuleNewResponseEnvelopeResultRulesSetCacheControlRuleActionParametersMustUnderstandSetDirective struct{…} Set the directive.

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

One of the following: const RuleNewResponseEnvelopeResultRulesSetCacheControlRuleActionParametersMustUnderstandSetDirectiveOperationSet RuleNewResponseEnvelopeResultRulesSetCacheControlRuleActionParametersMustUnderstandSetDirectiveOperation = "set" Link to this property const RuleNewResponseEnvelopeResultRulesSetCacheControlRuleActionParametersMustUnderstandSetDirectiveOperationRemove RuleNewResponseEnvelopeResultRulesSetCacheControlRuleActionParametersMustUnderstandSetDirectiveOperation = "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 RuleNewResponseEnvelopeResultRulesSetCacheControlRuleActionParametersMustUnderstandRemoveDirective struct{…} Remove the directive.

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

One of the following: const RuleNewResponseEnvelopeResultRulesSetCacheControlRuleActionParametersMustUnderstandRemoveDirectiveOperationSet RuleNewResponseEnvelopeResultRulesSetCacheControlRuleActionParametersMustUnderstandRemoveDirectiveOperation = "set" Link to this property const RuleNewResponseEnvelopeResultRulesSetCacheControlRuleActionParametersMustUnderstandRemoveDirectiveOperationRemove RuleNewResponseEnvelopeResultRulesSetCacheControlRuleActionParametersMustUnderstandRemoveDirectiveOperation = "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 RuleNewResponseEnvelopeResultRulesSetCacheControlRuleActionParametersNoCacheOptional A cache-control directive configuration that accepts optional qualifiers (header names).

One of the following:

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

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

One of the following: const RuleNewResponseEnvelopeResultRulesSetCacheControlRuleActionParametersNoCacheSetDirectiveOperationSet RuleNewResponseEnvelopeResultRulesSetCacheControlRuleActionParametersNoCacheSetDirectiveOperation = "set" Link to this property const RuleNewResponseEnvelopeResultRulesSetCacheControlRuleActionParametersNoCacheSetDirectiveOperationRemove RuleNewResponseEnvelopeResultRulesSetCacheControlRuleActionParametersNoCacheSetDirectiveOperation = "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 RuleNewResponseEnvelopeResultRulesSetCacheControlRuleActionParametersNoCacheRemoveDirective struct{…} Remove the directive.

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

One of the following: const RuleNewResponseEnvelopeResultRulesSetCacheControlRuleActionParametersNoCacheRemoveDirectiveOperationSet RuleNewResponseEnvelopeResultRulesSetCacheControlRuleActionParametersNoCacheRemoveDirectiveOperation = "set" Link to this property const RuleNewResponseEnvelopeResultRulesSetCacheControlRuleActionParametersNoCacheRemoveDirectiveOperationRemove RuleNewResponseEnvelopeResultRulesSetCacheControlRuleActionParametersNoCacheRemoveDirectiveOperation = "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 RuleNewResponseEnvelopeResultRulesSetCacheControlRuleActionParametersNoStoreOptional A cache-control directive configuration.

One of the following:

type RuleNewResponseEnvelopeResultRulesSetCacheControlRuleActionParametersNoStoreSetDirective struct{…} Set the directive.

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

One of the following: const RuleNewResponseEnvelopeResultRulesSetCacheControlRuleActionParametersNoStoreSetDirectiveOperationSet RuleNewResponseEnvelopeResultRulesSetCacheControlRuleActionParametersNoStoreSetDirectiveOperation = "set" Link to this property const RuleNewResponseEnvelopeResultRulesSetCacheControlRuleActionParametersNoStoreSetDirectiveOperationRemove RuleNewResponseEnvelopeResultRulesSetCacheControlRuleActionParametersNoStoreSetDirectiveOperation = "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 RuleNewResponseEnvelopeResultRulesSetCacheControlRuleActionParametersNoStoreRemoveDirective struct{…} Remove the directive.

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

One of the following: const RuleNewResponseEnvelopeResultRulesSetCacheControlRuleActionParametersNoStoreRemoveDirectiveOperationSet RuleNewResponseEnvelopeResultRulesSetCacheControlRuleActionParametersNoStoreRemoveDirectiveOperation = "set" Link to this property const RuleNewResponseEnvelopeResultRulesSetCacheControlRuleActionParametersNoStoreRemoveDirectiveOperationRemove RuleNewResponseEnvelopeResultRulesSetCacheControlRuleActionParametersNoStoreRemoveDirectiveOperation = "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 RuleNewResponseEnvelopeResultRulesSetCacheControlRuleActionParametersNoTransformOptional A cache-control directive configuration.

One of the following:

type RuleNewResponseEnvelopeResultRulesSetCacheControlRuleActionParametersNoTransformSetDirective struct{…} Set the directive.

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

One of the following: const RuleNewResponseEnvelopeResultRulesSetCacheControlRuleActionParametersNoTransformSetDirectiveOperationSet RuleNewResponseEnvelopeResultRulesSetCacheControlRuleActionParametersNoTransformSetDirectiveOperation = "set" Link to this property const RuleNewResponseEnvelopeResultRulesSetCacheControlRuleActionParametersNoTransformSetDirectiveOperationRemove RuleNewResponseEnvelopeResultRulesSetCacheControlRuleActionParametersNoTransformSetDirectiveOperation = "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 RuleNewResponseEnvelopeResultRulesSetCacheControlRuleActionParametersNoTransformRemoveDirective struct{…} Remove the directive.

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

One of the following: const RuleNewResponseEnvelopeResultRulesSetCacheControlRuleActionParametersNoTransformRemoveDirectiveOperationSet RuleNewResponseEnvelopeResultRulesSetCacheControlRuleActionParametersNoTransformRemoveDirectiveOperation = "set" Link to this property const RuleNewResponseEnvelopeResultRulesSetCacheControlRuleActionParametersNoTransformRemoveDirectiveOperationRemove RuleNewResponseEnvelopeResultRulesSetCacheControlRuleActionParametersNoTransformRemoveDirectiveOperation = "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 RuleNewResponseEnvelopeResultRulesSetCacheControlRuleActionParametersPrivateOptional A cache-control directive configuration that accepts optional qualifiers (header names).

One of the following:

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

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

One of the following: const RuleNewResponseEnvelopeResultRulesSetCacheControlRuleActionParametersPrivateSetDirectiveOperationSet RuleNewResponseEnvelopeResultRulesSetCacheControlRuleActionParametersPrivateSetDirectiveOperation = "set" Link to this property const RuleNewResponseEnvelopeResultRulesSetCacheControlRuleActionParametersPrivateSetDirectiveOperationRemove RuleNewResponseEnvelopeResultRulesSetCacheControlRuleActionParametersPrivateSetDirectiveOperation = "remove" Link to this property

Link to this property

type RuleNewResponseEnvelopeResultRulesSetCacheControlRuleActionParametersPrivateRemoveDirective struct{…} Remove the directive.

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

One of the following: const RuleNewResponseEnvelopeResultRulesSetCacheControlRuleActionParametersPrivateRemoveDirectiveOperationSet RuleNewResponseEnvelopeResultRulesSetCacheControlRuleActionParametersPrivateRemoveDirectiveOperation = "set" Link to this property const RuleNewResponseEnvelopeResultRulesSetCacheControlRuleActionParametersPrivateRemoveDirectiveOperationRemove RuleNewResponseEnvelopeResultRulesSetCacheControlRuleActionParametersPrivateRemoveDirectiveOperation = "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 RuleNewResponseEnvelopeResultRulesSetCacheControlRuleActionParametersProxyRevalidateOptional A cache-control directive configuration.

One of the following:

type RuleNewResponseEnvelopeResultRulesSetCacheControlRuleActionParametersProxyRevalidateSetDirective struct{…} Set the directive.

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

One of the following: const RuleNewResponseEnvelopeResultRulesSetCacheControlRuleActionParametersProxyRevalidateSetDirectiveOperationSet RuleNewResponseEnvelopeResultRulesSetCacheControlRuleActionParametersProxyRevalidateSetDirectiveOperation = "set" Link to this property const RuleNewResponseEnvelopeResultRulesSetCacheControlRuleActionParametersProxyRevalidateSetDirectiveOperationRemove RuleNewResponseEnvelopeResultRulesSetCacheControlRuleActionParametersProxyRevalidateSetDirectiveOperation = "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 RuleNewResponseEnvelopeResultRulesSetCacheControlRuleActionParametersProxyRevalidateRemoveDirective struct{…} Remove the directive.

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

One of the following: const RuleNewResponseEnvelopeResultRulesSetCacheControlRuleActionParametersProxyRevalidateRemoveDirectiveOperationSet RuleNewResponseEnvelopeResultRulesSetCacheControlRuleActionParametersProxyRevalidateRemoveDirectiveOperation = "set" Link to this property const RuleNewResponseEnvelopeResultRulesSetCacheControlRuleActionParametersProxyRevalidateRemoveDirectiveOperationRemove RuleNewResponseEnvelopeResultRulesSetCacheControlRuleActionParametersProxyRevalidateRemoveDirectiveOperation = "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 RuleNewResponseEnvelopeResultRulesSetCacheControlRuleActionParametersPublicOptional A cache-control directive configuration.

One of the following:

type RuleNewResponseEnvelopeResultRulesSetCacheControlRuleActionParametersPublicSetDirective struct{…} Set the directive.

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

One of the following: const RuleNewResponseEnvelopeResultRulesSetCacheControlRuleActionParametersPublicSetDirectiveOperationSet RuleNewResponseEnvelopeResultRulesSetCacheControlRuleActionParametersPublicSetDirectiveOperation = "set" Link to this property const RuleNewResponseEnvelopeResultRulesSetCacheControlRuleActionParametersPublicSetDirectiveOperationRemove RuleNewResponseEnvelopeResultRulesSetCacheControlRuleActionParametersPublicSetDirectiveOperation = "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 RuleNewResponseEnvelopeResultRulesSetCacheControlRuleActionParametersPublicRemoveDirective struct{…} Remove the directive.

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

One of the following: const RuleNewResponseEnvelopeResultRulesSetCacheControlRuleActionParametersPublicRemoveDirectiveOperationSet RuleNewResponseEnvelopeResultRulesSetCacheControlRuleActionParametersPublicRemoveDirectiveOperation = "set" Link to this property const RuleNewResponseEnvelopeResultRulesSetCacheControlRuleActionParametersPublicRemoveDirectiveOperationRemove RuleNewResponseEnvelopeResultRulesSetCacheControlRuleActionParametersPublicRemoveDirectiveOperation = "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 RuleNewResponseEnvelopeResultRulesSetCacheControlRuleActionParametersSMaxageOptional A cache-control directive configuration that accepts a duration value in seconds.

One of the following:

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

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

One of the following: const RuleNewResponseEnvelopeResultRulesSetCacheControlRuleActionParametersSMaxageSetDirectiveOperationSet RuleNewResponseEnvelopeResultRulesSetCacheControlRuleActionParametersSMaxageSetDirectiveOperation = "set" Link to this property const RuleNewResponseEnvelopeResultRulesSetCacheControlRuleActionParametersSMaxageSetDirectiveOperationRemove RuleNewResponseEnvelopeResultRulesSetCacheControlRuleActionParametersSMaxageSetDirectiveOperation = "remove" Link to this property

Link to this property

type RuleNewResponseEnvelopeResultRulesSetCacheControlRuleActionParametersSMaxageRemoveDirective struct{…} Remove the directive.

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

One of the following: const RuleNewResponseEnvelopeResultRulesSetCacheControlRuleActionParametersSMaxageRemoveDirectiveOperationSet RuleNewResponseEnvelopeResultRulesSetCacheControlRuleActionParametersSMaxageRemoveDirectiveOperation = "set" Link to this property const RuleNewResponseEnvelopeResultRulesSetCacheControlRuleActionParametersSMaxageRemoveDirectiveOperationRemove RuleNewResponseEnvelopeResultRulesSetCacheControlRuleActionParametersSMaxageRemoveDirectiveOperation = "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 RuleNewResponseEnvelopeResultRulesSetCacheControlRuleActionParametersStaleIfErrorOptional A cache-control directive configuration that accepts a duration value in seconds.

One of the following:

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

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

One of the following: const RuleNewResponseEnvelopeResultRulesSetCacheControlRuleActionParametersStaleIfErrorSetDirectiveOperationSet RuleNewResponseEnvelopeResultRulesSetCacheControlRuleActionParametersStaleIfErrorSetDirectiveOperation = "set" Link to this property const RuleNewResponseEnvelopeResultRulesSetCacheControlRuleActionParametersStaleIfErrorSetDirectiveOperationRemove RuleNewResponseEnvelopeResultRulesSetCacheControlRuleActionParametersStaleIfErrorSetDirectiveOperation = "remove" Link to this property

Link to this property

type RuleNewResponseEnvelopeResultRulesSetCacheControlRuleActionParametersStaleIfErrorRemoveDirective struct{…} Remove the directive.

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

One of the following: const RuleNewResponseEnvelopeResultRulesSetCacheControlRuleActionParametersStaleIfErrorRemoveDirectiveOperationSet RuleNewResponseEnvelopeResultRulesSetCacheControlRuleActionParametersStaleIfErrorRemoveDirectiveOperation = "set" Link to this property const RuleNewResponseEnvelopeResultRulesSetCacheControlRuleActionParametersStaleIfErrorRemoveDirectiveOperationRemove RuleNewResponseEnvelopeResultRulesSetCacheControlRuleActionParametersStaleIfErrorRemoveDirectiveOperation = "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 RuleNewResponseEnvelopeResultRulesSetCacheControlRuleActionParametersStaleWhileRevalidateOptional A cache-control directive configuration that accepts a duration value in seconds.

One of the following:

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

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

One of the following: const RuleNewResponseEnvelopeResultRulesSetCacheControlRuleActionParametersStaleWhileRevalidateSetDirectiveOperationSet RuleNewResponseEnvelopeResultRulesSetCacheControlRuleActionParametersStaleWhileRevalidateSetDirectiveOperation = "set" Link to this property const RuleNewResponseEnvelopeResultRulesSetCacheControlRuleActionParametersStaleWhileRevalidateSetDirectiveOperationRemove RuleNewResponseEnvelopeResultRulesSetCacheControlRuleActionParametersStaleWhileRevalidateSetDirectiveOperation = "remove" Link to this property

Link to this property

type RuleNewResponseEnvelopeResultRulesSetCacheControlRuleActionParametersStaleWhileRevalidateRemoveDirective struct{…} Remove the directive.

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

One of the following: const RuleNewResponseEnvelopeResultRulesSetCacheControlRuleActionParametersStaleWhileRevalidateRemoveDirectiveOperationSet RuleNewResponseEnvelopeResultRulesSetCacheControlRuleActionParametersStaleWhileRevalidateRemoveDirectiveOperation = "set" Link to this property const RuleNewResponseEnvelopeResultRulesSetCacheControlRuleActionParametersStaleWhileRevalidateRemoveDirectiveOperationRemove RuleNewResponseEnvelopeResultRulesSetCacheControlRuleActionParametersStaleWhileRevalidateRemoveDirectiveOperation = "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 RuleNewResponseEnvelopeResultRulesSetCacheControlRuleExposedCredentialCheckOptional 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 RuleNewResponseEnvelopeResultRulesSetCacheControlRuleRatelimitOptional An object configuring the rule’s rate limit behavior.

Link to this property

type RuleNewResponseEnvelopeResultRulesSetCacheSettingsRule 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 RuleNewResponseEnvelopeResultRulesSetCacheTagsRule struct{…}

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

One of the following:

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

Operation RuleNewResponseEnvelopeResultRulesSetCacheTagsRuleActionParametersAddCacheTagsValuesOperation The operation to perform on the cache tags.

One of the following: const RuleNewResponseEnvelopeResultRulesSetCacheTagsRuleActionParametersAddCacheTagsValuesOperationAdd RuleNewResponseEnvelopeResultRulesSetCacheTagsRuleActionParametersAddCacheTagsValuesOperation = "add" Link to this property const RuleNewResponseEnvelopeResultRulesSetCacheTagsRuleActionParametersAddCacheTagsValuesOperationRemove RuleNewResponseEnvelopeResultRulesSetCacheTagsRuleActionParametersAddCacheTagsValuesOperation = "remove" Link to this property const RuleNewResponseEnvelopeResultRulesSetCacheTagsRuleActionParametersAddCacheTagsValuesOperationSet RuleNewResponseEnvelopeResultRulesSetCacheTagsRuleActionParametersAddCacheTagsValuesOperation = "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 RuleNewResponseEnvelopeResultRulesSetCacheTagsRuleActionParametersAddCacheTagsExpression 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 RuleNewResponseEnvelopeResultRulesSetCacheTagsRuleActionParametersAddCacheTagsExpressionOperation The operation to perform on the cache tags.

One of the following: const RuleNewResponseEnvelopeResultRulesSetCacheTagsRuleActionParametersAddCacheTagsExpressionOperationAdd RuleNewResponseEnvelopeResultRulesSetCacheTagsRuleActionParametersAddCacheTagsExpressionOperation = "add" Link to this property const RuleNewResponseEnvelopeResultRulesSetCacheTagsRuleActionParametersAddCacheTagsExpressionOperationRemove RuleNewResponseEnvelopeResultRulesSetCacheTagsRuleActionParametersAddCacheTagsExpressionOperation = "remove" Link to this property const RuleNewResponseEnvelopeResultRulesSetCacheTagsRuleActionParametersAddCacheTagsExpressionOperationSet RuleNewResponseEnvelopeResultRulesSetCacheTagsRuleActionParametersAddCacheTagsExpressionOperation = "set" Link to this property

Link to this property

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

Operation RuleNewResponseEnvelopeResultRulesSetCacheTagsRuleActionParametersRemoveCacheTagsValuesOperation The operation to perform on the cache tags.

One of the following: const RuleNewResponseEnvelopeResultRulesSetCacheTagsRuleActionParametersRemoveCacheTagsValuesOperationAdd RuleNewResponseEnvelopeResultRulesSetCacheTagsRuleActionParametersRemoveCacheTagsValuesOperation = "add" Link to this property const RuleNewResponseEnvelopeResultRulesSetCacheTagsRuleActionParametersRemoveCacheTagsValuesOperationRemove RuleNewResponseEnvelopeResultRulesSetCacheTagsRuleActionParametersRemoveCacheTagsValuesOperation = "remove" Link to this property const RuleNewResponseEnvelopeResultRulesSetCacheTagsRuleActionParametersRemoveCacheTagsValuesOperationSet RuleNewResponseEnvelopeResultRulesSetCacheTagsRuleActionParametersRemoveCacheTagsValuesOperation = "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 RuleNewResponseEnvelopeResultRulesSetCacheTagsRuleActionParametersRemoveCacheTagsExpression 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 RuleNewResponseEnvelopeResultRulesSetCacheTagsRuleActionParametersRemoveCacheTagsExpressionOperation The operation to perform on the cache tags.

One of the following: const RuleNewResponseEnvelopeResultRulesSetCacheTagsRuleActionParametersRemoveCacheTagsExpressionOperationAdd RuleNewResponseEnvelopeResultRulesSetCacheTagsRuleActionParametersRemoveCacheTagsExpressionOperation = "add" Link to this property const RuleNewResponseEnvelopeResultRulesSetCacheTagsRuleActionParametersRemoveCacheTagsExpressionOperationRemove RuleNewResponseEnvelopeResultRulesSetCacheTagsRuleActionParametersRemoveCacheTagsExpressionOperation = "remove" Link to this property const RuleNewResponseEnvelopeResultRulesSetCacheTagsRuleActionParametersRemoveCacheTagsExpressionOperationSet RuleNewResponseEnvelopeResultRulesSetCacheTagsRuleActionParametersRemoveCacheTagsExpressionOperation = "set" Link to this property

Link to this property

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

Operation RuleNewResponseEnvelopeResultRulesSetCacheTagsRuleActionParametersSetCacheTagsValuesOperation The operation to perform on the cache tags.

One of the following: const RuleNewResponseEnvelopeResultRulesSetCacheTagsRuleActionParametersSetCacheTagsValuesOperationAdd RuleNewResponseEnvelopeResultRulesSetCacheTagsRuleActionParametersSetCacheTagsValuesOperation = "add" Link to this property const RuleNewResponseEnvelopeResultRulesSetCacheTagsRuleActionParametersSetCacheTagsValuesOperationRemove RuleNewResponseEnvelopeResultRulesSetCacheTagsRuleActionParametersSetCacheTagsValuesOperation = "remove" Link to this property const RuleNewResponseEnvelopeResultRulesSetCacheTagsRuleActionParametersSetCacheTagsValuesOperationSet RuleNewResponseEnvelopeResultRulesSetCacheTagsRuleActionParametersSetCacheTagsValuesOperation = "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 RuleNewResponseEnvelopeResultRulesSetCacheTagsRuleActionParametersSetCacheTagsExpression 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 RuleNewResponseEnvelopeResultRulesSetCacheTagsRuleActionParametersSetCacheTagsExpressionOperation The operation to perform on the cache tags.

One of the following: const RuleNewResponseEnvelopeResultRulesSetCacheTagsRuleActionParametersSetCacheTagsExpressionOperationAdd RuleNewResponseEnvelopeResultRulesSetCacheTagsRuleActionParametersSetCacheTagsExpressionOperation = "add" Link to this property const RuleNewResponseEnvelopeResultRulesSetCacheTagsRuleActionParametersSetCacheTagsExpressionOperationRemove RuleNewResponseEnvelopeResultRulesSetCacheTagsRuleActionParametersSetCacheTagsExpressionOperation = "remove" Link to this property const RuleNewResponseEnvelopeResultRulesSetCacheTagsRuleActionParametersSetCacheTagsExpressionOperationSet RuleNewResponseEnvelopeResultRulesSetCacheTagsRuleActionParametersSetCacheTagsExpressionOperation = "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 RuleNewResponseEnvelopeResultRulesSetCacheTagsRuleExposedCredentialCheckOptional 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 RuleNewResponseEnvelopeResultRulesSetCacheTagsRuleRatelimitOptional An object configuring the rule’s rate limit behavior.

Link to this property

type RuleNewResponseEnvelopeResultRulesSetConfigurationRule 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 RuleNewResponseEnvelopeResultRulesSkipRule 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 RuleNewResponseEnvelopeResultRulesTransformResponseHTMLRule struct{…}

ID string The unique ID of the rule. Link to this property Action RuleNewResponseEnvelopeResultRulesTransformResponseHTMLRuleAction 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 RuleNewResponseEnvelopeResultRulesTransformResponseHTMLRuleActionParametersOptional 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 RuleNewResponseEnvelopeResultRulesTransformResponseHTMLRuleExposedCredentialCheckOptional 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 RuleNewResponseEnvelopeResultRulesTransformResponseHTMLRuleRatelimitOptional 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.rules%20%3E%20(method)%20create%20%3E%20(network%20schema)%20%3E%20(property)%20result>) ### Create an account or zone ruleset rule 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"), ) rule, err := client.Rulesets.Rules.New( context.TODO(), "2f2feab2026849078ba485f918791bdc", rulesets.RuleNewParams{ Body: rulesets.RuleNewParamsBodyBlockRule(rulesets.RuleNewParamsBodyBlockRule{ BlockRuleParam: rulesets.BlockRuleParam{ }, }), }, ) if err != nil { panic(err.Error()) } fmt.Printf("%+v\n", rule) } ``` 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 } ```