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 WriteMagic Firewall WriteL4 DDoS Managed Ruleset WriteTransform Rules WriteSelect Configuration WriteAccount WAF WriteAccount Rulesets WriteLogs Write

ParametersExpand Collapse

rulesetID string

The unique ID of the ruleset.

ruleID string

The unique ID of the rule.

params RuleDeleteParams

AccountID param.Field[string]Optional

Path param: The Account ID to use for this endpoint. Mutually exclusive with the Zone ID.

ZoneID param.Field[string]Optional

Path param: The Zone ID to use for this endpoint. Mutually exclusive with the Account ID.

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.

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.

Kind Kind

The kind of the ruleset.

One of the following:

const KindManaged Kind = "managed"

const KindCustom Kind = "custom"

const KindRoot Kind = "root"

const KindZone Kind = "zone"

LastUpdated Time

The timestamp of when the ruleset was last modified.

formatdate-time

Name string

The human-readable name of the ruleset.

minLength1

Phase Phase

The phase of the ruleset.

One of the following:

const PhaseDDoSL4 Phase = "ddos_l4"

const PhaseDDoSL7 Phase = "ddos_l7"

const PhaseHTTPConfigSettings Phase = "http_config_settings"

const PhaseHTTPCustomErrors Phase = "http_custom_errors"

const PhaseHTTPLogCustomFields Phase = "http_log_custom_fields"

const PhaseHTTPRatelimit Phase = "http_ratelimit"

const PhaseHTTPRequestCacheSettings Phase = "http_request_cache_settings"

const PhaseHTTPRequestDynamicRedirect Phase = "http_request_dynamic_redirect"

const PhaseHTTPRequestFirewallCustom Phase = "http_request_firewall_custom"

const PhaseHTTPRequestFirewallManaged Phase = "http_request_firewall_managed"

const PhaseHTTPRequestLateTransform Phase = "http_request_late_transform"

const PhaseHTTPRequestOrigin Phase = "http_request_origin"

const PhaseHTTPRequestRedirect Phase = "http_request_redirect"

const PhaseHTTPRequestSanitize Phase = "http_request_sanitize"

const PhaseHTTPRequestSBFM Phase = "http_request_sbfm"

const PhaseHTTPRequestTransform Phase = "http_request_transform"

const PhaseHTTPResponseCacheSettings Phase = "http_response_cache_settings"

const PhaseHTTPResponseCompression Phase = "http_response_compression"

const PhaseHTTPResponseFirewallManaged Phase = "http_response_firewall_managed"

const PhaseHTTPResponseHeadersTransform Phase = "http_response_headers_transform"

const PhaseMagicTransit Phase = "magic_transit"

const PhaseMagicTransitIDsManaged Phase = "magic_transit_ids_managed"

const PhaseMagicTransitManaged Phase = "magic_transit_managed"

const PhaseMagicTransitRatelimit Phase = "magic_transit_ratelimit"

Rules []RuleDeleteResponseEnvelopeResultRules

The list of rules in the ruleset.

One of the following:

type RuleDeleteResponseEnvelopeResultRulesBlockRule struct{…}

ID string

Action string

Enabled bool

Expression string

Ref string

type RuleDeleteResponseEnvelopeResultRulesChallengeRule struct{…}

ID string

The unique ID of the rule.

Action RuleDeleteResponseEnvelopeResultRulesChallengeRuleAction

The action to perform when the rule matches.

Enabled bool

Whether the rule should be executed.

Expression string

The expression defining which traffic will match the rule.

minLength1

LastUpdated Time

The timestamp of when the rule was last modified.

formatdate-time

Ref string

The reference of the rule (the rule’s ID by default).

minLength1

Version string

The version of the rule.

ActionParameters unknownOptional

The parameters configuring the rule’s action.

Categories []stringOptional

The categories of the rule.

Description stringOptional

An informative description of the rule.

ExposedCredentialCheck RuleDeleteResponseEnvelopeResultRulesChallengeRuleExposedCredentialCheckOptional

Configuration for exposed credential checking.

PasswordExpression string

An expression that selects the password used in the credentials check.

minLength1

UsernameExpression string

An expression that selects the user ID used in the credentials check.

minLength1

Logging LoggingOptional

An object configuring the rule’s logging behavior.

Enabled bool

Whether to generate a log when the rule matches.

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.

Period int64

Period in seconds over which the counter is being incremented.

minimum0

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

MitigationTimeout int64Optional

Period of time in seconds after which the action will be disabled following its first execution.

RequestsPerPeriod int64Optional

The threshold of requests per period after which the action will be executed for the first time.

minimum1

RequestsToOrigin boolOptional

Whether counting is only performed when an origin is reached.

ScorePerPeriod int64Optional

The score threshold per period for which the action will be executed the first time.

ScoreResponseHeaderName stringOptional

A response header name provided by the origin, which contains the score to increment rate limit counter with.

minLength1

type RuleDeleteResponseEnvelopeResultRulesResponseCompressionRule struct{…}

ID string

Action string

Enabled bool

Expression string

Ref string

type RuleDeleteResponseEnvelopeResultRulesDDoSDynamicRule struct{…}

ID string

Action string

Enabled bool

Expression string

Ref string

type RuleDeleteResponseEnvelopeResultRulesExecuteRule struct{…}

ID string

Action string

Enabled bool

Expression string

Ref string

type RuleDeleteResponseEnvelopeResultRulesForceConnectionCloseRule struct{…}

ID string

Action string

Enabled bool

Expression string

Ref string

type RuleDeleteResponseEnvelopeResultRulesJavaScriptChallengeRule struct{…}

ID string

The unique ID of the rule.

Action RuleDeleteResponseEnvelopeResultRulesJavaScriptChallengeRuleAction

The action to perform when the rule matches.

Enabled bool

Whether the rule should be executed.

Expression string

The expression defining which traffic will match the rule.

minLength1

LastUpdated Time

The timestamp of when the rule was last modified.

formatdate-time

Ref string

The reference of the rule (the rule’s ID by default).

minLength1

Version string

The version of the rule.

ActionParameters unknownOptional

The parameters configuring the rule’s action.

Categories []stringOptional

The categories of the rule.

Description stringOptional

An informative description of the rule.

ExposedCredentialCheck RuleDeleteResponseEnvelopeResultRulesJavaScriptChallengeRuleExposedCredentialCheckOptional

Configuration for exposed credential checking.

PasswordExpression string

An expression that selects the password used in the credentials check.

minLength1

UsernameExpression string

An expression that selects the user ID used in the credentials check.

minLength1

Logging LoggingOptional

An object configuring the rule’s logging behavior.

Enabled bool

Whether to generate a log when the rule matches.

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.

Period int64

Period in seconds over which the counter is being incremented.

minimum0

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

MitigationTimeout int64Optional

Period of time in seconds after which the action will be disabled following its first execution.

RequestsPerPeriod int64Optional

The threshold of requests per period after which the action will be executed for the first time.

minimum1

RequestsToOrigin boolOptional

Whether counting is only performed when an origin is reached.

ScorePerPeriod int64Optional

The score threshold per period for which the action will be executed the first time.

ScoreResponseHeaderName stringOptional

A response header name provided by the origin, which contains the score to increment rate limit counter with.

minLength1

type RuleDeleteResponseEnvelopeResultRulesLogRule struct{…}

ID string

Action string

Enabled bool

Expression string

Ref string

type RuleDeleteResponseEnvelopeResultRulesLogCustomFieldRule struct{…}

ID string

Action string

Enabled bool

Expression string

Ref string

type RuleDeleteResponseEnvelopeResultRulesManagedChallengeRule struct{…}

ID string

Action string

Enabled bool

Expression string

Ref string

type RuleDeleteResponseEnvelopeResultRulesRedirectRule struct{…}

ID string

Action string

Enabled bool

Expression string

Ref string

type RuleDeleteResponseEnvelopeResultRulesRewriteRule struct{…}

ID string

Action string

Enabled bool

Expression string

Ref string

type RuleDeleteResponseEnvelopeResultRulesRouteRule struct{…}

ID string

Action string

Enabled bool

Expression string

Ref string

type RuleDeleteResponseEnvelopeResultRulesScoreRule struct{…}

ID string

Action string

Enabled bool

Expression string

Ref string

type RuleDeleteResponseEnvelopeResultRulesServeErrorRule struct{…}

ID string

Action string

Enabled bool

Expression string

Ref string

type RuleDeleteResponseEnvelopeResultRulesSetCacheControlRule struct{…}

ID string

The unique ID of the rule.

Action RuleDeleteResponseEnvelopeResultRulesSetCacheControlRuleAction

The action to perform when the rule matches.

Enabled bool

Expression string

The expression defining which traffic will match the rule.

minLength1

LastUpdated Time

The timestamp of when the rule was last modified.

formatdate-time

Ref string

The reference of the rule (the rule’s ID by default).

minLength1

Version string

The version of the rule.

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"

const RuleDeleteResponseEnvelopeResultRulesSetCacheControlRuleActionParametersImmutableSetDirectiveOperationRemove RuleDeleteResponseEnvelopeResultRulesSetCacheControlRuleActionParametersImmutableSetDirectiveOperation = "remove"

CloudflareOnly boolOptional

Whether the directive should only be applied to the Cloudflare CDN cache.

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"

const RuleDeleteResponseEnvelopeResultRulesSetCacheControlRuleActionParametersImmutableRemoveDirectiveOperationRemove RuleDeleteResponseEnvelopeResultRulesSetCacheControlRuleActionParametersImmutableRemoveDirectiveOperation = "remove"

CloudflareOnly boolOptional

Whether the directive should only be applied to the Cloudflare CDN cache.

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"

const RuleDeleteResponseEnvelopeResultRulesSetCacheControlRuleActionParametersMaxAgeSetDirectiveOperationRemove RuleDeleteResponseEnvelopeResultRulesSetCacheControlRuleActionParametersMaxAgeSetDirectiveOperation = "remove"

Value int64

The duration value in seconds for the directive.

minimum0

CloudflareOnly boolOptional

Whether the directive should only be applied to the Cloudflare CDN cache.

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"

const RuleDeleteResponseEnvelopeResultRulesSetCacheControlRuleActionParametersMaxAgeRemoveDirectiveOperationRemove RuleDeleteResponseEnvelopeResultRulesSetCacheControlRuleActionParametersMaxAgeRemoveDirectiveOperation = "remove"

CloudflareOnly boolOptional

Whether the directive should only be applied to the Cloudflare CDN cache.

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"

const RuleDeleteResponseEnvelopeResultRulesSetCacheControlRuleActionParametersMustRevalidateSetDirectiveOperationRemove RuleDeleteResponseEnvelopeResultRulesSetCacheControlRuleActionParametersMustRevalidateSetDirectiveOperation = "remove"

CloudflareOnly boolOptional

Whether the directive should only be applied to the Cloudflare CDN cache.

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"

const RuleDeleteResponseEnvelopeResultRulesSetCacheControlRuleActionParametersMustRevalidateRemoveDirectiveOperationRemove RuleDeleteResponseEnvelopeResultRulesSetCacheControlRuleActionParametersMustRevalidateRemoveDirectiveOperation = "remove"

CloudflareOnly boolOptional

Whether the directive should only be applied to the Cloudflare CDN cache.

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"

const RuleDeleteResponseEnvelopeResultRulesSetCacheControlRuleActionParametersMustUnderstandSetDirectiveOperationRemove RuleDeleteResponseEnvelopeResultRulesSetCacheControlRuleActionParametersMustUnderstandSetDirectiveOperation = "remove"

CloudflareOnly boolOptional

Whether the directive should only be applied to the Cloudflare CDN cache.

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"

const RuleDeleteResponseEnvelopeResultRulesSetCacheControlRuleActionParametersMustUnderstandRemoveDirectiveOperationRemove RuleDeleteResponseEnvelopeResultRulesSetCacheControlRuleActionParametersMustUnderstandRemoveDirectiveOperation = "remove"

CloudflareOnly boolOptional

Whether the directive should only be applied to the Cloudflare CDN cache.

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"

const RuleDeleteResponseEnvelopeResultRulesSetCacheControlRuleActionParametersNoCacheSetDirectiveOperationRemove RuleDeleteResponseEnvelopeResultRulesSetCacheControlRuleActionParametersNoCacheSetDirectiveOperation = "remove"

CloudflareOnly boolOptional

Whether the directive should only be applied to the Cloudflare CDN cache.

Qualifiers []stringOptional

Optional list of header names to qualify the directive (e.g., for “private” or “no-cache” directives).

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"

const RuleDeleteResponseEnvelopeResultRulesSetCacheControlRuleActionParametersNoCacheRemoveDirectiveOperationRemove RuleDeleteResponseEnvelopeResultRulesSetCacheControlRuleActionParametersNoCacheRemoveDirectiveOperation = "remove"

CloudflareOnly boolOptional

Whether the directive should only be applied to the Cloudflare CDN cache.

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"

const RuleDeleteResponseEnvelopeResultRulesSetCacheControlRuleActionParametersNoStoreSetDirectiveOperationRemove RuleDeleteResponseEnvelopeResultRulesSetCacheControlRuleActionParametersNoStoreSetDirectiveOperation = "remove"

CloudflareOnly boolOptional

Whether the directive should only be applied to the Cloudflare CDN cache.

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"

const RuleDeleteResponseEnvelopeResultRulesSetCacheControlRuleActionParametersNoStoreRemoveDirectiveOperationRemove RuleDeleteResponseEnvelopeResultRulesSetCacheControlRuleActionParametersNoStoreRemoveDirectiveOperation = "remove"

CloudflareOnly boolOptional

Whether the directive should only be applied to the Cloudflare CDN cache.

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"

const RuleDeleteResponseEnvelopeResultRulesSetCacheControlRuleActionParametersNoTransformSetDirectiveOperationRemove RuleDeleteResponseEnvelopeResultRulesSetCacheControlRuleActionParametersNoTransformSetDirectiveOperation = "remove"

CloudflareOnly boolOptional

Whether the directive should only be applied to the Cloudflare CDN cache.

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"

const RuleDeleteResponseEnvelopeResultRulesSetCacheControlRuleActionParametersNoTransformRemoveDirectiveOperationRemove RuleDeleteResponseEnvelopeResultRulesSetCacheControlRuleActionParametersNoTransformRemoveDirectiveOperation = "remove"

CloudflareOnly boolOptional

Whether the directive should only be applied to the Cloudflare CDN cache.

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"

const RuleDeleteResponseEnvelopeResultRulesSetCacheControlRuleActionParametersPrivateSetDirectiveOperationRemove RuleDeleteResponseEnvelopeResultRulesSetCacheControlRuleActionParametersPrivateSetDirectiveOperation = "remove"

CloudflareOnly boolOptional

Whether the directive should only be applied to the Cloudflare CDN cache.

Qualifiers []stringOptional

Optional list of header names to qualify the directive (e.g., for “private” or “no-cache” directives).

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"

const RuleDeleteResponseEnvelopeResultRulesSetCacheControlRuleActionParametersPrivateRemoveDirectiveOperationRemove RuleDeleteResponseEnvelopeResultRulesSetCacheControlRuleActionParametersPrivateRemoveDirectiveOperation = "remove"

CloudflareOnly boolOptional

Whether the directive should only be applied to the Cloudflare CDN cache.

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"

const RuleDeleteResponseEnvelopeResultRulesSetCacheControlRuleActionParametersProxyRevalidateSetDirectiveOperationRemove RuleDeleteResponseEnvelopeResultRulesSetCacheControlRuleActionParametersProxyRevalidateSetDirectiveOperation = "remove"

CloudflareOnly boolOptional

Whether the directive should only be applied to the Cloudflare CDN cache.

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"

const RuleDeleteResponseEnvelopeResultRulesSetCacheControlRuleActionParametersProxyRevalidateRemoveDirectiveOperationRemove RuleDeleteResponseEnvelopeResultRulesSetCacheControlRuleActionParametersProxyRevalidateRemoveDirectiveOperation = "remove"

CloudflareOnly boolOptional

Whether the directive should only be applied to the Cloudflare CDN cache.

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"

const RuleDeleteResponseEnvelopeResultRulesSetCacheControlRuleActionParametersPublicSetDirectiveOperationRemove RuleDeleteResponseEnvelopeResultRulesSetCacheControlRuleActionParametersPublicSetDirectiveOperation = "remove"

CloudflareOnly boolOptional

Whether the directive should only be applied to the Cloudflare CDN cache.

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"

const RuleDeleteResponseEnvelopeResultRulesSetCacheControlRuleActionParametersPublicRemoveDirectiveOperationRemove RuleDeleteResponseEnvelopeResultRulesSetCacheControlRuleActionParametersPublicRemoveDirectiveOperation = "remove"

CloudflareOnly boolOptional

Whether the directive should only be applied to the Cloudflare CDN cache.

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"

const RuleDeleteResponseEnvelopeResultRulesSetCacheControlRuleActionParametersSMaxageSetDirectiveOperationRemove RuleDeleteResponseEnvelopeResultRulesSetCacheControlRuleActionParametersSMaxageSetDirectiveOperation = "remove"

Value int64

The duration value in seconds for the directive.

minimum0

CloudflareOnly boolOptional

Whether the directive should only be applied to the Cloudflare CDN cache.

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"

const RuleDeleteResponseEnvelopeResultRulesSetCacheControlRuleActionParametersSMaxageRemoveDirectiveOperationRemove RuleDeleteResponseEnvelopeResultRulesSetCacheControlRuleActionParametersSMaxageRemoveDirectiveOperation = "remove"

CloudflareOnly boolOptional

Whether the directive should only be applied to the Cloudflare CDN cache.

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"

const RuleDeleteResponseEnvelopeResultRulesSetCacheControlRuleActionParametersStaleIfErrorSetDirectiveOperationRemove RuleDeleteResponseEnvelopeResultRulesSetCacheControlRuleActionParametersStaleIfErrorSetDirectiveOperation = "remove"

Value int64

The duration value in seconds for the directive.

minimum0

CloudflareOnly boolOptional

Whether the directive should only be applied to the Cloudflare CDN cache.

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"

const RuleDeleteResponseEnvelopeResultRulesSetCacheControlRuleActionParametersStaleIfErrorRemoveDirectiveOperationRemove RuleDeleteResponseEnvelopeResultRulesSetCacheControlRuleActionParametersStaleIfErrorRemoveDirectiveOperation = "remove"

CloudflareOnly boolOptional

Whether the directive should only be applied to the Cloudflare CDN cache.

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"

const RuleDeleteResponseEnvelopeResultRulesSetCacheControlRuleActionParametersStaleWhileRevalidateSetDirectiveOperationRemove RuleDeleteResponseEnvelopeResultRulesSetCacheControlRuleActionParametersStaleWhileRevalidateSetDirectiveOperation = "remove"

Value int64

The duration value in seconds for the directive.

minimum0

CloudflareOnly boolOptional

Whether the directive should only be applied to the Cloudflare CDN cache.

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"

const RuleDeleteResponseEnvelopeResultRulesSetCacheControlRuleActionParametersStaleWhileRevalidateRemoveDirectiveOperationRemove RuleDeleteResponseEnvelopeResultRulesSetCacheControlRuleActionParametersStaleWhileRevalidateRemoveDirectiveOperation = "remove"

CloudflareOnly boolOptional

Whether the directive should only be applied to the Cloudflare CDN cache.

Categories []stringOptional

The categories of the rule.

Description stringOptional

An informative description of the rule.

ExposedCredentialCheck RuleDeleteResponseEnvelopeResultRulesSetCacheControlRuleExposedCredentialCheckOptional

Configuration for exposed credential checking.

PasswordExpression string

An expression that selects the password used in the credentials check.

minLength1

UsernameExpression string

An expression that selects the user ID used in the credentials check.

minLength1

Logging LoggingOptional

An object configuring the rule’s logging behavior.

Enabled bool

Whether to generate a log when the rule matches.

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.

Period int64

Period in seconds over which the counter is being incremented.

minimum0

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

MitigationTimeout int64Optional

Period of time in seconds after which the action will be disabled following its first execution.

RequestsPerPeriod int64Optional

The threshold of requests per period after which the action will be executed for the first time.

minimum1

RequestsToOrigin boolOptional

Whether counting is only performed when an origin is reached.

ScorePerPeriod int64Optional

The score threshold per period for which the action will be executed the first time.

ScoreResponseHeaderName stringOptional

A response header name provided by the origin, which contains the score to increment rate limit counter with.

minLength1

type RuleDeleteResponseEnvelopeResultRulesSetCacheSettingsRule struct{…}

ID string

Action string

Enabled bool

Expression string

Ref string

type RuleDeleteResponseEnvelopeResultRulesSetCacheTagsRule struct{…}

ID string

The unique ID of the rule.

Action RuleDeleteResponseEnvelopeResultRulesSetCacheTagsRuleAction

The action to perform when the rule matches.

Enabled bool

Expression string

The expression defining which traffic will match the rule.

minLength1

LastUpdated Time

The timestamp of when the rule was last modified.

formatdate-time

Ref string

The reference of the rule (the rule’s ID by default).

minLength1

Version string

The version of the rule.

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"

const RuleDeleteResponseEnvelopeResultRulesSetCacheTagsRuleActionParametersAddCacheTagsValuesOperationRemove RuleDeleteResponseEnvelopeResultRulesSetCacheTagsRuleActionParametersAddCacheTagsValuesOperation = "remove"

const RuleDeleteResponseEnvelopeResultRulesSetCacheTagsRuleActionParametersAddCacheTagsValuesOperationSet RuleDeleteResponseEnvelopeResultRulesSetCacheTagsRuleActionParametersAddCacheTagsValuesOperation = "set"

Values []string

A list of cache tag values.

type RuleDeleteResponseEnvelopeResultRulesSetCacheTagsRuleActionParametersAddCacheTagsExpression struct{…}

Add cache tags using an expression.

Expression string

An expression that evaluates to an array of cache tag values.

minLength1

Operation RuleDeleteResponseEnvelopeResultRulesSetCacheTagsRuleActionParametersAddCacheTagsExpressionOperation

The operation to perform on the cache tags.

One of the following:

const RuleDeleteResponseEnvelopeResultRulesSetCacheTagsRuleActionParametersAddCacheTagsExpressionOperationAdd RuleDeleteResponseEnvelopeResultRulesSetCacheTagsRuleActionParametersAddCacheTagsExpressionOperation = "add"

const RuleDeleteResponseEnvelopeResultRulesSetCacheTagsRuleActionParametersAddCacheTagsExpressionOperationRemove RuleDeleteResponseEnvelopeResultRulesSetCacheTagsRuleActionParametersAddCacheTagsExpressionOperation = "remove"

const RuleDeleteResponseEnvelopeResultRulesSetCacheTagsRuleActionParametersAddCacheTagsExpressionOperationSet RuleDeleteResponseEnvelopeResultRulesSetCacheTagsRuleActionParametersAddCacheTagsExpressionOperation = "set"

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"

const RuleDeleteResponseEnvelopeResultRulesSetCacheTagsRuleActionParametersRemoveCacheTagsValuesOperationRemove RuleDeleteResponseEnvelopeResultRulesSetCacheTagsRuleActionParametersRemoveCacheTagsValuesOperation = "remove"

const RuleDeleteResponseEnvelopeResultRulesSetCacheTagsRuleActionParametersRemoveCacheTagsValuesOperationSet RuleDeleteResponseEnvelopeResultRulesSetCacheTagsRuleActionParametersRemoveCacheTagsValuesOperation = "set"

Values []string

A list of cache tag values.

type RuleDeleteResponseEnvelopeResultRulesSetCacheTagsRuleActionParametersRemoveCacheTagsExpression struct{…}

Remove cache tags using an expression.

Expression string

An expression that evaluates to an array of cache tag values.

minLength1

Operation RuleDeleteResponseEnvelopeResultRulesSetCacheTagsRuleActionParametersRemoveCacheTagsExpressionOperation

The operation to perform on the cache tags.

One of the following:

const RuleDeleteResponseEnvelopeResultRulesSetCacheTagsRuleActionParametersRemoveCacheTagsExpressionOperationAdd RuleDeleteResponseEnvelopeResultRulesSetCacheTagsRuleActionParametersRemoveCacheTagsExpressionOperation = "add"

const RuleDeleteResponseEnvelopeResultRulesSetCacheTagsRuleActionParametersRemoveCacheTagsExpressionOperationRemove RuleDeleteResponseEnvelopeResultRulesSetCacheTagsRuleActionParametersRemoveCacheTagsExpressionOperation = "remove"

const RuleDeleteResponseEnvelopeResultRulesSetCacheTagsRuleActionParametersRemoveCacheTagsExpressionOperationSet RuleDeleteResponseEnvelopeResultRulesSetCacheTagsRuleActionParametersRemoveCacheTagsExpressionOperation = "set"

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"

const RuleDeleteResponseEnvelopeResultRulesSetCacheTagsRuleActionParametersSetCacheTagsValuesOperationRemove RuleDeleteResponseEnvelopeResultRulesSetCacheTagsRuleActionParametersSetCacheTagsValuesOperation = "remove"

const RuleDeleteResponseEnvelopeResultRulesSetCacheTagsRuleActionParametersSetCacheTagsValuesOperationSet RuleDeleteResponseEnvelopeResultRulesSetCacheTagsRuleActionParametersSetCacheTagsValuesOperation = "set"

Values []string

A list of cache tag values.

type RuleDeleteResponseEnvelopeResultRulesSetCacheTagsRuleActionParametersSetCacheTagsExpression struct{…}

Set cache tags using an expression.

Expression string

An expression that evaluates to an array of cache tag values.

minLength1

Operation RuleDeleteResponseEnvelopeResultRulesSetCacheTagsRuleActionParametersSetCacheTagsExpressionOperation

The operation to perform on the cache tags.

One of the following:

const RuleDeleteResponseEnvelopeResultRulesSetCacheTagsRuleActionParametersSetCacheTagsExpressionOperationAdd RuleDeleteResponseEnvelopeResultRulesSetCacheTagsRuleActionParametersSetCacheTagsExpressionOperation = "add"

const RuleDeleteResponseEnvelopeResultRulesSetCacheTagsRuleActionParametersSetCacheTagsExpressionOperationRemove RuleDeleteResponseEnvelopeResultRulesSetCacheTagsRuleActionParametersSetCacheTagsExpressionOperation = "remove"

const RuleDeleteResponseEnvelopeResultRulesSetCacheTagsRuleActionParametersSetCacheTagsExpressionOperationSet RuleDeleteResponseEnvelopeResultRulesSetCacheTagsRuleActionParametersSetCacheTagsExpressionOperation = "set"

Categories []stringOptional

The categories of the rule.

Description stringOptional

An informative description of the rule.

ExposedCredentialCheck RuleDeleteResponseEnvelopeResultRulesSetCacheTagsRuleExposedCredentialCheckOptional

Configuration for exposed credential checking.

PasswordExpression string

An expression that selects the password used in the credentials check.

minLength1

UsernameExpression string

An expression that selects the user ID used in the credentials check.

minLength1

Logging LoggingOptional

An object configuring the rule’s logging behavior.

Enabled bool

Whether to generate a log when the rule matches.

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.

Period int64

Period in seconds over which the counter is being incremented.

minimum0

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

MitigationTimeout int64Optional

Period of time in seconds after which the action will be disabled following its first execution.

RequestsPerPeriod int64Optional

The threshold of requests per period after which the action will be executed for the first time.

minimum1

RequestsToOrigin boolOptional

Whether counting is only performed when an origin is reached.

ScorePerPeriod int64Optional

The score threshold per period for which the action will be executed the first time.

ScoreResponseHeaderName stringOptional

A response header name provided by the origin, which contains the score to increment rate limit counter with.

minLength1

type RuleDeleteResponseEnvelopeResultRulesSetConfigurationRule struct{…}

ID string

Action string

Enabled bool

Expression string

Ref string

type RuleDeleteResponseEnvelopeResultRulesSkipRule struct{…}

ID string

Action string

Enabled bool

Expression string

Ref string

type RuleDeleteResponseEnvelopeResultRulesTransformResponseHTMLRule struct{…}

ID string

The unique ID of the rule.

Action RuleDeleteResponseEnvelopeResultRulesTransformResponseHTMLRuleAction

The action to perform when the rule matches.

Enabled bool

Expression string

The expression defining which traffic will match the rule.

minLength1

LastUpdated Time

The timestamp of when the rule was last modified.

formatdate-time

Ref string

The reference of the rule (the rule’s ID by default).

minLength1

Version string

The version of the rule.

ActionParameters RuleDeleteResponseEnvelopeResultRulesTransformResponseHTMLRuleActionParametersOptional

The parameters configuring the rule’s action.

LinkMaze unknown

Enables the link maze transformation on the response.

Categories []stringOptional

The categories of the rule.

Description stringOptional

An informative description of the rule.

ExposedCredentialCheck RuleDeleteResponseEnvelopeResultRulesTransformResponseHTMLRuleExposedCredentialCheckOptional

Configuration for exposed credential checking.

PasswordExpression string

An expression that selects the password used in the credentials check.

minLength1

UsernameExpression string

An expression that selects the user ID used in the credentials check.

minLength1

Logging LoggingOptional

An object configuring the rule’s logging behavior.

Enabled bool

Whether to generate a log when the rule matches.

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.

Period int64

Period in seconds over which the counter is being incremented.

minimum0

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

MitigationTimeout int64Optional

Period of time in seconds after which the action will be disabled following its first execution.

RequestsPerPeriod int64Optional

The threshold of requests per period after which the action will be executed for the first time.

minimum1

RequestsToOrigin boolOptional

Whether counting is only performed when an origin is reached.

ScorePerPeriod int64Optional

The score threshold per period for which the action will be executed the first time.

ScoreResponseHeaderName stringOptional

A response header name provided by the origin, which contains the score to increment rate limit counter with.

minLength1

Version string

The version of the ruleset.

Description stringOptional

An informative description of the ruleset.

Delete an account or zone ruleset rule

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

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

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