--- title: Get an account or zone ruleset --- [Skip to content](#_top) [API Reference](https://developers.cloudflare.com/api/go) [Rulesets](https://developers.cloudflare.com/api/go/resources/rulesets) Copy Markdown Open in **Claude**Open in **ChatGPT**Open in **Cursor** --- **Copy Markdown****View as Markdown** # Get an account or zone ruleset client.Rulesets.Get(ctx, rulesetID, query) (\*[RulesetGetResponse](), error) GET/{accounts\_or\_zones}/{account\_or\_zone\_id}/rulesets/{ruleset\_id} Fetches the latest version of 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``Mass URL Redirects Read``Magic Firewall Write``Magic Firewall Read``L4 DDoS Managed Ruleset Write``L4 DDoS Managed Ruleset Read``Transform Rules Write``Transform Rules Read``Select Configuration Write``Select Configuration Read``Account WAF Write``Account WAF Read``Account Rulesets Read``Account Rulesets Write``Logs Write``Logs Read` ##### ParametersExpand Collapse rulesetID string The unique ID of the ruleset. [Link to this property](<#(resource)%20rulesets%20%3E%20(method)%20get%20%3E%20(params)%20default%20%3E%20(param)%20ruleset_id%20%3E%20(schema)>)
query RulesetGetParams AccountID param.Field\[string]Optional The Account ID to use for this endpoint. Mutually exclusive with the Zone ID. Link to this property ZoneID param.Field\[string]Optional The Zone ID to use for this endpoint. Mutually exclusive with the Account ID. Link to this property
[Link to this property](<#(resource)%20rulesets%20%3E%20(method)%20get%20%3E%20(params)%20default>) ##### ReturnsExpand Collapse
type RulesetGetResponse 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 \[]RulesetGetResponseRule The list of rules in the ruleset. One of the following:
type RulesetGetResponseRulesBlockRule 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 RulesetGetResponseRulesChallengeRule struct{…} ID string The unique ID of the rule. Link to this property Action RulesetGetResponseRulesChallengeRuleAction 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 RulesetGetResponseRulesChallengeRuleExposedCredentialCheckOptional 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 RulesetGetResponseRulesChallengeRuleRatelimitOptional 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 RulesetGetResponseRulesResponseCompressionRule 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 RulesetGetResponseRulesDDoSDynamicRule 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 RulesetGetResponseRulesExecuteRule 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 RulesetGetResponseRulesForceConnectionCloseRule 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 RulesetGetResponseRulesJavaScriptChallengeRule struct{…} ID string The unique ID of the rule. Link to this property Action RulesetGetResponseRulesJavaScriptChallengeRuleAction 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 RulesetGetResponseRulesJavaScriptChallengeRuleExposedCredentialCheckOptional 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 RulesetGetResponseRulesJavaScriptChallengeRuleRatelimitOptional 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 RulesetGetResponseRulesLogRule 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 RulesetGetResponseRulesLogCustomFieldRule 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 RulesetGetResponseRulesManagedChallengeRule 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 RulesetGetResponseRulesRedirectRule 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 RulesetGetResponseRulesRewriteRule 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 RulesetGetResponseRulesRouteRule 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 RulesetGetResponseRulesScoreRule 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 RulesetGetResponseRulesServeErrorRule 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 RulesetGetResponseRulesSetCacheControlRule struct{…} ID string The unique ID of the rule. Link to this property Action RulesetGetResponseRulesSetCacheControlRuleAction 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 RulesetGetResponseRulesSetCacheControlRuleActionParametersOptional The parameters configuring the rule’s action.
Immutable RulesetGetResponseRulesSetCacheControlRuleActionParametersImmutableOptional A cache-control directive configuration. One of the following:
type RulesetGetResponseRulesSetCacheControlRuleActionParametersImmutableSetDirective struct{…} Set the directive.
Operation RulesetGetResponseRulesSetCacheControlRuleActionParametersImmutableSetDirectiveOperation The operation to perform on the cache-control directive. One of the following: const RulesetGetResponseRulesSetCacheControlRuleActionParametersImmutableSetDirectiveOperationSet RulesetGetResponseRulesSetCacheControlRuleActionParametersImmutableSetDirectiveOperation = "set" Link to this property const RulesetGetResponseRulesSetCacheControlRuleActionParametersImmutableSetDirectiveOperationRemove RulesetGetResponseRulesSetCacheControlRuleActionParametersImmutableSetDirectiveOperation = "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 RulesetGetResponseRulesSetCacheControlRuleActionParametersImmutableRemoveDirective struct{…} Remove the directive.
Operation RulesetGetResponseRulesSetCacheControlRuleActionParametersImmutableRemoveDirectiveOperation The operation to perform on the cache-control directive. One of the following: const RulesetGetResponseRulesSetCacheControlRuleActionParametersImmutableRemoveDirectiveOperationSet RulesetGetResponseRulesSetCacheControlRuleActionParametersImmutableRemoveDirectiveOperation = "set" Link to this property const RulesetGetResponseRulesSetCacheControlRuleActionParametersImmutableRemoveDirectiveOperationRemove RulesetGetResponseRulesSetCacheControlRuleActionParametersImmutableRemoveDirectiveOperation = "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 RulesetGetResponseRulesSetCacheControlRuleActionParametersMaxAgeOptional A cache-control directive configuration that accepts a duration value in seconds. One of the following:
type RulesetGetResponseRulesSetCacheControlRuleActionParametersMaxAgeSetDirective struct{…} Set the directive with a duration value in seconds.
Operation RulesetGetResponseRulesSetCacheControlRuleActionParametersMaxAgeSetDirectiveOperation The operation to perform on the cache-control directive. One of the following: const RulesetGetResponseRulesSetCacheControlRuleActionParametersMaxAgeSetDirectiveOperationSet RulesetGetResponseRulesSetCacheControlRuleActionParametersMaxAgeSetDirectiveOperation = "set" Link to this property const RulesetGetResponseRulesSetCacheControlRuleActionParametersMaxAgeSetDirectiveOperationRemove RulesetGetResponseRulesSetCacheControlRuleActionParametersMaxAgeSetDirectiveOperation = "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 RulesetGetResponseRulesSetCacheControlRuleActionParametersMaxAgeRemoveDirective struct{…} Remove the directive.
Operation RulesetGetResponseRulesSetCacheControlRuleActionParametersMaxAgeRemoveDirectiveOperation The operation to perform on the cache-control directive. One of the following: const RulesetGetResponseRulesSetCacheControlRuleActionParametersMaxAgeRemoveDirectiveOperationSet RulesetGetResponseRulesSetCacheControlRuleActionParametersMaxAgeRemoveDirectiveOperation = "set" Link to this property const RulesetGetResponseRulesSetCacheControlRuleActionParametersMaxAgeRemoveDirectiveOperationRemove RulesetGetResponseRulesSetCacheControlRuleActionParametersMaxAgeRemoveDirectiveOperation = "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 RulesetGetResponseRulesSetCacheControlRuleActionParametersMustRevalidateOptional A cache-control directive configuration. One of the following:
type RulesetGetResponseRulesSetCacheControlRuleActionParametersMustRevalidateSetDirective struct{…} Set the directive.
Operation RulesetGetResponseRulesSetCacheControlRuleActionParametersMustRevalidateSetDirectiveOperation The operation to perform on the cache-control directive. One of the following: const RulesetGetResponseRulesSetCacheControlRuleActionParametersMustRevalidateSetDirectiveOperationSet RulesetGetResponseRulesSetCacheControlRuleActionParametersMustRevalidateSetDirectiveOperation = "set" Link to this property const RulesetGetResponseRulesSetCacheControlRuleActionParametersMustRevalidateSetDirectiveOperationRemove RulesetGetResponseRulesSetCacheControlRuleActionParametersMustRevalidateSetDirectiveOperation = "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 RulesetGetResponseRulesSetCacheControlRuleActionParametersMustRevalidateRemoveDirective struct{…} Remove the directive.
Operation RulesetGetResponseRulesSetCacheControlRuleActionParametersMustRevalidateRemoveDirectiveOperation The operation to perform on the cache-control directive. One of the following: const RulesetGetResponseRulesSetCacheControlRuleActionParametersMustRevalidateRemoveDirectiveOperationSet RulesetGetResponseRulesSetCacheControlRuleActionParametersMustRevalidateRemoveDirectiveOperation = "set" Link to this property const RulesetGetResponseRulesSetCacheControlRuleActionParametersMustRevalidateRemoveDirectiveOperationRemove RulesetGetResponseRulesSetCacheControlRuleActionParametersMustRevalidateRemoveDirectiveOperation = "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 RulesetGetResponseRulesSetCacheControlRuleActionParametersMustUnderstandOptional A cache-control directive configuration. One of the following:
type RulesetGetResponseRulesSetCacheControlRuleActionParametersMustUnderstandSetDirective struct{…} Set the directive.
Operation RulesetGetResponseRulesSetCacheControlRuleActionParametersMustUnderstandSetDirectiveOperation The operation to perform on the cache-control directive. One of the following: const RulesetGetResponseRulesSetCacheControlRuleActionParametersMustUnderstandSetDirectiveOperationSet RulesetGetResponseRulesSetCacheControlRuleActionParametersMustUnderstandSetDirectiveOperation = "set" Link to this property const RulesetGetResponseRulesSetCacheControlRuleActionParametersMustUnderstandSetDirectiveOperationRemove RulesetGetResponseRulesSetCacheControlRuleActionParametersMustUnderstandSetDirectiveOperation = "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 RulesetGetResponseRulesSetCacheControlRuleActionParametersMustUnderstandRemoveDirective struct{…} Remove the directive.
Operation RulesetGetResponseRulesSetCacheControlRuleActionParametersMustUnderstandRemoveDirectiveOperation The operation to perform on the cache-control directive. One of the following: const RulesetGetResponseRulesSetCacheControlRuleActionParametersMustUnderstandRemoveDirectiveOperationSet RulesetGetResponseRulesSetCacheControlRuleActionParametersMustUnderstandRemoveDirectiveOperation = "set" Link to this property const RulesetGetResponseRulesSetCacheControlRuleActionParametersMustUnderstandRemoveDirectiveOperationRemove RulesetGetResponseRulesSetCacheControlRuleActionParametersMustUnderstandRemoveDirectiveOperation = "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 RulesetGetResponseRulesSetCacheControlRuleActionParametersNoCacheOptional A cache-control directive configuration that accepts optional qualifiers (header names). One of the following:
type RulesetGetResponseRulesSetCacheControlRuleActionParametersNoCacheSetDirective struct{…} Set the directive with optional qualifiers.
Operation RulesetGetResponseRulesSetCacheControlRuleActionParametersNoCacheSetDirectiveOperation The operation to perform on the cache-control directive. One of the following: const RulesetGetResponseRulesSetCacheControlRuleActionParametersNoCacheSetDirectiveOperationSet RulesetGetResponseRulesSetCacheControlRuleActionParametersNoCacheSetDirectiveOperation = "set" Link to this property const RulesetGetResponseRulesSetCacheControlRuleActionParametersNoCacheSetDirectiveOperationRemove RulesetGetResponseRulesSetCacheControlRuleActionParametersNoCacheSetDirectiveOperation = "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 RulesetGetResponseRulesSetCacheControlRuleActionParametersNoCacheRemoveDirective struct{…} Remove the directive.
Operation RulesetGetResponseRulesSetCacheControlRuleActionParametersNoCacheRemoveDirectiveOperation The operation to perform on the cache-control directive. One of the following: const RulesetGetResponseRulesSetCacheControlRuleActionParametersNoCacheRemoveDirectiveOperationSet RulesetGetResponseRulesSetCacheControlRuleActionParametersNoCacheRemoveDirectiveOperation = "set" Link to this property const RulesetGetResponseRulesSetCacheControlRuleActionParametersNoCacheRemoveDirectiveOperationRemove RulesetGetResponseRulesSetCacheControlRuleActionParametersNoCacheRemoveDirectiveOperation = "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 RulesetGetResponseRulesSetCacheControlRuleActionParametersNoStoreOptional A cache-control directive configuration. One of the following:
type RulesetGetResponseRulesSetCacheControlRuleActionParametersNoStoreSetDirective struct{…} Set the directive.
Operation RulesetGetResponseRulesSetCacheControlRuleActionParametersNoStoreSetDirectiveOperation The operation to perform on the cache-control directive. One of the following: const RulesetGetResponseRulesSetCacheControlRuleActionParametersNoStoreSetDirectiveOperationSet RulesetGetResponseRulesSetCacheControlRuleActionParametersNoStoreSetDirectiveOperation = "set" Link to this property const RulesetGetResponseRulesSetCacheControlRuleActionParametersNoStoreSetDirectiveOperationRemove RulesetGetResponseRulesSetCacheControlRuleActionParametersNoStoreSetDirectiveOperation = "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 RulesetGetResponseRulesSetCacheControlRuleActionParametersNoStoreRemoveDirective struct{…} Remove the directive.
Operation RulesetGetResponseRulesSetCacheControlRuleActionParametersNoStoreRemoveDirectiveOperation The operation to perform on the cache-control directive. One of the following: const RulesetGetResponseRulesSetCacheControlRuleActionParametersNoStoreRemoveDirectiveOperationSet RulesetGetResponseRulesSetCacheControlRuleActionParametersNoStoreRemoveDirectiveOperation = "set" Link to this property const RulesetGetResponseRulesSetCacheControlRuleActionParametersNoStoreRemoveDirectiveOperationRemove RulesetGetResponseRulesSetCacheControlRuleActionParametersNoStoreRemoveDirectiveOperation = "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 RulesetGetResponseRulesSetCacheControlRuleActionParametersNoTransformOptional A cache-control directive configuration. One of the following:
type RulesetGetResponseRulesSetCacheControlRuleActionParametersNoTransformSetDirective struct{…} Set the directive.
Operation RulesetGetResponseRulesSetCacheControlRuleActionParametersNoTransformSetDirectiveOperation The operation to perform on the cache-control directive. One of the following: const RulesetGetResponseRulesSetCacheControlRuleActionParametersNoTransformSetDirectiveOperationSet RulesetGetResponseRulesSetCacheControlRuleActionParametersNoTransformSetDirectiveOperation = "set" Link to this property const RulesetGetResponseRulesSetCacheControlRuleActionParametersNoTransformSetDirectiveOperationRemove RulesetGetResponseRulesSetCacheControlRuleActionParametersNoTransformSetDirectiveOperation = "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 RulesetGetResponseRulesSetCacheControlRuleActionParametersNoTransformRemoveDirective struct{…} Remove the directive.
Operation RulesetGetResponseRulesSetCacheControlRuleActionParametersNoTransformRemoveDirectiveOperation The operation to perform on the cache-control directive. One of the following: const RulesetGetResponseRulesSetCacheControlRuleActionParametersNoTransformRemoveDirectiveOperationSet RulesetGetResponseRulesSetCacheControlRuleActionParametersNoTransformRemoveDirectiveOperation = "set" Link to this property const RulesetGetResponseRulesSetCacheControlRuleActionParametersNoTransformRemoveDirectiveOperationRemove RulesetGetResponseRulesSetCacheControlRuleActionParametersNoTransformRemoveDirectiveOperation = "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 RulesetGetResponseRulesSetCacheControlRuleActionParametersPrivateOptional A cache-control directive configuration that accepts optional qualifiers (header names). One of the following:
type RulesetGetResponseRulesSetCacheControlRuleActionParametersPrivateSetDirective struct{…} Set the directive with optional qualifiers.
Operation RulesetGetResponseRulesSetCacheControlRuleActionParametersPrivateSetDirectiveOperation The operation to perform on the cache-control directive. One of the following: const RulesetGetResponseRulesSetCacheControlRuleActionParametersPrivateSetDirectiveOperationSet RulesetGetResponseRulesSetCacheControlRuleActionParametersPrivateSetDirectiveOperation = "set" Link to this property const RulesetGetResponseRulesSetCacheControlRuleActionParametersPrivateSetDirectiveOperationRemove RulesetGetResponseRulesSetCacheControlRuleActionParametersPrivateSetDirectiveOperation = "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 RulesetGetResponseRulesSetCacheControlRuleActionParametersPrivateRemoveDirective struct{…} Remove the directive.
Operation RulesetGetResponseRulesSetCacheControlRuleActionParametersPrivateRemoveDirectiveOperation The operation to perform on the cache-control directive. One of the following: const RulesetGetResponseRulesSetCacheControlRuleActionParametersPrivateRemoveDirectiveOperationSet RulesetGetResponseRulesSetCacheControlRuleActionParametersPrivateRemoveDirectiveOperation = "set" Link to this property const RulesetGetResponseRulesSetCacheControlRuleActionParametersPrivateRemoveDirectiveOperationRemove RulesetGetResponseRulesSetCacheControlRuleActionParametersPrivateRemoveDirectiveOperation = "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 RulesetGetResponseRulesSetCacheControlRuleActionParametersProxyRevalidateOptional A cache-control directive configuration. One of the following:
type RulesetGetResponseRulesSetCacheControlRuleActionParametersProxyRevalidateSetDirective struct{…} Set the directive.
Operation RulesetGetResponseRulesSetCacheControlRuleActionParametersProxyRevalidateSetDirectiveOperation The operation to perform on the cache-control directive. One of the following: const RulesetGetResponseRulesSetCacheControlRuleActionParametersProxyRevalidateSetDirectiveOperationSet RulesetGetResponseRulesSetCacheControlRuleActionParametersProxyRevalidateSetDirectiveOperation = "set" Link to this property const RulesetGetResponseRulesSetCacheControlRuleActionParametersProxyRevalidateSetDirectiveOperationRemove RulesetGetResponseRulesSetCacheControlRuleActionParametersProxyRevalidateSetDirectiveOperation = "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 RulesetGetResponseRulesSetCacheControlRuleActionParametersProxyRevalidateRemoveDirective struct{…} Remove the directive.
Operation RulesetGetResponseRulesSetCacheControlRuleActionParametersProxyRevalidateRemoveDirectiveOperation The operation to perform on the cache-control directive. One of the following: const RulesetGetResponseRulesSetCacheControlRuleActionParametersProxyRevalidateRemoveDirectiveOperationSet RulesetGetResponseRulesSetCacheControlRuleActionParametersProxyRevalidateRemoveDirectiveOperation = "set" Link to this property const RulesetGetResponseRulesSetCacheControlRuleActionParametersProxyRevalidateRemoveDirectiveOperationRemove RulesetGetResponseRulesSetCacheControlRuleActionParametersProxyRevalidateRemoveDirectiveOperation = "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 RulesetGetResponseRulesSetCacheControlRuleActionParametersPublicOptional A cache-control directive configuration. One of the following:
type RulesetGetResponseRulesSetCacheControlRuleActionParametersPublicSetDirective struct{…} Set the directive.
Operation RulesetGetResponseRulesSetCacheControlRuleActionParametersPublicSetDirectiveOperation The operation to perform on the cache-control directive. One of the following: const RulesetGetResponseRulesSetCacheControlRuleActionParametersPublicSetDirectiveOperationSet RulesetGetResponseRulesSetCacheControlRuleActionParametersPublicSetDirectiveOperation = "set" Link to this property const RulesetGetResponseRulesSetCacheControlRuleActionParametersPublicSetDirectiveOperationRemove RulesetGetResponseRulesSetCacheControlRuleActionParametersPublicSetDirectiveOperation = "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 RulesetGetResponseRulesSetCacheControlRuleActionParametersPublicRemoveDirective struct{…} Remove the directive.
Operation RulesetGetResponseRulesSetCacheControlRuleActionParametersPublicRemoveDirectiveOperation The operation to perform on the cache-control directive. One of the following: const RulesetGetResponseRulesSetCacheControlRuleActionParametersPublicRemoveDirectiveOperationSet RulesetGetResponseRulesSetCacheControlRuleActionParametersPublicRemoveDirectiveOperation = "set" Link to this property const RulesetGetResponseRulesSetCacheControlRuleActionParametersPublicRemoveDirectiveOperationRemove RulesetGetResponseRulesSetCacheControlRuleActionParametersPublicRemoveDirectiveOperation = "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 RulesetGetResponseRulesSetCacheControlRuleActionParametersSMaxageOptional A cache-control directive configuration that accepts a duration value in seconds. One of the following:
type RulesetGetResponseRulesSetCacheControlRuleActionParametersSMaxageSetDirective struct{…} Set the directive with a duration value in seconds.
Operation RulesetGetResponseRulesSetCacheControlRuleActionParametersSMaxageSetDirectiveOperation The operation to perform on the cache-control directive. One of the following: const RulesetGetResponseRulesSetCacheControlRuleActionParametersSMaxageSetDirectiveOperationSet RulesetGetResponseRulesSetCacheControlRuleActionParametersSMaxageSetDirectiveOperation = "set" Link to this property const RulesetGetResponseRulesSetCacheControlRuleActionParametersSMaxageSetDirectiveOperationRemove RulesetGetResponseRulesSetCacheControlRuleActionParametersSMaxageSetDirectiveOperation = "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 RulesetGetResponseRulesSetCacheControlRuleActionParametersSMaxageRemoveDirective struct{…} Remove the directive.
Operation RulesetGetResponseRulesSetCacheControlRuleActionParametersSMaxageRemoveDirectiveOperation The operation to perform on the cache-control directive. One of the following: const RulesetGetResponseRulesSetCacheControlRuleActionParametersSMaxageRemoveDirectiveOperationSet RulesetGetResponseRulesSetCacheControlRuleActionParametersSMaxageRemoveDirectiveOperation = "set" Link to this property const RulesetGetResponseRulesSetCacheControlRuleActionParametersSMaxageRemoveDirectiveOperationRemove RulesetGetResponseRulesSetCacheControlRuleActionParametersSMaxageRemoveDirectiveOperation = "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 RulesetGetResponseRulesSetCacheControlRuleActionParametersStaleIfErrorOptional A cache-control directive configuration that accepts a duration value in seconds. One of the following:
type RulesetGetResponseRulesSetCacheControlRuleActionParametersStaleIfErrorSetDirective struct{…} Set the directive with a duration value in seconds.
Operation RulesetGetResponseRulesSetCacheControlRuleActionParametersStaleIfErrorSetDirectiveOperation The operation to perform on the cache-control directive. One of the following: const RulesetGetResponseRulesSetCacheControlRuleActionParametersStaleIfErrorSetDirectiveOperationSet RulesetGetResponseRulesSetCacheControlRuleActionParametersStaleIfErrorSetDirectiveOperation = "set" Link to this property const RulesetGetResponseRulesSetCacheControlRuleActionParametersStaleIfErrorSetDirectiveOperationRemove RulesetGetResponseRulesSetCacheControlRuleActionParametersStaleIfErrorSetDirectiveOperation = "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 RulesetGetResponseRulesSetCacheControlRuleActionParametersStaleIfErrorRemoveDirective struct{…} Remove the directive.
Operation RulesetGetResponseRulesSetCacheControlRuleActionParametersStaleIfErrorRemoveDirectiveOperation The operation to perform on the cache-control directive. One of the following: const RulesetGetResponseRulesSetCacheControlRuleActionParametersStaleIfErrorRemoveDirectiveOperationSet RulesetGetResponseRulesSetCacheControlRuleActionParametersStaleIfErrorRemoveDirectiveOperation = "set" Link to this property const RulesetGetResponseRulesSetCacheControlRuleActionParametersStaleIfErrorRemoveDirectiveOperationRemove RulesetGetResponseRulesSetCacheControlRuleActionParametersStaleIfErrorRemoveDirectiveOperation = "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 RulesetGetResponseRulesSetCacheControlRuleActionParametersStaleWhileRevalidateOptional A cache-control directive configuration that accepts a duration value in seconds. One of the following:
type RulesetGetResponseRulesSetCacheControlRuleActionParametersStaleWhileRevalidateSetDirective struct{…} Set the directive with a duration value in seconds.
Operation RulesetGetResponseRulesSetCacheControlRuleActionParametersStaleWhileRevalidateSetDirectiveOperation The operation to perform on the cache-control directive. One of the following: const RulesetGetResponseRulesSetCacheControlRuleActionParametersStaleWhileRevalidateSetDirectiveOperationSet RulesetGetResponseRulesSetCacheControlRuleActionParametersStaleWhileRevalidateSetDirectiveOperation = "set" Link to this property const RulesetGetResponseRulesSetCacheControlRuleActionParametersStaleWhileRevalidateSetDirectiveOperationRemove RulesetGetResponseRulesSetCacheControlRuleActionParametersStaleWhileRevalidateSetDirectiveOperation = "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 RulesetGetResponseRulesSetCacheControlRuleActionParametersStaleWhileRevalidateRemoveDirective struct{…} Remove the directive.
Operation RulesetGetResponseRulesSetCacheControlRuleActionParametersStaleWhileRevalidateRemoveDirectiveOperation The operation to perform on the cache-control directive. One of the following: const RulesetGetResponseRulesSetCacheControlRuleActionParametersStaleWhileRevalidateRemoveDirectiveOperationSet RulesetGetResponseRulesSetCacheControlRuleActionParametersStaleWhileRevalidateRemoveDirectiveOperation = "set" Link to this property const RulesetGetResponseRulesSetCacheControlRuleActionParametersStaleWhileRevalidateRemoveDirectiveOperationRemove RulesetGetResponseRulesSetCacheControlRuleActionParametersStaleWhileRevalidateRemoveDirectiveOperation = "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 RulesetGetResponseRulesSetCacheControlRuleExposedCredentialCheckOptional 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 RulesetGetResponseRulesSetCacheControlRuleRatelimitOptional 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 RulesetGetResponseRulesSetCacheSettingsRule 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 RulesetGetResponseRulesSetCacheTagsRule struct{…} ID string The unique ID of the rule. Link to this property Action RulesetGetResponseRulesSetCacheTagsRuleAction 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 RulesetGetResponseRulesSetCacheTagsRuleActionParametersOptional The parameters configuring the rule’s action. One of the following:
type RulesetGetResponseRulesSetCacheTagsRuleActionParametersAddCacheTagsValues struct{…} Add cache tags using a list of values.
Operation RulesetGetResponseRulesSetCacheTagsRuleActionParametersAddCacheTagsValuesOperation The operation to perform on the cache tags. One of the following: const RulesetGetResponseRulesSetCacheTagsRuleActionParametersAddCacheTagsValuesOperationAdd RulesetGetResponseRulesSetCacheTagsRuleActionParametersAddCacheTagsValuesOperation = "add" Link to this property const RulesetGetResponseRulesSetCacheTagsRuleActionParametersAddCacheTagsValuesOperationRemove RulesetGetResponseRulesSetCacheTagsRuleActionParametersAddCacheTagsValuesOperation = "remove" Link to this property const RulesetGetResponseRulesSetCacheTagsRuleActionParametersAddCacheTagsValuesOperationSet RulesetGetResponseRulesSetCacheTagsRuleActionParametersAddCacheTagsValuesOperation = "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 RulesetGetResponseRulesSetCacheTagsRuleActionParametersAddCacheTagsExpression 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 RulesetGetResponseRulesSetCacheTagsRuleActionParametersAddCacheTagsExpressionOperation The operation to perform on the cache tags. One of the following: const RulesetGetResponseRulesSetCacheTagsRuleActionParametersAddCacheTagsExpressionOperationAdd RulesetGetResponseRulesSetCacheTagsRuleActionParametersAddCacheTagsExpressionOperation = "add" Link to this property const RulesetGetResponseRulesSetCacheTagsRuleActionParametersAddCacheTagsExpressionOperationRemove RulesetGetResponseRulesSetCacheTagsRuleActionParametersAddCacheTagsExpressionOperation = "remove" Link to this property const RulesetGetResponseRulesSetCacheTagsRuleActionParametersAddCacheTagsExpressionOperationSet RulesetGetResponseRulesSetCacheTagsRuleActionParametersAddCacheTagsExpressionOperation = "set" Link to this property
Link to this property
Link to this property
type RulesetGetResponseRulesSetCacheTagsRuleActionParametersRemoveCacheTagsValues struct{…} Remove cache tags using a list of values.
Operation RulesetGetResponseRulesSetCacheTagsRuleActionParametersRemoveCacheTagsValuesOperation The operation to perform on the cache tags. One of the following: const RulesetGetResponseRulesSetCacheTagsRuleActionParametersRemoveCacheTagsValuesOperationAdd RulesetGetResponseRulesSetCacheTagsRuleActionParametersRemoveCacheTagsValuesOperation = "add" Link to this property const RulesetGetResponseRulesSetCacheTagsRuleActionParametersRemoveCacheTagsValuesOperationRemove RulesetGetResponseRulesSetCacheTagsRuleActionParametersRemoveCacheTagsValuesOperation = "remove" Link to this property const RulesetGetResponseRulesSetCacheTagsRuleActionParametersRemoveCacheTagsValuesOperationSet RulesetGetResponseRulesSetCacheTagsRuleActionParametersRemoveCacheTagsValuesOperation = "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 RulesetGetResponseRulesSetCacheTagsRuleActionParametersRemoveCacheTagsExpression 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 RulesetGetResponseRulesSetCacheTagsRuleActionParametersRemoveCacheTagsExpressionOperation The operation to perform on the cache tags. One of the following: const RulesetGetResponseRulesSetCacheTagsRuleActionParametersRemoveCacheTagsExpressionOperationAdd RulesetGetResponseRulesSetCacheTagsRuleActionParametersRemoveCacheTagsExpressionOperation = "add" Link to this property const RulesetGetResponseRulesSetCacheTagsRuleActionParametersRemoveCacheTagsExpressionOperationRemove RulesetGetResponseRulesSetCacheTagsRuleActionParametersRemoveCacheTagsExpressionOperation = "remove" Link to this property const RulesetGetResponseRulesSetCacheTagsRuleActionParametersRemoveCacheTagsExpressionOperationSet RulesetGetResponseRulesSetCacheTagsRuleActionParametersRemoveCacheTagsExpressionOperation = "set" Link to this property
Link to this property
Link to this property
type RulesetGetResponseRulesSetCacheTagsRuleActionParametersSetCacheTagsValues struct{…} Set cache tags using a list of values.
Operation RulesetGetResponseRulesSetCacheTagsRuleActionParametersSetCacheTagsValuesOperation The operation to perform on the cache tags. One of the following: const RulesetGetResponseRulesSetCacheTagsRuleActionParametersSetCacheTagsValuesOperationAdd RulesetGetResponseRulesSetCacheTagsRuleActionParametersSetCacheTagsValuesOperation = "add" Link to this property const RulesetGetResponseRulesSetCacheTagsRuleActionParametersSetCacheTagsValuesOperationRemove RulesetGetResponseRulesSetCacheTagsRuleActionParametersSetCacheTagsValuesOperation = "remove" Link to this property const RulesetGetResponseRulesSetCacheTagsRuleActionParametersSetCacheTagsValuesOperationSet RulesetGetResponseRulesSetCacheTagsRuleActionParametersSetCacheTagsValuesOperation = "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 RulesetGetResponseRulesSetCacheTagsRuleActionParametersSetCacheTagsExpression 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 RulesetGetResponseRulesSetCacheTagsRuleActionParametersSetCacheTagsExpressionOperation The operation to perform on the cache tags. One of the following: const RulesetGetResponseRulesSetCacheTagsRuleActionParametersSetCacheTagsExpressionOperationAdd RulesetGetResponseRulesSetCacheTagsRuleActionParametersSetCacheTagsExpressionOperation = "add" Link to this property const RulesetGetResponseRulesSetCacheTagsRuleActionParametersSetCacheTagsExpressionOperationRemove RulesetGetResponseRulesSetCacheTagsRuleActionParametersSetCacheTagsExpressionOperation = "remove" Link to this property const RulesetGetResponseRulesSetCacheTagsRuleActionParametersSetCacheTagsExpressionOperationSet RulesetGetResponseRulesSetCacheTagsRuleActionParametersSetCacheTagsExpressionOperation = "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 RulesetGetResponseRulesSetCacheTagsRuleExposedCredentialCheckOptional 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 RulesetGetResponseRulesSetCacheTagsRuleRatelimitOptional 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 RulesetGetResponseRulesSetConfigurationRule 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 RulesetGetResponseRulesSkipRule 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 RulesetGetResponseRulesTransformResponseHTMLRule struct{…} ID string The unique ID of the rule. Link to this property Action RulesetGetResponseRulesTransformResponseHTMLRuleAction 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 RulesetGetResponseRulesTransformResponseHTMLRuleActionParametersOptional 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 RulesetGetResponseRulesTransformResponseHTMLRuleExposedCredentialCheckOptional 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 RulesetGetResponseRulesTransformResponseHTMLRuleRatelimitOptional 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](<#(resource)%20rulesets%20%3E%20(model)%20RulesetGetResponse%20%3E%20(schema)>) ### Get an account or zone ruleset Go HTTPTypeScriptPythonGoTerraform ``` package main import ( "context" "fmt" "github.com/cloudflare/cloudflare-go" "github.com/cloudflare/cloudflare-go/option" "github.com/cloudflare/cloudflare-go/rulesets" ) func main() { client := cloudflare.NewClient( option.WithAPIToken("Sn3lZJTBX6kkg7OdcBUAxOO963GEIyGQqnFTOFYY"), ) ruleset, err := client.Rulesets.Get( context.TODO(), "2f2feab2026849078ba485f918791bdc", rulesets.RulesetGetParams{ }, ) if err != nil { panic(err.Error()) } fmt.Printf("%+v\n", ruleset.ID) } ``` 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 } ```