--- title: Get an account or zone ruleset version --- [Skip to content](#_top) [API Reference](https://developers.cloudflare.com/api/go) [Rulesets](https://developers.cloudflare.com/api/go/resources/rulesets) [Versions](https://developers.cloudflare.com/api/go/resources/rulesets/subresources/versions) Copy Markdown Open in **Claude**Open in **ChatGPT**Open in **Cursor** --- **Copy Markdown****View as Markdown** # Get an account or zone ruleset version client.Rulesets.Versions.Get(ctx, rulesetID, rulesetVersion, query) (\*[VersionGetResponse](), error) GET/{accounts\_or\_zones}/{account\_or\_zone\_id}/rulesets/{ruleset\_id}/versions/{ruleset\_version} Fetches a specific 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.versions%20%3E%20(method)%20get%20%3E%20(params)%20default%20%3E%20(param)%20ruleset_id%20%3E%20(schema)>) rulesetVersion string The version of the ruleset. [Link to this property](<#(resource)%20rulesets.versions%20%3E%20(method)%20get%20%3E%20(params)%20default%20%3E%20(param)%20ruleset_version%20%3E%20(schema)>)
query VersionGetParams 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.versions%20%3E%20(method)%20get%20%3E%20(params)%20default>) ##### ReturnsExpand Collapse
type VersionGetResponse 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 \[]VersionGetResponseRule The list of rules in the ruleset. One of the following:
type VersionGetResponseRulesBlockRule 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 VersionGetResponseRulesChallengeRule struct{…} ID string The unique ID of the rule. Link to this property Action VersionGetResponseRulesChallengeRuleAction 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 VersionGetResponseRulesChallengeRuleExposedCredentialCheckOptional 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 VersionGetResponseRulesChallengeRuleRatelimitOptional 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 VersionGetResponseRulesResponseCompressionRule 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 VersionGetResponseRulesDDoSDynamicRule 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 VersionGetResponseRulesExecuteRule 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 VersionGetResponseRulesForceConnectionCloseRule 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 VersionGetResponseRulesJavaScriptChallengeRule struct{…} ID string The unique ID of the rule. Link to this property Action VersionGetResponseRulesJavaScriptChallengeRuleAction 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 VersionGetResponseRulesJavaScriptChallengeRuleExposedCredentialCheckOptional 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 VersionGetResponseRulesJavaScriptChallengeRuleRatelimitOptional 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 VersionGetResponseRulesLogRule 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 VersionGetResponseRulesLogCustomFieldRule 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 VersionGetResponseRulesManagedChallengeRule 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 VersionGetResponseRulesRedirectRule 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 VersionGetResponseRulesRewriteRule 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 VersionGetResponseRulesRouteRule 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 VersionGetResponseRulesScoreRule 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 VersionGetResponseRulesServeErrorRule 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 VersionGetResponseRulesSetCacheControlRule struct{…} ID string The unique ID of the rule. Link to this property Action VersionGetResponseRulesSetCacheControlRuleAction 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 VersionGetResponseRulesSetCacheControlRuleActionParametersOptional The parameters configuring the rule’s action.
Immutable VersionGetResponseRulesSetCacheControlRuleActionParametersImmutableOptional A cache-control directive configuration. One of the following:
type VersionGetResponseRulesSetCacheControlRuleActionParametersImmutableSetDirective struct{…} Set the directive.
Operation VersionGetResponseRulesSetCacheControlRuleActionParametersImmutableSetDirectiveOperation The operation to perform on the cache-control directive. One of the following: const VersionGetResponseRulesSetCacheControlRuleActionParametersImmutableSetDirectiveOperationSet VersionGetResponseRulesSetCacheControlRuleActionParametersImmutableSetDirectiveOperation = "set" Link to this property const VersionGetResponseRulesSetCacheControlRuleActionParametersImmutableSetDirectiveOperationRemove VersionGetResponseRulesSetCacheControlRuleActionParametersImmutableSetDirectiveOperation = "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 VersionGetResponseRulesSetCacheControlRuleActionParametersImmutableRemoveDirective struct{…} Remove the directive.
Operation VersionGetResponseRulesSetCacheControlRuleActionParametersImmutableRemoveDirectiveOperation The operation to perform on the cache-control directive. One of the following: const VersionGetResponseRulesSetCacheControlRuleActionParametersImmutableRemoveDirectiveOperationSet VersionGetResponseRulesSetCacheControlRuleActionParametersImmutableRemoveDirectiveOperation = "set" Link to this property const VersionGetResponseRulesSetCacheControlRuleActionParametersImmutableRemoveDirectiveOperationRemove VersionGetResponseRulesSetCacheControlRuleActionParametersImmutableRemoveDirectiveOperation = "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 VersionGetResponseRulesSetCacheControlRuleActionParametersMaxAgeOptional A cache-control directive configuration that accepts a duration value in seconds. One of the following:
type VersionGetResponseRulesSetCacheControlRuleActionParametersMaxAgeSetDirective struct{…} Set the directive with a duration value in seconds.
Operation VersionGetResponseRulesSetCacheControlRuleActionParametersMaxAgeSetDirectiveOperation The operation to perform on the cache-control directive. One of the following: const VersionGetResponseRulesSetCacheControlRuleActionParametersMaxAgeSetDirectiveOperationSet VersionGetResponseRulesSetCacheControlRuleActionParametersMaxAgeSetDirectiveOperation = "set" Link to this property const VersionGetResponseRulesSetCacheControlRuleActionParametersMaxAgeSetDirectiveOperationRemove VersionGetResponseRulesSetCacheControlRuleActionParametersMaxAgeSetDirectiveOperation = "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 VersionGetResponseRulesSetCacheControlRuleActionParametersMaxAgeRemoveDirective struct{…} Remove the directive.
Operation VersionGetResponseRulesSetCacheControlRuleActionParametersMaxAgeRemoveDirectiveOperation The operation to perform on the cache-control directive. One of the following: const VersionGetResponseRulesSetCacheControlRuleActionParametersMaxAgeRemoveDirectiveOperationSet VersionGetResponseRulesSetCacheControlRuleActionParametersMaxAgeRemoveDirectiveOperation = "set" Link to this property const VersionGetResponseRulesSetCacheControlRuleActionParametersMaxAgeRemoveDirectiveOperationRemove VersionGetResponseRulesSetCacheControlRuleActionParametersMaxAgeRemoveDirectiveOperation = "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 VersionGetResponseRulesSetCacheControlRuleActionParametersMustRevalidateOptional A cache-control directive configuration. One of the following:
type VersionGetResponseRulesSetCacheControlRuleActionParametersMustRevalidateSetDirective struct{…} Set the directive.
Operation VersionGetResponseRulesSetCacheControlRuleActionParametersMustRevalidateSetDirectiveOperation The operation to perform on the cache-control directive. One of the following: const VersionGetResponseRulesSetCacheControlRuleActionParametersMustRevalidateSetDirectiveOperationSet VersionGetResponseRulesSetCacheControlRuleActionParametersMustRevalidateSetDirectiveOperation = "set" Link to this property const VersionGetResponseRulesSetCacheControlRuleActionParametersMustRevalidateSetDirectiveOperationRemove VersionGetResponseRulesSetCacheControlRuleActionParametersMustRevalidateSetDirectiveOperation = "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 VersionGetResponseRulesSetCacheControlRuleActionParametersMustRevalidateRemoveDirective struct{…} Remove the directive.
Operation VersionGetResponseRulesSetCacheControlRuleActionParametersMustRevalidateRemoveDirectiveOperation The operation to perform on the cache-control directive. One of the following: const VersionGetResponseRulesSetCacheControlRuleActionParametersMustRevalidateRemoveDirectiveOperationSet VersionGetResponseRulesSetCacheControlRuleActionParametersMustRevalidateRemoveDirectiveOperation = "set" Link to this property const VersionGetResponseRulesSetCacheControlRuleActionParametersMustRevalidateRemoveDirectiveOperationRemove VersionGetResponseRulesSetCacheControlRuleActionParametersMustRevalidateRemoveDirectiveOperation = "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 VersionGetResponseRulesSetCacheControlRuleActionParametersMustUnderstandOptional A cache-control directive configuration. One of the following:
type VersionGetResponseRulesSetCacheControlRuleActionParametersMustUnderstandSetDirective struct{…} Set the directive.
Operation VersionGetResponseRulesSetCacheControlRuleActionParametersMustUnderstandSetDirectiveOperation The operation to perform on the cache-control directive. One of the following: const VersionGetResponseRulesSetCacheControlRuleActionParametersMustUnderstandSetDirectiveOperationSet VersionGetResponseRulesSetCacheControlRuleActionParametersMustUnderstandSetDirectiveOperation = "set" Link to this property const VersionGetResponseRulesSetCacheControlRuleActionParametersMustUnderstandSetDirectiveOperationRemove VersionGetResponseRulesSetCacheControlRuleActionParametersMustUnderstandSetDirectiveOperation = "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 VersionGetResponseRulesSetCacheControlRuleActionParametersMustUnderstandRemoveDirective struct{…} Remove the directive.
Operation VersionGetResponseRulesSetCacheControlRuleActionParametersMustUnderstandRemoveDirectiveOperation The operation to perform on the cache-control directive. One of the following: const VersionGetResponseRulesSetCacheControlRuleActionParametersMustUnderstandRemoveDirectiveOperationSet VersionGetResponseRulesSetCacheControlRuleActionParametersMustUnderstandRemoveDirectiveOperation = "set" Link to this property const VersionGetResponseRulesSetCacheControlRuleActionParametersMustUnderstandRemoveDirectiveOperationRemove VersionGetResponseRulesSetCacheControlRuleActionParametersMustUnderstandRemoveDirectiveOperation = "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 VersionGetResponseRulesSetCacheControlRuleActionParametersNoCacheOptional A cache-control directive configuration that accepts optional qualifiers (header names). One of the following:
type VersionGetResponseRulesSetCacheControlRuleActionParametersNoCacheSetDirective struct{…} Set the directive with optional qualifiers.
Operation VersionGetResponseRulesSetCacheControlRuleActionParametersNoCacheSetDirectiveOperation The operation to perform on the cache-control directive. One of the following: const VersionGetResponseRulesSetCacheControlRuleActionParametersNoCacheSetDirectiveOperationSet VersionGetResponseRulesSetCacheControlRuleActionParametersNoCacheSetDirectiveOperation = "set" Link to this property const VersionGetResponseRulesSetCacheControlRuleActionParametersNoCacheSetDirectiveOperationRemove VersionGetResponseRulesSetCacheControlRuleActionParametersNoCacheSetDirectiveOperation = "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 VersionGetResponseRulesSetCacheControlRuleActionParametersNoCacheRemoveDirective struct{…} Remove the directive.
Operation VersionGetResponseRulesSetCacheControlRuleActionParametersNoCacheRemoveDirectiveOperation The operation to perform on the cache-control directive. One of the following: const VersionGetResponseRulesSetCacheControlRuleActionParametersNoCacheRemoveDirectiveOperationSet VersionGetResponseRulesSetCacheControlRuleActionParametersNoCacheRemoveDirectiveOperation = "set" Link to this property const VersionGetResponseRulesSetCacheControlRuleActionParametersNoCacheRemoveDirectiveOperationRemove VersionGetResponseRulesSetCacheControlRuleActionParametersNoCacheRemoveDirectiveOperation = "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 VersionGetResponseRulesSetCacheControlRuleActionParametersNoStoreOptional A cache-control directive configuration. One of the following:
type VersionGetResponseRulesSetCacheControlRuleActionParametersNoStoreSetDirective struct{…} Set the directive.
Operation VersionGetResponseRulesSetCacheControlRuleActionParametersNoStoreSetDirectiveOperation The operation to perform on the cache-control directive. One of the following: const VersionGetResponseRulesSetCacheControlRuleActionParametersNoStoreSetDirectiveOperationSet VersionGetResponseRulesSetCacheControlRuleActionParametersNoStoreSetDirectiveOperation = "set" Link to this property const VersionGetResponseRulesSetCacheControlRuleActionParametersNoStoreSetDirectiveOperationRemove VersionGetResponseRulesSetCacheControlRuleActionParametersNoStoreSetDirectiveOperation = "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 VersionGetResponseRulesSetCacheControlRuleActionParametersNoStoreRemoveDirective struct{…} Remove the directive.
Operation VersionGetResponseRulesSetCacheControlRuleActionParametersNoStoreRemoveDirectiveOperation The operation to perform on the cache-control directive. One of the following: const VersionGetResponseRulesSetCacheControlRuleActionParametersNoStoreRemoveDirectiveOperationSet VersionGetResponseRulesSetCacheControlRuleActionParametersNoStoreRemoveDirectiveOperation = "set" Link to this property const VersionGetResponseRulesSetCacheControlRuleActionParametersNoStoreRemoveDirectiveOperationRemove VersionGetResponseRulesSetCacheControlRuleActionParametersNoStoreRemoveDirectiveOperation = "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 VersionGetResponseRulesSetCacheControlRuleActionParametersNoTransformOptional A cache-control directive configuration. One of the following:
type VersionGetResponseRulesSetCacheControlRuleActionParametersNoTransformSetDirective struct{…} Set the directive.
Operation VersionGetResponseRulesSetCacheControlRuleActionParametersNoTransformSetDirectiveOperation The operation to perform on the cache-control directive. One of the following: const VersionGetResponseRulesSetCacheControlRuleActionParametersNoTransformSetDirectiveOperationSet VersionGetResponseRulesSetCacheControlRuleActionParametersNoTransformSetDirectiveOperation = "set" Link to this property const VersionGetResponseRulesSetCacheControlRuleActionParametersNoTransformSetDirectiveOperationRemove VersionGetResponseRulesSetCacheControlRuleActionParametersNoTransformSetDirectiveOperation = "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 VersionGetResponseRulesSetCacheControlRuleActionParametersNoTransformRemoveDirective struct{…} Remove the directive.
Operation VersionGetResponseRulesSetCacheControlRuleActionParametersNoTransformRemoveDirectiveOperation The operation to perform on the cache-control directive. One of the following: const VersionGetResponseRulesSetCacheControlRuleActionParametersNoTransformRemoveDirectiveOperationSet VersionGetResponseRulesSetCacheControlRuleActionParametersNoTransformRemoveDirectiveOperation = "set" Link to this property const VersionGetResponseRulesSetCacheControlRuleActionParametersNoTransformRemoveDirectiveOperationRemove VersionGetResponseRulesSetCacheControlRuleActionParametersNoTransformRemoveDirectiveOperation = "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 VersionGetResponseRulesSetCacheControlRuleActionParametersPrivateOptional A cache-control directive configuration that accepts optional qualifiers (header names). One of the following:
type VersionGetResponseRulesSetCacheControlRuleActionParametersPrivateSetDirective struct{…} Set the directive with optional qualifiers.
Operation VersionGetResponseRulesSetCacheControlRuleActionParametersPrivateSetDirectiveOperation The operation to perform on the cache-control directive. One of the following: const VersionGetResponseRulesSetCacheControlRuleActionParametersPrivateSetDirectiveOperationSet VersionGetResponseRulesSetCacheControlRuleActionParametersPrivateSetDirectiveOperation = "set" Link to this property const VersionGetResponseRulesSetCacheControlRuleActionParametersPrivateSetDirectiveOperationRemove VersionGetResponseRulesSetCacheControlRuleActionParametersPrivateSetDirectiveOperation = "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 VersionGetResponseRulesSetCacheControlRuleActionParametersPrivateRemoveDirective struct{…} Remove the directive.
Operation VersionGetResponseRulesSetCacheControlRuleActionParametersPrivateRemoveDirectiveOperation The operation to perform on the cache-control directive. One of the following: const VersionGetResponseRulesSetCacheControlRuleActionParametersPrivateRemoveDirectiveOperationSet VersionGetResponseRulesSetCacheControlRuleActionParametersPrivateRemoveDirectiveOperation = "set" Link to this property const VersionGetResponseRulesSetCacheControlRuleActionParametersPrivateRemoveDirectiveOperationRemove VersionGetResponseRulesSetCacheControlRuleActionParametersPrivateRemoveDirectiveOperation = "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 VersionGetResponseRulesSetCacheControlRuleActionParametersProxyRevalidateOptional A cache-control directive configuration. One of the following:
type VersionGetResponseRulesSetCacheControlRuleActionParametersProxyRevalidateSetDirective struct{…} Set the directive.
Operation VersionGetResponseRulesSetCacheControlRuleActionParametersProxyRevalidateSetDirectiveOperation The operation to perform on the cache-control directive. One of the following: const VersionGetResponseRulesSetCacheControlRuleActionParametersProxyRevalidateSetDirectiveOperationSet VersionGetResponseRulesSetCacheControlRuleActionParametersProxyRevalidateSetDirectiveOperation = "set" Link to this property const VersionGetResponseRulesSetCacheControlRuleActionParametersProxyRevalidateSetDirectiveOperationRemove VersionGetResponseRulesSetCacheControlRuleActionParametersProxyRevalidateSetDirectiveOperation = "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 VersionGetResponseRulesSetCacheControlRuleActionParametersProxyRevalidateRemoveDirective struct{…} Remove the directive.
Operation VersionGetResponseRulesSetCacheControlRuleActionParametersProxyRevalidateRemoveDirectiveOperation The operation to perform on the cache-control directive. One of the following: const VersionGetResponseRulesSetCacheControlRuleActionParametersProxyRevalidateRemoveDirectiveOperationSet VersionGetResponseRulesSetCacheControlRuleActionParametersProxyRevalidateRemoveDirectiveOperation = "set" Link to this property const VersionGetResponseRulesSetCacheControlRuleActionParametersProxyRevalidateRemoveDirectiveOperationRemove VersionGetResponseRulesSetCacheControlRuleActionParametersProxyRevalidateRemoveDirectiveOperation = "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 VersionGetResponseRulesSetCacheControlRuleActionParametersPublicOptional A cache-control directive configuration. One of the following:
type VersionGetResponseRulesSetCacheControlRuleActionParametersPublicSetDirective struct{…} Set the directive.
Operation VersionGetResponseRulesSetCacheControlRuleActionParametersPublicSetDirectiveOperation The operation to perform on the cache-control directive. One of the following: const VersionGetResponseRulesSetCacheControlRuleActionParametersPublicSetDirectiveOperationSet VersionGetResponseRulesSetCacheControlRuleActionParametersPublicSetDirectiveOperation = "set" Link to this property const VersionGetResponseRulesSetCacheControlRuleActionParametersPublicSetDirectiveOperationRemove VersionGetResponseRulesSetCacheControlRuleActionParametersPublicSetDirectiveOperation = "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 VersionGetResponseRulesSetCacheControlRuleActionParametersPublicRemoveDirective struct{…} Remove the directive.
Operation VersionGetResponseRulesSetCacheControlRuleActionParametersPublicRemoveDirectiveOperation The operation to perform on the cache-control directive. One of the following: const VersionGetResponseRulesSetCacheControlRuleActionParametersPublicRemoveDirectiveOperationSet VersionGetResponseRulesSetCacheControlRuleActionParametersPublicRemoveDirectiveOperation = "set" Link to this property const VersionGetResponseRulesSetCacheControlRuleActionParametersPublicRemoveDirectiveOperationRemove VersionGetResponseRulesSetCacheControlRuleActionParametersPublicRemoveDirectiveOperation = "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 VersionGetResponseRulesSetCacheControlRuleActionParametersSMaxageOptional A cache-control directive configuration that accepts a duration value in seconds. One of the following:
type VersionGetResponseRulesSetCacheControlRuleActionParametersSMaxageSetDirective struct{…} Set the directive with a duration value in seconds.
Operation VersionGetResponseRulesSetCacheControlRuleActionParametersSMaxageSetDirectiveOperation The operation to perform on the cache-control directive. One of the following: const VersionGetResponseRulesSetCacheControlRuleActionParametersSMaxageSetDirectiveOperationSet VersionGetResponseRulesSetCacheControlRuleActionParametersSMaxageSetDirectiveOperation = "set" Link to this property const VersionGetResponseRulesSetCacheControlRuleActionParametersSMaxageSetDirectiveOperationRemove VersionGetResponseRulesSetCacheControlRuleActionParametersSMaxageSetDirectiveOperation = "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 VersionGetResponseRulesSetCacheControlRuleActionParametersSMaxageRemoveDirective struct{…} Remove the directive.
Operation VersionGetResponseRulesSetCacheControlRuleActionParametersSMaxageRemoveDirectiveOperation The operation to perform on the cache-control directive. One of the following: const VersionGetResponseRulesSetCacheControlRuleActionParametersSMaxageRemoveDirectiveOperationSet VersionGetResponseRulesSetCacheControlRuleActionParametersSMaxageRemoveDirectiveOperation = "set" Link to this property const VersionGetResponseRulesSetCacheControlRuleActionParametersSMaxageRemoveDirectiveOperationRemove VersionGetResponseRulesSetCacheControlRuleActionParametersSMaxageRemoveDirectiveOperation = "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 VersionGetResponseRulesSetCacheControlRuleActionParametersStaleIfErrorOptional A cache-control directive configuration that accepts a duration value in seconds. One of the following:
type VersionGetResponseRulesSetCacheControlRuleActionParametersStaleIfErrorSetDirective struct{…} Set the directive with a duration value in seconds.
Operation VersionGetResponseRulesSetCacheControlRuleActionParametersStaleIfErrorSetDirectiveOperation The operation to perform on the cache-control directive. One of the following: const VersionGetResponseRulesSetCacheControlRuleActionParametersStaleIfErrorSetDirectiveOperationSet VersionGetResponseRulesSetCacheControlRuleActionParametersStaleIfErrorSetDirectiveOperation = "set" Link to this property const VersionGetResponseRulesSetCacheControlRuleActionParametersStaleIfErrorSetDirectiveOperationRemove VersionGetResponseRulesSetCacheControlRuleActionParametersStaleIfErrorSetDirectiveOperation = "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 VersionGetResponseRulesSetCacheControlRuleActionParametersStaleIfErrorRemoveDirective struct{…} Remove the directive.
Operation VersionGetResponseRulesSetCacheControlRuleActionParametersStaleIfErrorRemoveDirectiveOperation The operation to perform on the cache-control directive. One of the following: const VersionGetResponseRulesSetCacheControlRuleActionParametersStaleIfErrorRemoveDirectiveOperationSet VersionGetResponseRulesSetCacheControlRuleActionParametersStaleIfErrorRemoveDirectiveOperation = "set" Link to this property const VersionGetResponseRulesSetCacheControlRuleActionParametersStaleIfErrorRemoveDirectiveOperationRemove VersionGetResponseRulesSetCacheControlRuleActionParametersStaleIfErrorRemoveDirectiveOperation = "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 VersionGetResponseRulesSetCacheControlRuleActionParametersStaleWhileRevalidateOptional A cache-control directive configuration that accepts a duration value in seconds. One of the following:
type VersionGetResponseRulesSetCacheControlRuleActionParametersStaleWhileRevalidateSetDirective struct{…} Set the directive with a duration value in seconds.
Operation VersionGetResponseRulesSetCacheControlRuleActionParametersStaleWhileRevalidateSetDirectiveOperation The operation to perform on the cache-control directive. One of the following: const VersionGetResponseRulesSetCacheControlRuleActionParametersStaleWhileRevalidateSetDirectiveOperationSet VersionGetResponseRulesSetCacheControlRuleActionParametersStaleWhileRevalidateSetDirectiveOperation = "set" Link to this property const VersionGetResponseRulesSetCacheControlRuleActionParametersStaleWhileRevalidateSetDirectiveOperationRemove VersionGetResponseRulesSetCacheControlRuleActionParametersStaleWhileRevalidateSetDirectiveOperation = "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 VersionGetResponseRulesSetCacheControlRuleActionParametersStaleWhileRevalidateRemoveDirective struct{…} Remove the directive.
Operation VersionGetResponseRulesSetCacheControlRuleActionParametersStaleWhileRevalidateRemoveDirectiveOperation The operation to perform on the cache-control directive. One of the following: const VersionGetResponseRulesSetCacheControlRuleActionParametersStaleWhileRevalidateRemoveDirectiveOperationSet VersionGetResponseRulesSetCacheControlRuleActionParametersStaleWhileRevalidateRemoveDirectiveOperation = "set" Link to this property const VersionGetResponseRulesSetCacheControlRuleActionParametersStaleWhileRevalidateRemoveDirectiveOperationRemove VersionGetResponseRulesSetCacheControlRuleActionParametersStaleWhileRevalidateRemoveDirectiveOperation = "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 VersionGetResponseRulesSetCacheControlRuleExposedCredentialCheckOptional 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 VersionGetResponseRulesSetCacheControlRuleRatelimitOptional 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 VersionGetResponseRulesSetCacheSettingsRule 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 VersionGetResponseRulesSetCacheTagsRule struct{…} ID string The unique ID of the rule. Link to this property Action VersionGetResponseRulesSetCacheTagsRuleAction 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 VersionGetResponseRulesSetCacheTagsRuleActionParametersOptional The parameters configuring the rule’s action. One of the following:
type VersionGetResponseRulesSetCacheTagsRuleActionParametersAddCacheTagsValues struct{…} Add cache tags using a list of values.
Operation VersionGetResponseRulesSetCacheTagsRuleActionParametersAddCacheTagsValuesOperation The operation to perform on the cache tags. One of the following: const VersionGetResponseRulesSetCacheTagsRuleActionParametersAddCacheTagsValuesOperationAdd VersionGetResponseRulesSetCacheTagsRuleActionParametersAddCacheTagsValuesOperation = "add" Link to this property const VersionGetResponseRulesSetCacheTagsRuleActionParametersAddCacheTagsValuesOperationRemove VersionGetResponseRulesSetCacheTagsRuleActionParametersAddCacheTagsValuesOperation = "remove" Link to this property const VersionGetResponseRulesSetCacheTagsRuleActionParametersAddCacheTagsValuesOperationSet VersionGetResponseRulesSetCacheTagsRuleActionParametersAddCacheTagsValuesOperation = "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 VersionGetResponseRulesSetCacheTagsRuleActionParametersAddCacheTagsExpression 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 VersionGetResponseRulesSetCacheTagsRuleActionParametersAddCacheTagsExpressionOperation The operation to perform on the cache tags. One of the following: const VersionGetResponseRulesSetCacheTagsRuleActionParametersAddCacheTagsExpressionOperationAdd VersionGetResponseRulesSetCacheTagsRuleActionParametersAddCacheTagsExpressionOperation = "add" Link to this property const VersionGetResponseRulesSetCacheTagsRuleActionParametersAddCacheTagsExpressionOperationRemove VersionGetResponseRulesSetCacheTagsRuleActionParametersAddCacheTagsExpressionOperation = "remove" Link to this property const VersionGetResponseRulesSetCacheTagsRuleActionParametersAddCacheTagsExpressionOperationSet VersionGetResponseRulesSetCacheTagsRuleActionParametersAddCacheTagsExpressionOperation = "set" Link to this property
Link to this property
Link to this property
type VersionGetResponseRulesSetCacheTagsRuleActionParametersRemoveCacheTagsValues struct{…} Remove cache tags using a list of values.
Operation VersionGetResponseRulesSetCacheTagsRuleActionParametersRemoveCacheTagsValuesOperation The operation to perform on the cache tags. One of the following: const VersionGetResponseRulesSetCacheTagsRuleActionParametersRemoveCacheTagsValuesOperationAdd VersionGetResponseRulesSetCacheTagsRuleActionParametersRemoveCacheTagsValuesOperation = "add" Link to this property const VersionGetResponseRulesSetCacheTagsRuleActionParametersRemoveCacheTagsValuesOperationRemove VersionGetResponseRulesSetCacheTagsRuleActionParametersRemoveCacheTagsValuesOperation = "remove" Link to this property const VersionGetResponseRulesSetCacheTagsRuleActionParametersRemoveCacheTagsValuesOperationSet VersionGetResponseRulesSetCacheTagsRuleActionParametersRemoveCacheTagsValuesOperation = "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 VersionGetResponseRulesSetCacheTagsRuleActionParametersRemoveCacheTagsExpression 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 VersionGetResponseRulesSetCacheTagsRuleActionParametersRemoveCacheTagsExpressionOperation The operation to perform on the cache tags. One of the following: const VersionGetResponseRulesSetCacheTagsRuleActionParametersRemoveCacheTagsExpressionOperationAdd VersionGetResponseRulesSetCacheTagsRuleActionParametersRemoveCacheTagsExpressionOperation = "add" Link to this property const VersionGetResponseRulesSetCacheTagsRuleActionParametersRemoveCacheTagsExpressionOperationRemove VersionGetResponseRulesSetCacheTagsRuleActionParametersRemoveCacheTagsExpressionOperation = "remove" Link to this property const VersionGetResponseRulesSetCacheTagsRuleActionParametersRemoveCacheTagsExpressionOperationSet VersionGetResponseRulesSetCacheTagsRuleActionParametersRemoveCacheTagsExpressionOperation = "set" Link to this property
Link to this property
Link to this property
type VersionGetResponseRulesSetCacheTagsRuleActionParametersSetCacheTagsValues struct{…} Set cache tags using a list of values.
Operation VersionGetResponseRulesSetCacheTagsRuleActionParametersSetCacheTagsValuesOperation The operation to perform on the cache tags. One of the following: const VersionGetResponseRulesSetCacheTagsRuleActionParametersSetCacheTagsValuesOperationAdd VersionGetResponseRulesSetCacheTagsRuleActionParametersSetCacheTagsValuesOperation = "add" Link to this property const VersionGetResponseRulesSetCacheTagsRuleActionParametersSetCacheTagsValuesOperationRemove VersionGetResponseRulesSetCacheTagsRuleActionParametersSetCacheTagsValuesOperation = "remove" Link to this property const VersionGetResponseRulesSetCacheTagsRuleActionParametersSetCacheTagsValuesOperationSet VersionGetResponseRulesSetCacheTagsRuleActionParametersSetCacheTagsValuesOperation = "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 VersionGetResponseRulesSetCacheTagsRuleActionParametersSetCacheTagsExpression 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 VersionGetResponseRulesSetCacheTagsRuleActionParametersSetCacheTagsExpressionOperation The operation to perform on the cache tags. One of the following: const VersionGetResponseRulesSetCacheTagsRuleActionParametersSetCacheTagsExpressionOperationAdd VersionGetResponseRulesSetCacheTagsRuleActionParametersSetCacheTagsExpressionOperation = "add" Link to this property const VersionGetResponseRulesSetCacheTagsRuleActionParametersSetCacheTagsExpressionOperationRemove VersionGetResponseRulesSetCacheTagsRuleActionParametersSetCacheTagsExpressionOperation = "remove" Link to this property const VersionGetResponseRulesSetCacheTagsRuleActionParametersSetCacheTagsExpressionOperationSet VersionGetResponseRulesSetCacheTagsRuleActionParametersSetCacheTagsExpressionOperation = "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 VersionGetResponseRulesSetCacheTagsRuleExposedCredentialCheckOptional 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 VersionGetResponseRulesSetCacheTagsRuleRatelimitOptional 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 VersionGetResponseRulesSetConfigurationRule 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 VersionGetResponseRulesSkipRule 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 VersionGetResponseRulesTransformResponseHTMLRule struct{…} ID string The unique ID of the rule. Link to this property Action VersionGetResponseRulesTransformResponseHTMLRuleAction 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 VersionGetResponseRulesTransformResponseHTMLRuleActionParametersOptional 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 VersionGetResponseRulesTransformResponseHTMLRuleExposedCredentialCheckOptional 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 VersionGetResponseRulesTransformResponseHTMLRuleRatelimitOptional 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.versions%20%3E%20(model)%20VersionGetResponse%20%3E%20(schema)>) ### Get an account or zone ruleset version 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"), ) version, err := client.Rulesets.Versions.Get( context.TODO(), "2f2feab2026849078ba485f918791bdc", "1", rulesets.VersionGetParams{ }, ) if err != nil { panic(err.Error()) } fmt.Printf("%+v\n", version.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 } ```