---
title: Delete 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**
# Delete an account or zone ruleset rule
client.Rulesets.Rules.Delete(ctx, rulesetID, ruleID, params) (\*RuleDeleteResponseEnvelopeResult, error)
DELETE/{accounts\_or\_zones}/{account\_or\_zone\_id}/rulesets/{ruleset\_id}/rules/{rule\_id}
Deletes an existing rule from an account or zone 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
rulesetID string
The unique ID of the ruleset.
[Link to this property](<#(resource)%20rulesets.rules%20%3E%20(method)%20delete%20%3E%20(params)%20default%20%3E%20(param)%20ruleset_id%20%3E%20(schema)>)
ruleID string
The unique ID of the rule.
[Link to this property](<#(resource)%20rulesets.rules%20%3E%20(method)%20delete%20%3E%20(params)%20default%20%3E%20(param)%20rule_id%20%3E%20(schema)>)
params RuleDeleteParams
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
[Link to this property](<#(resource)%20rulesets.rules%20%3E%20(method)%20delete%20%3E%20(params)%20default>)
##### ReturnsExpand Collapse
type RuleDeleteResponseEnvelopeResult interface{…}
A result.
One of the following:
type RuleDeleteResponseEnvelopeResult 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 \[]RuleDeleteResponseEnvelopeResultRules
The list of rules in the ruleset.
One of the following:
type RuleDeleteResponseEnvelopeResultRulesBlockRule 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 RuleDeleteResponseEnvelopeResultRulesChallengeRule struct{…}
ID string
The unique ID of the rule.
Link to this property
Action RuleDeleteResponseEnvelopeResultRulesChallengeRuleAction
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 RuleDeleteResponseEnvelopeResultRulesChallengeRuleExposedCredentialCheckOptional
Configuration for exposed credential checking.
PasswordExpression string
An expression that selects the password used in the credentials check.
minLength1
Link to this property
UsernameExpression string
An expression that selects the user ID used in the credentials check.
minLength1
Link to this property
Link to this property
Logging LoggingOptional
An object configuring the rule’s logging behavior.
Enabled bool
Whether to generate a log when the rule matches.
Link to this property
Link to this property
Ratelimit RuleDeleteResponseEnvelopeResultRulesChallengeRuleRatelimitOptional
An object configuring the rule’s rate limit behavior.
Characteristics \[]string
Characteristics of the request on which the rate limit counter will be incremented.
Link to this property
Period int64
Period in seconds over which the counter is being incremented.
minimum0
Link to this property
CountingExpression stringOptional
An expression that defines when the rate limit counter should be incremented. It defaults to the same as the rule’s expression.
minLength1
Link to this property
MitigationTimeout int64Optional
Period of time in seconds after which the action will be disabled following its first execution.
Link to this property
RequestsPerPeriod int64Optional
The threshold of requests per period after which the action will be executed for the first time.
minimum1
Link to this property
RequestsToOrigin boolOptional
Whether counting is only performed when an origin is reached.
Link to this property
ScorePerPeriod int64Optional
The score threshold per period for which the action will be executed the first time.
Link to this property
ScoreResponseHeaderName stringOptional
A response header name provided by the origin, which contains the score to increment rate limit counter with.
minLength1
Link to this property
Link to this property
Link to this property
type RuleDeleteResponseEnvelopeResultRulesResponseCompressionRule 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 RuleDeleteResponseEnvelopeResultRulesDDoSDynamicRule 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 RuleDeleteResponseEnvelopeResultRulesExecuteRule 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 RuleDeleteResponseEnvelopeResultRulesForceConnectionCloseRule 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 RuleDeleteResponseEnvelopeResultRulesJavaScriptChallengeRule struct{…}
ID string
The unique ID of the rule.
Link to this property
Action RuleDeleteResponseEnvelopeResultRulesJavaScriptChallengeRuleAction
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 RuleDeleteResponseEnvelopeResultRulesJavaScriptChallengeRuleExposedCredentialCheckOptional
Configuration for exposed credential checking.
PasswordExpression string
An expression that selects the password used in the credentials check.
minLength1
Link to this property
UsernameExpression string
An expression that selects the user ID used in the credentials check.
minLength1
Link to this property
Link to this property
Logging LoggingOptional
An object configuring the rule’s logging behavior.
Enabled bool
Whether to generate a log when the rule matches.
Link to this property
Link to this property
Ratelimit RuleDeleteResponseEnvelopeResultRulesJavaScriptChallengeRuleRatelimitOptional
An object configuring the rule’s rate limit behavior.
Characteristics \[]string
Characteristics of the request on which the rate limit counter will be incremented.
Link to this property
Period int64
Period in seconds over which the counter is being incremented.
minimum0
Link to this property
CountingExpression stringOptional
An expression that defines when the rate limit counter should be incremented. It defaults to the same as the rule’s expression.
minLength1
Link to this property
MitigationTimeout int64Optional
Period of time in seconds after which the action will be disabled following its first execution.
Link to this property
RequestsPerPeriod int64Optional
The threshold of requests per period after which the action will be executed for the first time.
minimum1
Link to this property
RequestsToOrigin boolOptional
Whether counting is only performed when an origin is reached.
Link to this property
ScorePerPeriod int64Optional
The score threshold per period for which the action will be executed the first time.
Link to this property
ScoreResponseHeaderName stringOptional
A response header name provided by the origin, which contains the score to increment rate limit counter with.
minLength1
Link to this property
Link to this property
Link to this property
type RuleDeleteResponseEnvelopeResultRulesLogRule 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 RuleDeleteResponseEnvelopeResultRulesLogCustomFieldRule 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 RuleDeleteResponseEnvelopeResultRulesManagedChallengeRule 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 RuleDeleteResponseEnvelopeResultRulesRedirectRule 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 RuleDeleteResponseEnvelopeResultRulesRewriteRule 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 RuleDeleteResponseEnvelopeResultRulesRouteRule 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 RuleDeleteResponseEnvelopeResultRulesScoreRule 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 RuleDeleteResponseEnvelopeResultRulesServeErrorRule 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 RuleDeleteResponseEnvelopeResultRulesSetCacheControlRule struct{…}
ID string
The unique ID of the rule.
Link to this property
Action RuleDeleteResponseEnvelopeResultRulesSetCacheControlRuleAction
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 RuleDeleteResponseEnvelopeResultRulesSetCacheControlRuleActionParametersOptional
The parameters configuring the rule’s action.
Immutable RuleDeleteResponseEnvelopeResultRulesSetCacheControlRuleActionParametersImmutableOptional
A cache-control directive configuration.
One of the following:
type RuleDeleteResponseEnvelopeResultRulesSetCacheControlRuleActionParametersImmutableSetDirective struct{…}
Set the directive.
Operation RuleDeleteResponseEnvelopeResultRulesSetCacheControlRuleActionParametersImmutableSetDirectiveOperation
The operation to perform on the cache-control directive.
One of the following:
const RuleDeleteResponseEnvelopeResultRulesSetCacheControlRuleActionParametersImmutableSetDirectiveOperationSet RuleDeleteResponseEnvelopeResultRulesSetCacheControlRuleActionParametersImmutableSetDirectiveOperation = "set"
Link to this property
const RuleDeleteResponseEnvelopeResultRulesSetCacheControlRuleActionParametersImmutableSetDirectiveOperationRemove RuleDeleteResponseEnvelopeResultRulesSetCacheControlRuleActionParametersImmutableSetDirectiveOperation = "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 RuleDeleteResponseEnvelopeResultRulesSetCacheControlRuleActionParametersImmutableRemoveDirective struct{…}
Remove the directive.
Operation RuleDeleteResponseEnvelopeResultRulesSetCacheControlRuleActionParametersImmutableRemoveDirectiveOperation
The operation to perform on the cache-control directive.
One of the following:
const RuleDeleteResponseEnvelopeResultRulesSetCacheControlRuleActionParametersImmutableRemoveDirectiveOperationSet RuleDeleteResponseEnvelopeResultRulesSetCacheControlRuleActionParametersImmutableRemoveDirectiveOperation = "set"
Link to this property
const RuleDeleteResponseEnvelopeResultRulesSetCacheControlRuleActionParametersImmutableRemoveDirectiveOperationRemove RuleDeleteResponseEnvelopeResultRulesSetCacheControlRuleActionParametersImmutableRemoveDirectiveOperation = "remove"
Link to this property
Link to this property
CloudflareOnly boolOptional
Whether the directive should only be applied to the Cloudflare CDN cache.
Link to this property
Link to this property
Link to this property
MaxAge RuleDeleteResponseEnvelopeResultRulesSetCacheControlRuleActionParametersMaxAgeOptional
A cache-control directive configuration that accepts a duration value in seconds.
One of the following:
type RuleDeleteResponseEnvelopeResultRulesSetCacheControlRuleActionParametersMaxAgeSetDirective struct{…}
Set the directive with a duration value in seconds.
Operation RuleDeleteResponseEnvelopeResultRulesSetCacheControlRuleActionParametersMaxAgeSetDirectiveOperation
The operation to perform on the cache-control directive.
One of the following:
const RuleDeleteResponseEnvelopeResultRulesSetCacheControlRuleActionParametersMaxAgeSetDirectiveOperationSet RuleDeleteResponseEnvelopeResultRulesSetCacheControlRuleActionParametersMaxAgeSetDirectiveOperation = "set"
Link to this property
const RuleDeleteResponseEnvelopeResultRulesSetCacheControlRuleActionParametersMaxAgeSetDirectiveOperationRemove RuleDeleteResponseEnvelopeResultRulesSetCacheControlRuleActionParametersMaxAgeSetDirectiveOperation = "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 RuleDeleteResponseEnvelopeResultRulesSetCacheControlRuleActionParametersMaxAgeRemoveDirective struct{…}
Remove the directive.
Operation RuleDeleteResponseEnvelopeResultRulesSetCacheControlRuleActionParametersMaxAgeRemoveDirectiveOperation
The operation to perform on the cache-control directive.
One of the following:
const RuleDeleteResponseEnvelopeResultRulesSetCacheControlRuleActionParametersMaxAgeRemoveDirectiveOperationSet RuleDeleteResponseEnvelopeResultRulesSetCacheControlRuleActionParametersMaxAgeRemoveDirectiveOperation = "set"
Link to this property
const RuleDeleteResponseEnvelopeResultRulesSetCacheControlRuleActionParametersMaxAgeRemoveDirectiveOperationRemove RuleDeleteResponseEnvelopeResultRulesSetCacheControlRuleActionParametersMaxAgeRemoveDirectiveOperation = "remove"
Link to this property
Link to this property
CloudflareOnly boolOptional
Whether the directive should only be applied to the Cloudflare CDN cache.
Link to this property
Link to this property
Link to this property
MustRevalidate RuleDeleteResponseEnvelopeResultRulesSetCacheControlRuleActionParametersMustRevalidateOptional
A cache-control directive configuration.
One of the following:
type RuleDeleteResponseEnvelopeResultRulesSetCacheControlRuleActionParametersMustRevalidateSetDirective struct{…}
Set the directive.
Operation RuleDeleteResponseEnvelopeResultRulesSetCacheControlRuleActionParametersMustRevalidateSetDirectiveOperation
The operation to perform on the cache-control directive.
One of the following:
const RuleDeleteResponseEnvelopeResultRulesSetCacheControlRuleActionParametersMustRevalidateSetDirectiveOperationSet RuleDeleteResponseEnvelopeResultRulesSetCacheControlRuleActionParametersMustRevalidateSetDirectiveOperation = "set"
Link to this property
const RuleDeleteResponseEnvelopeResultRulesSetCacheControlRuleActionParametersMustRevalidateSetDirectiveOperationRemove RuleDeleteResponseEnvelopeResultRulesSetCacheControlRuleActionParametersMustRevalidateSetDirectiveOperation = "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 RuleDeleteResponseEnvelopeResultRulesSetCacheControlRuleActionParametersMustRevalidateRemoveDirective struct{…}
Remove the directive.
Operation RuleDeleteResponseEnvelopeResultRulesSetCacheControlRuleActionParametersMustRevalidateRemoveDirectiveOperation
The operation to perform on the cache-control directive.
One of the following:
const RuleDeleteResponseEnvelopeResultRulesSetCacheControlRuleActionParametersMustRevalidateRemoveDirectiveOperationSet RuleDeleteResponseEnvelopeResultRulesSetCacheControlRuleActionParametersMustRevalidateRemoveDirectiveOperation = "set"
Link to this property
const RuleDeleteResponseEnvelopeResultRulesSetCacheControlRuleActionParametersMustRevalidateRemoveDirectiveOperationRemove RuleDeleteResponseEnvelopeResultRulesSetCacheControlRuleActionParametersMustRevalidateRemoveDirectiveOperation = "remove"
Link to this property
Link to this property
CloudflareOnly boolOptional
Whether the directive should only be applied to the Cloudflare CDN cache.
Link to this property
Link to this property
Link to this property
MustUnderstand RuleDeleteResponseEnvelopeResultRulesSetCacheControlRuleActionParametersMustUnderstandOptional
A cache-control directive configuration.
One of the following:
type RuleDeleteResponseEnvelopeResultRulesSetCacheControlRuleActionParametersMustUnderstandSetDirective struct{…}
Set the directive.
Operation RuleDeleteResponseEnvelopeResultRulesSetCacheControlRuleActionParametersMustUnderstandSetDirectiveOperation
The operation to perform on the cache-control directive.
One of the following:
const RuleDeleteResponseEnvelopeResultRulesSetCacheControlRuleActionParametersMustUnderstandSetDirectiveOperationSet RuleDeleteResponseEnvelopeResultRulesSetCacheControlRuleActionParametersMustUnderstandSetDirectiveOperation = "set"
Link to this property
const RuleDeleteResponseEnvelopeResultRulesSetCacheControlRuleActionParametersMustUnderstandSetDirectiveOperationRemove RuleDeleteResponseEnvelopeResultRulesSetCacheControlRuleActionParametersMustUnderstandSetDirectiveOperation = "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 RuleDeleteResponseEnvelopeResultRulesSetCacheControlRuleActionParametersMustUnderstandRemoveDirective struct{…}
Remove the directive.
Operation RuleDeleteResponseEnvelopeResultRulesSetCacheControlRuleActionParametersMustUnderstandRemoveDirectiveOperation
The operation to perform on the cache-control directive.
One of the following:
const RuleDeleteResponseEnvelopeResultRulesSetCacheControlRuleActionParametersMustUnderstandRemoveDirectiveOperationSet RuleDeleteResponseEnvelopeResultRulesSetCacheControlRuleActionParametersMustUnderstandRemoveDirectiveOperation = "set"
Link to this property
const RuleDeleteResponseEnvelopeResultRulesSetCacheControlRuleActionParametersMustUnderstandRemoveDirectiveOperationRemove RuleDeleteResponseEnvelopeResultRulesSetCacheControlRuleActionParametersMustUnderstandRemoveDirectiveOperation = "remove"
Link to this property
Link to this property
CloudflareOnly boolOptional
Whether the directive should only be applied to the Cloudflare CDN cache.
Link to this property
Link to this property
Link to this property
NoCache RuleDeleteResponseEnvelopeResultRulesSetCacheControlRuleActionParametersNoCacheOptional
A cache-control directive configuration that accepts optional qualifiers (header names).
One of the following:
type RuleDeleteResponseEnvelopeResultRulesSetCacheControlRuleActionParametersNoCacheSetDirective struct{…}
Set the directive with optional qualifiers.
Operation RuleDeleteResponseEnvelopeResultRulesSetCacheControlRuleActionParametersNoCacheSetDirectiveOperation
The operation to perform on the cache-control directive.
One of the following:
const RuleDeleteResponseEnvelopeResultRulesSetCacheControlRuleActionParametersNoCacheSetDirectiveOperationSet RuleDeleteResponseEnvelopeResultRulesSetCacheControlRuleActionParametersNoCacheSetDirectiveOperation = "set"
Link to this property
const RuleDeleteResponseEnvelopeResultRulesSetCacheControlRuleActionParametersNoCacheSetDirectiveOperationRemove RuleDeleteResponseEnvelopeResultRulesSetCacheControlRuleActionParametersNoCacheSetDirectiveOperation = "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 RuleDeleteResponseEnvelopeResultRulesSetCacheControlRuleActionParametersNoCacheRemoveDirective struct{…}
Remove the directive.
Operation RuleDeleteResponseEnvelopeResultRulesSetCacheControlRuleActionParametersNoCacheRemoveDirectiveOperation
The operation to perform on the cache-control directive.
One of the following:
const RuleDeleteResponseEnvelopeResultRulesSetCacheControlRuleActionParametersNoCacheRemoveDirectiveOperationSet RuleDeleteResponseEnvelopeResultRulesSetCacheControlRuleActionParametersNoCacheRemoveDirectiveOperation = "set"
Link to this property
const RuleDeleteResponseEnvelopeResultRulesSetCacheControlRuleActionParametersNoCacheRemoveDirectiveOperationRemove RuleDeleteResponseEnvelopeResultRulesSetCacheControlRuleActionParametersNoCacheRemoveDirectiveOperation = "remove"
Link to this property
Link to this property
CloudflareOnly boolOptional
Whether the directive should only be applied to the Cloudflare CDN cache.
Link to this property
Link to this property
Link to this property
NoStore RuleDeleteResponseEnvelopeResultRulesSetCacheControlRuleActionParametersNoStoreOptional
A cache-control directive configuration.
One of the following:
type RuleDeleteResponseEnvelopeResultRulesSetCacheControlRuleActionParametersNoStoreSetDirective struct{…}
Set the directive.
Operation RuleDeleteResponseEnvelopeResultRulesSetCacheControlRuleActionParametersNoStoreSetDirectiveOperation
The operation to perform on the cache-control directive.
One of the following:
const RuleDeleteResponseEnvelopeResultRulesSetCacheControlRuleActionParametersNoStoreSetDirectiveOperationSet RuleDeleteResponseEnvelopeResultRulesSetCacheControlRuleActionParametersNoStoreSetDirectiveOperation = "set"
Link to this property
const RuleDeleteResponseEnvelopeResultRulesSetCacheControlRuleActionParametersNoStoreSetDirectiveOperationRemove RuleDeleteResponseEnvelopeResultRulesSetCacheControlRuleActionParametersNoStoreSetDirectiveOperation = "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 RuleDeleteResponseEnvelopeResultRulesSetCacheControlRuleActionParametersNoStoreRemoveDirective struct{…}
Remove the directive.
Operation RuleDeleteResponseEnvelopeResultRulesSetCacheControlRuleActionParametersNoStoreRemoveDirectiveOperation
The operation to perform on the cache-control directive.
One of the following:
const RuleDeleteResponseEnvelopeResultRulesSetCacheControlRuleActionParametersNoStoreRemoveDirectiveOperationSet RuleDeleteResponseEnvelopeResultRulesSetCacheControlRuleActionParametersNoStoreRemoveDirectiveOperation = "set"
Link to this property
const RuleDeleteResponseEnvelopeResultRulesSetCacheControlRuleActionParametersNoStoreRemoveDirectiveOperationRemove RuleDeleteResponseEnvelopeResultRulesSetCacheControlRuleActionParametersNoStoreRemoveDirectiveOperation = "remove"
Link to this property
Link to this property
CloudflareOnly boolOptional
Whether the directive should only be applied to the Cloudflare CDN cache.
Link to this property
Link to this property
Link to this property
NoTransform RuleDeleteResponseEnvelopeResultRulesSetCacheControlRuleActionParametersNoTransformOptional
A cache-control directive configuration.
One of the following:
type RuleDeleteResponseEnvelopeResultRulesSetCacheControlRuleActionParametersNoTransformSetDirective struct{…}
Set the directive.
Operation RuleDeleteResponseEnvelopeResultRulesSetCacheControlRuleActionParametersNoTransformSetDirectiveOperation
The operation to perform on the cache-control directive.
One of the following:
const RuleDeleteResponseEnvelopeResultRulesSetCacheControlRuleActionParametersNoTransformSetDirectiveOperationSet RuleDeleteResponseEnvelopeResultRulesSetCacheControlRuleActionParametersNoTransformSetDirectiveOperation = "set"
Link to this property
const RuleDeleteResponseEnvelopeResultRulesSetCacheControlRuleActionParametersNoTransformSetDirectiveOperationRemove RuleDeleteResponseEnvelopeResultRulesSetCacheControlRuleActionParametersNoTransformSetDirectiveOperation = "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 RuleDeleteResponseEnvelopeResultRulesSetCacheControlRuleActionParametersNoTransformRemoveDirective struct{…}
Remove the directive.
Operation RuleDeleteResponseEnvelopeResultRulesSetCacheControlRuleActionParametersNoTransformRemoveDirectiveOperation
The operation to perform on the cache-control directive.
One of the following:
const RuleDeleteResponseEnvelopeResultRulesSetCacheControlRuleActionParametersNoTransformRemoveDirectiveOperationSet RuleDeleteResponseEnvelopeResultRulesSetCacheControlRuleActionParametersNoTransformRemoveDirectiveOperation = "set"
Link to this property
const RuleDeleteResponseEnvelopeResultRulesSetCacheControlRuleActionParametersNoTransformRemoveDirectiveOperationRemove RuleDeleteResponseEnvelopeResultRulesSetCacheControlRuleActionParametersNoTransformRemoveDirectiveOperation = "remove"
Link to this property
Link to this property
CloudflareOnly boolOptional
Whether the directive should only be applied to the Cloudflare CDN cache.
Link to this property
Link to this property
Link to this property
Private RuleDeleteResponseEnvelopeResultRulesSetCacheControlRuleActionParametersPrivateOptional
A cache-control directive configuration that accepts optional qualifiers (header names).
One of the following:
type RuleDeleteResponseEnvelopeResultRulesSetCacheControlRuleActionParametersPrivateSetDirective struct{…}
Set the directive with optional qualifiers.
Operation RuleDeleteResponseEnvelopeResultRulesSetCacheControlRuleActionParametersPrivateSetDirectiveOperation
The operation to perform on the cache-control directive.
One of the following:
const RuleDeleteResponseEnvelopeResultRulesSetCacheControlRuleActionParametersPrivateSetDirectiveOperationSet RuleDeleteResponseEnvelopeResultRulesSetCacheControlRuleActionParametersPrivateSetDirectiveOperation = "set"
Link to this property
const RuleDeleteResponseEnvelopeResultRulesSetCacheControlRuleActionParametersPrivateSetDirectiveOperationRemove RuleDeleteResponseEnvelopeResultRulesSetCacheControlRuleActionParametersPrivateSetDirectiveOperation = "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 RuleDeleteResponseEnvelopeResultRulesSetCacheControlRuleActionParametersPrivateRemoveDirective struct{…}
Remove the directive.
Operation RuleDeleteResponseEnvelopeResultRulesSetCacheControlRuleActionParametersPrivateRemoveDirectiveOperation
The operation to perform on the cache-control directive.
One of the following:
const RuleDeleteResponseEnvelopeResultRulesSetCacheControlRuleActionParametersPrivateRemoveDirectiveOperationSet RuleDeleteResponseEnvelopeResultRulesSetCacheControlRuleActionParametersPrivateRemoveDirectiveOperation = "set"
Link to this property
const RuleDeleteResponseEnvelopeResultRulesSetCacheControlRuleActionParametersPrivateRemoveDirectiveOperationRemove RuleDeleteResponseEnvelopeResultRulesSetCacheControlRuleActionParametersPrivateRemoveDirectiveOperation = "remove"
Link to this property
Link to this property
CloudflareOnly boolOptional
Whether the directive should only be applied to the Cloudflare CDN cache.
Link to this property
Link to this property
Link to this property
ProxyRevalidate RuleDeleteResponseEnvelopeResultRulesSetCacheControlRuleActionParametersProxyRevalidateOptional
A cache-control directive configuration.
One of the following:
type RuleDeleteResponseEnvelopeResultRulesSetCacheControlRuleActionParametersProxyRevalidateSetDirective struct{…}
Set the directive.
Operation RuleDeleteResponseEnvelopeResultRulesSetCacheControlRuleActionParametersProxyRevalidateSetDirectiveOperation
The operation to perform on the cache-control directive.
One of the following:
const RuleDeleteResponseEnvelopeResultRulesSetCacheControlRuleActionParametersProxyRevalidateSetDirectiveOperationSet RuleDeleteResponseEnvelopeResultRulesSetCacheControlRuleActionParametersProxyRevalidateSetDirectiveOperation = "set"
Link to this property
const RuleDeleteResponseEnvelopeResultRulesSetCacheControlRuleActionParametersProxyRevalidateSetDirectiveOperationRemove RuleDeleteResponseEnvelopeResultRulesSetCacheControlRuleActionParametersProxyRevalidateSetDirectiveOperation = "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 RuleDeleteResponseEnvelopeResultRulesSetCacheControlRuleActionParametersProxyRevalidateRemoveDirective struct{…}
Remove the directive.
Operation RuleDeleteResponseEnvelopeResultRulesSetCacheControlRuleActionParametersProxyRevalidateRemoveDirectiveOperation
The operation to perform on the cache-control directive.
One of the following:
const RuleDeleteResponseEnvelopeResultRulesSetCacheControlRuleActionParametersProxyRevalidateRemoveDirectiveOperationSet RuleDeleteResponseEnvelopeResultRulesSetCacheControlRuleActionParametersProxyRevalidateRemoveDirectiveOperation = "set"
Link to this property
const RuleDeleteResponseEnvelopeResultRulesSetCacheControlRuleActionParametersProxyRevalidateRemoveDirectiveOperationRemove RuleDeleteResponseEnvelopeResultRulesSetCacheControlRuleActionParametersProxyRevalidateRemoveDirectiveOperation = "remove"
Link to this property
Link to this property
CloudflareOnly boolOptional
Whether the directive should only be applied to the Cloudflare CDN cache.
Link to this property
Link to this property
Link to this property
Public RuleDeleteResponseEnvelopeResultRulesSetCacheControlRuleActionParametersPublicOptional
A cache-control directive configuration.
One of the following:
type RuleDeleteResponseEnvelopeResultRulesSetCacheControlRuleActionParametersPublicSetDirective struct{…}
Set the directive.
Operation RuleDeleteResponseEnvelopeResultRulesSetCacheControlRuleActionParametersPublicSetDirectiveOperation
The operation to perform on the cache-control directive.
One of the following:
const RuleDeleteResponseEnvelopeResultRulesSetCacheControlRuleActionParametersPublicSetDirectiveOperationSet RuleDeleteResponseEnvelopeResultRulesSetCacheControlRuleActionParametersPublicSetDirectiveOperation = "set"
Link to this property
const RuleDeleteResponseEnvelopeResultRulesSetCacheControlRuleActionParametersPublicSetDirectiveOperationRemove RuleDeleteResponseEnvelopeResultRulesSetCacheControlRuleActionParametersPublicSetDirectiveOperation = "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 RuleDeleteResponseEnvelopeResultRulesSetCacheControlRuleActionParametersPublicRemoveDirective struct{…}
Remove the directive.
Operation RuleDeleteResponseEnvelopeResultRulesSetCacheControlRuleActionParametersPublicRemoveDirectiveOperation
The operation to perform on the cache-control directive.
One of the following:
const RuleDeleteResponseEnvelopeResultRulesSetCacheControlRuleActionParametersPublicRemoveDirectiveOperationSet RuleDeleteResponseEnvelopeResultRulesSetCacheControlRuleActionParametersPublicRemoveDirectiveOperation = "set"
Link to this property
const RuleDeleteResponseEnvelopeResultRulesSetCacheControlRuleActionParametersPublicRemoveDirectiveOperationRemove RuleDeleteResponseEnvelopeResultRulesSetCacheControlRuleActionParametersPublicRemoveDirectiveOperation = "remove"
Link to this property
Link to this property
CloudflareOnly boolOptional
Whether the directive should only be applied to the Cloudflare CDN cache.
Link to this property
Link to this property
Link to this property
SMaxage RuleDeleteResponseEnvelopeResultRulesSetCacheControlRuleActionParametersSMaxageOptional
A cache-control directive configuration that accepts a duration value in seconds.
One of the following:
type RuleDeleteResponseEnvelopeResultRulesSetCacheControlRuleActionParametersSMaxageSetDirective struct{…}
Set the directive with a duration value in seconds.
Operation RuleDeleteResponseEnvelopeResultRulesSetCacheControlRuleActionParametersSMaxageSetDirectiveOperation
The operation to perform on the cache-control directive.
One of the following:
const RuleDeleteResponseEnvelopeResultRulesSetCacheControlRuleActionParametersSMaxageSetDirectiveOperationSet RuleDeleteResponseEnvelopeResultRulesSetCacheControlRuleActionParametersSMaxageSetDirectiveOperation = "set"
Link to this property
const RuleDeleteResponseEnvelopeResultRulesSetCacheControlRuleActionParametersSMaxageSetDirectiveOperationRemove RuleDeleteResponseEnvelopeResultRulesSetCacheControlRuleActionParametersSMaxageSetDirectiveOperation = "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 RuleDeleteResponseEnvelopeResultRulesSetCacheControlRuleActionParametersSMaxageRemoveDirective struct{…}
Remove the directive.
Operation RuleDeleteResponseEnvelopeResultRulesSetCacheControlRuleActionParametersSMaxageRemoveDirectiveOperation
The operation to perform on the cache-control directive.
One of the following:
const RuleDeleteResponseEnvelopeResultRulesSetCacheControlRuleActionParametersSMaxageRemoveDirectiveOperationSet RuleDeleteResponseEnvelopeResultRulesSetCacheControlRuleActionParametersSMaxageRemoveDirectiveOperation = "set"
Link to this property
const RuleDeleteResponseEnvelopeResultRulesSetCacheControlRuleActionParametersSMaxageRemoveDirectiveOperationRemove RuleDeleteResponseEnvelopeResultRulesSetCacheControlRuleActionParametersSMaxageRemoveDirectiveOperation = "remove"
Link to this property
Link to this property
CloudflareOnly boolOptional
Whether the directive should only be applied to the Cloudflare CDN cache.
Link to this property
Link to this property
Link to this property
StaleIfError RuleDeleteResponseEnvelopeResultRulesSetCacheControlRuleActionParametersStaleIfErrorOptional
A cache-control directive configuration that accepts a duration value in seconds.
One of the following:
type RuleDeleteResponseEnvelopeResultRulesSetCacheControlRuleActionParametersStaleIfErrorSetDirective struct{…}
Set the directive with a duration value in seconds.
Operation RuleDeleteResponseEnvelopeResultRulesSetCacheControlRuleActionParametersStaleIfErrorSetDirectiveOperation
The operation to perform on the cache-control directive.
One of the following:
const RuleDeleteResponseEnvelopeResultRulesSetCacheControlRuleActionParametersStaleIfErrorSetDirectiveOperationSet RuleDeleteResponseEnvelopeResultRulesSetCacheControlRuleActionParametersStaleIfErrorSetDirectiveOperation = "set"
Link to this property
const RuleDeleteResponseEnvelopeResultRulesSetCacheControlRuleActionParametersStaleIfErrorSetDirectiveOperationRemove RuleDeleteResponseEnvelopeResultRulesSetCacheControlRuleActionParametersStaleIfErrorSetDirectiveOperation = "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 RuleDeleteResponseEnvelopeResultRulesSetCacheControlRuleActionParametersStaleIfErrorRemoveDirective struct{…}
Remove the directive.
Operation RuleDeleteResponseEnvelopeResultRulesSetCacheControlRuleActionParametersStaleIfErrorRemoveDirectiveOperation
The operation to perform on the cache-control directive.
One of the following:
const RuleDeleteResponseEnvelopeResultRulesSetCacheControlRuleActionParametersStaleIfErrorRemoveDirectiveOperationSet RuleDeleteResponseEnvelopeResultRulesSetCacheControlRuleActionParametersStaleIfErrorRemoveDirectiveOperation = "set"
Link to this property
const RuleDeleteResponseEnvelopeResultRulesSetCacheControlRuleActionParametersStaleIfErrorRemoveDirectiveOperationRemove RuleDeleteResponseEnvelopeResultRulesSetCacheControlRuleActionParametersStaleIfErrorRemoveDirectiveOperation = "remove"
Link to this property
Link to this property
CloudflareOnly boolOptional
Whether the directive should only be applied to the Cloudflare CDN cache.
Link to this property
Link to this property
Link to this property
StaleWhileRevalidate RuleDeleteResponseEnvelopeResultRulesSetCacheControlRuleActionParametersStaleWhileRevalidateOptional
A cache-control directive configuration that accepts a duration value in seconds.
One of the following:
type RuleDeleteResponseEnvelopeResultRulesSetCacheControlRuleActionParametersStaleWhileRevalidateSetDirective struct{…}
Set the directive with a duration value in seconds.
Operation RuleDeleteResponseEnvelopeResultRulesSetCacheControlRuleActionParametersStaleWhileRevalidateSetDirectiveOperation
The operation to perform on the cache-control directive.
One of the following:
const RuleDeleteResponseEnvelopeResultRulesSetCacheControlRuleActionParametersStaleWhileRevalidateSetDirectiveOperationSet RuleDeleteResponseEnvelopeResultRulesSetCacheControlRuleActionParametersStaleWhileRevalidateSetDirectiveOperation = "set"
Link to this property
const RuleDeleteResponseEnvelopeResultRulesSetCacheControlRuleActionParametersStaleWhileRevalidateSetDirectiveOperationRemove RuleDeleteResponseEnvelopeResultRulesSetCacheControlRuleActionParametersStaleWhileRevalidateSetDirectiveOperation = "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 RuleDeleteResponseEnvelopeResultRulesSetCacheControlRuleActionParametersStaleWhileRevalidateRemoveDirective struct{…}
Remove the directive.
Operation RuleDeleteResponseEnvelopeResultRulesSetCacheControlRuleActionParametersStaleWhileRevalidateRemoveDirectiveOperation
The operation to perform on the cache-control directive.
One of the following:
const RuleDeleteResponseEnvelopeResultRulesSetCacheControlRuleActionParametersStaleWhileRevalidateRemoveDirectiveOperationSet RuleDeleteResponseEnvelopeResultRulesSetCacheControlRuleActionParametersStaleWhileRevalidateRemoveDirectiveOperation = "set"
Link to this property
const RuleDeleteResponseEnvelopeResultRulesSetCacheControlRuleActionParametersStaleWhileRevalidateRemoveDirectiveOperationRemove RuleDeleteResponseEnvelopeResultRulesSetCacheControlRuleActionParametersStaleWhileRevalidateRemoveDirectiveOperation = "remove"
Link to this property
Link to this property
CloudflareOnly boolOptional
Whether the directive should only be applied to the Cloudflare CDN cache.
Link to this property
Link to this property
Link to this property
Link to this property
Categories \[]stringOptional
The categories of the rule.
Link to this property
Description stringOptional
An informative description of the rule.
Link to this property
ExposedCredentialCheck RuleDeleteResponseEnvelopeResultRulesSetCacheControlRuleExposedCredentialCheckOptional
Configuration for exposed credential checking.
PasswordExpression string
An expression that selects the password used in the credentials check.
minLength1
Link to this property
UsernameExpression string
An expression that selects the user ID used in the credentials check.
minLength1
Link to this property
Link to this property
Logging LoggingOptional
An object configuring the rule’s logging behavior.
Enabled bool
Whether to generate a log when the rule matches.
Link to this property
Link to this property
Ratelimit RuleDeleteResponseEnvelopeResultRulesSetCacheControlRuleRatelimitOptional
An object configuring the rule’s rate limit behavior.
Characteristics \[]string
Characteristics of the request on which the rate limit counter will be incremented.
Link to this property
Period int64
Period in seconds over which the counter is being incremented.
minimum0
Link to this property
CountingExpression stringOptional
An expression that defines when the rate limit counter should be incremented. It defaults to the same as the rule’s expression.
minLength1
Link to this property
MitigationTimeout int64Optional
Period of time in seconds after which the action will be disabled following its first execution.
Link to this property
RequestsPerPeriod int64Optional
The threshold of requests per period after which the action will be executed for the first time.
minimum1
Link to this property
RequestsToOrigin boolOptional
Whether counting is only performed when an origin is reached.
Link to this property
ScorePerPeriod int64Optional
The score threshold per period for which the action will be executed the first time.
Link to this property
ScoreResponseHeaderName stringOptional
A response header name provided by the origin, which contains the score to increment rate limit counter with.
minLength1
Link to this property
Link to this property
Link to this property
type RuleDeleteResponseEnvelopeResultRulesSetCacheSettingsRule 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 RuleDeleteResponseEnvelopeResultRulesSetCacheTagsRule struct{…}
ID string
The unique ID of the rule.
Link to this property
Action RuleDeleteResponseEnvelopeResultRulesSetCacheTagsRuleAction
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 RuleDeleteResponseEnvelopeResultRulesSetCacheTagsRuleActionParametersOptional
The parameters configuring the rule’s action.
One of the following:
type RuleDeleteResponseEnvelopeResultRulesSetCacheTagsRuleActionParametersAddCacheTagsValues struct{…}
Add cache tags using a list of values.
Operation RuleDeleteResponseEnvelopeResultRulesSetCacheTagsRuleActionParametersAddCacheTagsValuesOperation
The operation to perform on the cache tags.
One of the following:
const RuleDeleteResponseEnvelopeResultRulesSetCacheTagsRuleActionParametersAddCacheTagsValuesOperationAdd RuleDeleteResponseEnvelopeResultRulesSetCacheTagsRuleActionParametersAddCacheTagsValuesOperation = "add"
Link to this property
const RuleDeleteResponseEnvelopeResultRulesSetCacheTagsRuleActionParametersAddCacheTagsValuesOperationRemove RuleDeleteResponseEnvelopeResultRulesSetCacheTagsRuleActionParametersAddCacheTagsValuesOperation = "remove"
Link to this property
const RuleDeleteResponseEnvelopeResultRulesSetCacheTagsRuleActionParametersAddCacheTagsValuesOperationSet RuleDeleteResponseEnvelopeResultRulesSetCacheTagsRuleActionParametersAddCacheTagsValuesOperation = "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 RuleDeleteResponseEnvelopeResultRulesSetCacheTagsRuleActionParametersAddCacheTagsExpression 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 RuleDeleteResponseEnvelopeResultRulesSetCacheTagsRuleActionParametersAddCacheTagsExpressionOperation
The operation to perform on the cache tags.
One of the following:
const RuleDeleteResponseEnvelopeResultRulesSetCacheTagsRuleActionParametersAddCacheTagsExpressionOperationAdd RuleDeleteResponseEnvelopeResultRulesSetCacheTagsRuleActionParametersAddCacheTagsExpressionOperation = "add"
Link to this property
const RuleDeleteResponseEnvelopeResultRulesSetCacheTagsRuleActionParametersAddCacheTagsExpressionOperationRemove RuleDeleteResponseEnvelopeResultRulesSetCacheTagsRuleActionParametersAddCacheTagsExpressionOperation = "remove"
Link to this property
const RuleDeleteResponseEnvelopeResultRulesSetCacheTagsRuleActionParametersAddCacheTagsExpressionOperationSet RuleDeleteResponseEnvelopeResultRulesSetCacheTagsRuleActionParametersAddCacheTagsExpressionOperation = "set"
Link to this property
Link to this property
Link to this property
type RuleDeleteResponseEnvelopeResultRulesSetCacheTagsRuleActionParametersRemoveCacheTagsValues struct{…}
Remove cache tags using a list of values.
Operation RuleDeleteResponseEnvelopeResultRulesSetCacheTagsRuleActionParametersRemoveCacheTagsValuesOperation
The operation to perform on the cache tags.
One of the following:
const RuleDeleteResponseEnvelopeResultRulesSetCacheTagsRuleActionParametersRemoveCacheTagsValuesOperationAdd RuleDeleteResponseEnvelopeResultRulesSetCacheTagsRuleActionParametersRemoveCacheTagsValuesOperation = "add"
Link to this property
const RuleDeleteResponseEnvelopeResultRulesSetCacheTagsRuleActionParametersRemoveCacheTagsValuesOperationRemove RuleDeleteResponseEnvelopeResultRulesSetCacheTagsRuleActionParametersRemoveCacheTagsValuesOperation = "remove"
Link to this property
const RuleDeleteResponseEnvelopeResultRulesSetCacheTagsRuleActionParametersRemoveCacheTagsValuesOperationSet RuleDeleteResponseEnvelopeResultRulesSetCacheTagsRuleActionParametersRemoveCacheTagsValuesOperation = "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 RuleDeleteResponseEnvelopeResultRulesSetCacheTagsRuleActionParametersRemoveCacheTagsExpression 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 RuleDeleteResponseEnvelopeResultRulesSetCacheTagsRuleActionParametersRemoveCacheTagsExpressionOperation
The operation to perform on the cache tags.
One of the following:
const RuleDeleteResponseEnvelopeResultRulesSetCacheTagsRuleActionParametersRemoveCacheTagsExpressionOperationAdd RuleDeleteResponseEnvelopeResultRulesSetCacheTagsRuleActionParametersRemoveCacheTagsExpressionOperation = "add"
Link to this property
const RuleDeleteResponseEnvelopeResultRulesSetCacheTagsRuleActionParametersRemoveCacheTagsExpressionOperationRemove RuleDeleteResponseEnvelopeResultRulesSetCacheTagsRuleActionParametersRemoveCacheTagsExpressionOperation = "remove"
Link to this property
const RuleDeleteResponseEnvelopeResultRulesSetCacheTagsRuleActionParametersRemoveCacheTagsExpressionOperationSet RuleDeleteResponseEnvelopeResultRulesSetCacheTagsRuleActionParametersRemoveCacheTagsExpressionOperation = "set"
Link to this property
Link to this property
Link to this property
type RuleDeleteResponseEnvelopeResultRulesSetCacheTagsRuleActionParametersSetCacheTagsValues struct{…}
Set cache tags using a list of values.
Operation RuleDeleteResponseEnvelopeResultRulesSetCacheTagsRuleActionParametersSetCacheTagsValuesOperation
The operation to perform on the cache tags.
One of the following:
const RuleDeleteResponseEnvelopeResultRulesSetCacheTagsRuleActionParametersSetCacheTagsValuesOperationAdd RuleDeleteResponseEnvelopeResultRulesSetCacheTagsRuleActionParametersSetCacheTagsValuesOperation = "add"
Link to this property
const RuleDeleteResponseEnvelopeResultRulesSetCacheTagsRuleActionParametersSetCacheTagsValuesOperationRemove RuleDeleteResponseEnvelopeResultRulesSetCacheTagsRuleActionParametersSetCacheTagsValuesOperation = "remove"
Link to this property
const RuleDeleteResponseEnvelopeResultRulesSetCacheTagsRuleActionParametersSetCacheTagsValuesOperationSet RuleDeleteResponseEnvelopeResultRulesSetCacheTagsRuleActionParametersSetCacheTagsValuesOperation = "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 RuleDeleteResponseEnvelopeResultRulesSetCacheTagsRuleActionParametersSetCacheTagsExpression 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 RuleDeleteResponseEnvelopeResultRulesSetCacheTagsRuleActionParametersSetCacheTagsExpressionOperation
The operation to perform on the cache tags.
One of the following:
const RuleDeleteResponseEnvelopeResultRulesSetCacheTagsRuleActionParametersSetCacheTagsExpressionOperationAdd RuleDeleteResponseEnvelopeResultRulesSetCacheTagsRuleActionParametersSetCacheTagsExpressionOperation = "add"
Link to this property
const RuleDeleteResponseEnvelopeResultRulesSetCacheTagsRuleActionParametersSetCacheTagsExpressionOperationRemove RuleDeleteResponseEnvelopeResultRulesSetCacheTagsRuleActionParametersSetCacheTagsExpressionOperation = "remove"
Link to this property
const RuleDeleteResponseEnvelopeResultRulesSetCacheTagsRuleActionParametersSetCacheTagsExpressionOperationSet RuleDeleteResponseEnvelopeResultRulesSetCacheTagsRuleActionParametersSetCacheTagsExpressionOperation = "set"
Link to this property
Link to this property
Link to this property
Link to this property
Categories \[]stringOptional
The categories of the rule.
Link to this property
Description stringOptional
An informative description of the rule.
Link to this property
ExposedCredentialCheck RuleDeleteResponseEnvelopeResultRulesSetCacheTagsRuleExposedCredentialCheckOptional
Configuration for exposed credential checking.
PasswordExpression string
An expression that selects the password used in the credentials check.
minLength1
Link to this property
UsernameExpression string
An expression that selects the user ID used in the credentials check.
minLength1
Link to this property
Link to this property
Logging LoggingOptional
An object configuring the rule’s logging behavior.
Enabled bool
Whether to generate a log when the rule matches.
Link to this property
Link to this property
Ratelimit RuleDeleteResponseEnvelopeResultRulesSetCacheTagsRuleRatelimitOptional
An object configuring the rule’s rate limit behavior.
Characteristics \[]string
Characteristics of the request on which the rate limit counter will be incremented.
Link to this property
Period int64
Period in seconds over which the counter is being incremented.
minimum0
Link to this property
CountingExpression stringOptional
An expression that defines when the rate limit counter should be incremented. It defaults to the same as the rule’s expression.
minLength1
Link to this property
MitigationTimeout int64Optional
Period of time in seconds after which the action will be disabled following its first execution.
Link to this property
RequestsPerPeriod int64Optional
The threshold of requests per period after which the action will be executed for the first time.
minimum1
Link to this property
RequestsToOrigin boolOptional
Whether counting is only performed when an origin is reached.
Link to this property
ScorePerPeriod int64Optional
The score threshold per period for which the action will be executed the first time.
Link to this property
ScoreResponseHeaderName stringOptional
A response header name provided by the origin, which contains the score to increment rate limit counter with.
minLength1
Link to this property
Link to this property
Link to this property
type RuleDeleteResponseEnvelopeResultRulesSetConfigurationRule 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 RuleDeleteResponseEnvelopeResultRulesSkipRule 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 RuleDeleteResponseEnvelopeResultRulesTransformResponseHTMLRule struct{…}
ID string
The unique ID of the rule.
Link to this property
Action RuleDeleteResponseEnvelopeResultRulesTransformResponseHTMLRuleAction
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 RuleDeleteResponseEnvelopeResultRulesTransformResponseHTMLRuleActionParametersOptional
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 RuleDeleteResponseEnvelopeResultRulesTransformResponseHTMLRuleExposedCredentialCheckOptional
Configuration for exposed credential checking.
PasswordExpression string
An expression that selects the password used in the credentials check.
minLength1
Link to this property
UsernameExpression string
An expression that selects the user ID used in the credentials check.
minLength1
Link to this property
Link to this property
Logging LoggingOptional
An object configuring the rule’s logging behavior.
Enabled bool
Whether to generate a log when the rule matches.
Link to this property
Link to this property
Ratelimit RuleDeleteResponseEnvelopeResultRulesTransformResponseHTMLRuleRatelimitOptional
An object configuring the rule’s rate limit behavior.
Characteristics \[]string
Characteristics of the request on which the rate limit counter will be incremented.
Link to this property
Period int64
Period in seconds over which the counter is being incremented.
minimum0
Link to this property
CountingExpression stringOptional
An expression that defines when the rate limit counter should be incremented. It defaults to the same as the rule’s expression.
minLength1
Link to this property
MitigationTimeout int64Optional
Period of time in seconds after which the action will be disabled following its first execution.
Link to this property
RequestsPerPeriod int64Optional
The threshold of requests per period after which the action will be executed for the first time.
minimum1
Link to this property
RequestsToOrigin boolOptional
Whether counting is only performed when an origin is reached.
Link to this property
ScorePerPeriod int64Optional
The score threshold per period for which the action will be executed the first time.
Link to this property
ScoreResponseHeaderName stringOptional
A response header name provided by the origin, which contains the score to increment rate limit counter with.
minLength1
Link to this property
Link to this property
Link to this property
Link to this property
Version string
The version of the ruleset.
Link to this property
Description stringOptional
An informative description of the ruleset.
Link to this property
Link to this property
[Link to this property](<#(resource)%20rulesets.rules%20%3E%20(method)%20delete%20%3E%20(network%20schema)%20%3E%20(property)%20result>)
### Delete 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.Delete(
context.TODO(),
"2f2feab2026849078ba485f918791bdc",
"3a03d665bac047339bb530ecb439a90d",
rulesets.RuleDeleteParams{
},
)
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
}
```