--- title: Get an account or zone entry point ruleset --- [Skip to content](#_top) [API Reference](https://developers.cloudflare.com/api/go) [Rulesets](https://developers.cloudflare.com/api/go/resources/rulesets) [Phases](https://developers.cloudflare.com/api/go/resources/rulesets/subresources/phases) Copy Markdown Open in **Claude**Open in **ChatGPT**Open in **Cursor** --- **Copy Markdown****View as Markdown** # Get an account or zone entry point ruleset client.Rulesets.Phases.Get(ctx, rulesetPhase, query) (\*[PhaseGetResponse](), error) GET/{accounts\_or\_zones}/{account\_or\_zone\_id}/rulesets/phases/{ruleset\_phase}/entrypoint Fetches the latest version of the account or zone entry point ruleset for a given phase. ##### 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
RulesetPhase 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](<#(resource)%20rulesets.phases%20%3E%20(method)%20get%20%3E%20(params)%20default%20%3E%20(param)%20ruleset_phase%20%3E%20(schema)>)
query PhaseGetParams 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.phases%20%3E%20(method)%20get%20%3E%20(params)%20default>) ##### ReturnsExpand Collapse
type PhaseGetResponse 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 \[]PhaseGetResponseRule The list of rules in the ruleset. One of the following:
type PhaseGetResponseRulesBlockRule 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 PhaseGetResponseRulesChallengeRule struct{…} ID string The unique ID of the rule. Link to this property Action PhaseGetResponseRulesChallengeRuleAction 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 PhaseGetResponseRulesChallengeRuleExposedCredentialCheckOptional 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 PhaseGetResponseRulesChallengeRuleRatelimitOptional 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 PhaseGetResponseRulesResponseCompressionRule 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 PhaseGetResponseRulesDDoSDynamicRule 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 PhaseGetResponseRulesExecuteRule 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 PhaseGetResponseRulesForceConnectionCloseRule 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 PhaseGetResponseRulesJavaScriptChallengeRule struct{…} ID string The unique ID of the rule. Link to this property Action PhaseGetResponseRulesJavaScriptChallengeRuleAction 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 PhaseGetResponseRulesJavaScriptChallengeRuleExposedCredentialCheckOptional 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 PhaseGetResponseRulesJavaScriptChallengeRuleRatelimitOptional 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 PhaseGetResponseRulesLogRule 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 PhaseGetResponseRulesLogCustomFieldRule 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 PhaseGetResponseRulesManagedChallengeRule 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 PhaseGetResponseRulesRedirectRule 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 PhaseGetResponseRulesRewriteRule 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 PhaseGetResponseRulesRouteRule 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 PhaseGetResponseRulesScoreRule 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 PhaseGetResponseRulesServeErrorRule 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 PhaseGetResponseRulesSetCacheControlRule struct{…} ID string The unique ID of the rule. Link to this property Action PhaseGetResponseRulesSetCacheControlRuleAction 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 PhaseGetResponseRulesSetCacheControlRuleActionParametersOptional The parameters configuring the rule’s action.
Immutable PhaseGetResponseRulesSetCacheControlRuleActionParametersImmutableOptional A cache-control directive configuration. One of the following:
type PhaseGetResponseRulesSetCacheControlRuleActionParametersImmutableSetDirective struct{…} Set the directive.
Operation PhaseGetResponseRulesSetCacheControlRuleActionParametersImmutableSetDirectiveOperation The operation to perform on the cache-control directive. One of the following: const PhaseGetResponseRulesSetCacheControlRuleActionParametersImmutableSetDirectiveOperationSet PhaseGetResponseRulesSetCacheControlRuleActionParametersImmutableSetDirectiveOperation = "set" Link to this property const PhaseGetResponseRulesSetCacheControlRuleActionParametersImmutableSetDirectiveOperationRemove PhaseGetResponseRulesSetCacheControlRuleActionParametersImmutableSetDirectiveOperation = "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 PhaseGetResponseRulesSetCacheControlRuleActionParametersImmutableRemoveDirective struct{…} Remove the directive.
Operation PhaseGetResponseRulesSetCacheControlRuleActionParametersImmutableRemoveDirectiveOperation The operation to perform on the cache-control directive. One of the following: const PhaseGetResponseRulesSetCacheControlRuleActionParametersImmutableRemoveDirectiveOperationSet PhaseGetResponseRulesSetCacheControlRuleActionParametersImmutableRemoveDirectiveOperation = "set" Link to this property const PhaseGetResponseRulesSetCacheControlRuleActionParametersImmutableRemoveDirectiveOperationRemove PhaseGetResponseRulesSetCacheControlRuleActionParametersImmutableRemoveDirectiveOperation = "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 PhaseGetResponseRulesSetCacheControlRuleActionParametersMaxAgeOptional A cache-control directive configuration that accepts a duration value in seconds. One of the following:
type PhaseGetResponseRulesSetCacheControlRuleActionParametersMaxAgeSetDirective struct{…} Set the directive with a duration value in seconds.
Operation PhaseGetResponseRulesSetCacheControlRuleActionParametersMaxAgeSetDirectiveOperation The operation to perform on the cache-control directive. One of the following: const PhaseGetResponseRulesSetCacheControlRuleActionParametersMaxAgeSetDirectiveOperationSet PhaseGetResponseRulesSetCacheControlRuleActionParametersMaxAgeSetDirectiveOperation = "set" Link to this property const PhaseGetResponseRulesSetCacheControlRuleActionParametersMaxAgeSetDirectiveOperationRemove PhaseGetResponseRulesSetCacheControlRuleActionParametersMaxAgeSetDirectiveOperation = "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 PhaseGetResponseRulesSetCacheControlRuleActionParametersMaxAgeRemoveDirective struct{…} Remove the directive.
Operation PhaseGetResponseRulesSetCacheControlRuleActionParametersMaxAgeRemoveDirectiveOperation The operation to perform on the cache-control directive. One of the following: const PhaseGetResponseRulesSetCacheControlRuleActionParametersMaxAgeRemoveDirectiveOperationSet PhaseGetResponseRulesSetCacheControlRuleActionParametersMaxAgeRemoveDirectiveOperation = "set" Link to this property const PhaseGetResponseRulesSetCacheControlRuleActionParametersMaxAgeRemoveDirectiveOperationRemove PhaseGetResponseRulesSetCacheControlRuleActionParametersMaxAgeRemoveDirectiveOperation = "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 PhaseGetResponseRulesSetCacheControlRuleActionParametersMustRevalidateOptional A cache-control directive configuration. One of the following:
type PhaseGetResponseRulesSetCacheControlRuleActionParametersMustRevalidateSetDirective struct{…} Set the directive.
Operation PhaseGetResponseRulesSetCacheControlRuleActionParametersMustRevalidateSetDirectiveOperation The operation to perform on the cache-control directive. One of the following: const PhaseGetResponseRulesSetCacheControlRuleActionParametersMustRevalidateSetDirectiveOperationSet PhaseGetResponseRulesSetCacheControlRuleActionParametersMustRevalidateSetDirectiveOperation = "set" Link to this property const PhaseGetResponseRulesSetCacheControlRuleActionParametersMustRevalidateSetDirectiveOperationRemove PhaseGetResponseRulesSetCacheControlRuleActionParametersMustRevalidateSetDirectiveOperation = "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 PhaseGetResponseRulesSetCacheControlRuleActionParametersMustRevalidateRemoveDirective struct{…} Remove the directive.
Operation PhaseGetResponseRulesSetCacheControlRuleActionParametersMustRevalidateRemoveDirectiveOperation The operation to perform on the cache-control directive. One of the following: const PhaseGetResponseRulesSetCacheControlRuleActionParametersMustRevalidateRemoveDirectiveOperationSet PhaseGetResponseRulesSetCacheControlRuleActionParametersMustRevalidateRemoveDirectiveOperation = "set" Link to this property const PhaseGetResponseRulesSetCacheControlRuleActionParametersMustRevalidateRemoveDirectiveOperationRemove PhaseGetResponseRulesSetCacheControlRuleActionParametersMustRevalidateRemoveDirectiveOperation = "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 PhaseGetResponseRulesSetCacheControlRuleActionParametersMustUnderstandOptional A cache-control directive configuration. One of the following:
type PhaseGetResponseRulesSetCacheControlRuleActionParametersMustUnderstandSetDirective struct{…} Set the directive.
Operation PhaseGetResponseRulesSetCacheControlRuleActionParametersMustUnderstandSetDirectiveOperation The operation to perform on the cache-control directive. One of the following: const PhaseGetResponseRulesSetCacheControlRuleActionParametersMustUnderstandSetDirectiveOperationSet PhaseGetResponseRulesSetCacheControlRuleActionParametersMustUnderstandSetDirectiveOperation = "set" Link to this property const PhaseGetResponseRulesSetCacheControlRuleActionParametersMustUnderstandSetDirectiveOperationRemove PhaseGetResponseRulesSetCacheControlRuleActionParametersMustUnderstandSetDirectiveOperation = "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 PhaseGetResponseRulesSetCacheControlRuleActionParametersMustUnderstandRemoveDirective struct{…} Remove the directive.
Operation PhaseGetResponseRulesSetCacheControlRuleActionParametersMustUnderstandRemoveDirectiveOperation The operation to perform on the cache-control directive. One of the following: const PhaseGetResponseRulesSetCacheControlRuleActionParametersMustUnderstandRemoveDirectiveOperationSet PhaseGetResponseRulesSetCacheControlRuleActionParametersMustUnderstandRemoveDirectiveOperation = "set" Link to this property const PhaseGetResponseRulesSetCacheControlRuleActionParametersMustUnderstandRemoveDirectiveOperationRemove PhaseGetResponseRulesSetCacheControlRuleActionParametersMustUnderstandRemoveDirectiveOperation = "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 PhaseGetResponseRulesSetCacheControlRuleActionParametersNoCacheOptional A cache-control directive configuration that accepts optional qualifiers (header names). One of the following:
type PhaseGetResponseRulesSetCacheControlRuleActionParametersNoCacheSetDirective struct{…} Set the directive with optional qualifiers.
Operation PhaseGetResponseRulesSetCacheControlRuleActionParametersNoCacheSetDirectiveOperation The operation to perform on the cache-control directive. One of the following: const PhaseGetResponseRulesSetCacheControlRuleActionParametersNoCacheSetDirectiveOperationSet PhaseGetResponseRulesSetCacheControlRuleActionParametersNoCacheSetDirectiveOperation = "set" Link to this property const PhaseGetResponseRulesSetCacheControlRuleActionParametersNoCacheSetDirectiveOperationRemove PhaseGetResponseRulesSetCacheControlRuleActionParametersNoCacheSetDirectiveOperation = "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 PhaseGetResponseRulesSetCacheControlRuleActionParametersNoCacheRemoveDirective struct{…} Remove the directive.
Operation PhaseGetResponseRulesSetCacheControlRuleActionParametersNoCacheRemoveDirectiveOperation The operation to perform on the cache-control directive. One of the following: const PhaseGetResponseRulesSetCacheControlRuleActionParametersNoCacheRemoveDirectiveOperationSet PhaseGetResponseRulesSetCacheControlRuleActionParametersNoCacheRemoveDirectiveOperation = "set" Link to this property const PhaseGetResponseRulesSetCacheControlRuleActionParametersNoCacheRemoveDirectiveOperationRemove PhaseGetResponseRulesSetCacheControlRuleActionParametersNoCacheRemoveDirectiveOperation = "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 PhaseGetResponseRulesSetCacheControlRuleActionParametersNoStoreOptional A cache-control directive configuration. One of the following:
type PhaseGetResponseRulesSetCacheControlRuleActionParametersNoStoreSetDirective struct{…} Set the directive.
Operation PhaseGetResponseRulesSetCacheControlRuleActionParametersNoStoreSetDirectiveOperation The operation to perform on the cache-control directive. One of the following: const PhaseGetResponseRulesSetCacheControlRuleActionParametersNoStoreSetDirectiveOperationSet PhaseGetResponseRulesSetCacheControlRuleActionParametersNoStoreSetDirectiveOperation = "set" Link to this property const PhaseGetResponseRulesSetCacheControlRuleActionParametersNoStoreSetDirectiveOperationRemove PhaseGetResponseRulesSetCacheControlRuleActionParametersNoStoreSetDirectiveOperation = "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 PhaseGetResponseRulesSetCacheControlRuleActionParametersNoStoreRemoveDirective struct{…} Remove the directive.
Operation PhaseGetResponseRulesSetCacheControlRuleActionParametersNoStoreRemoveDirectiveOperation The operation to perform on the cache-control directive. One of the following: const PhaseGetResponseRulesSetCacheControlRuleActionParametersNoStoreRemoveDirectiveOperationSet PhaseGetResponseRulesSetCacheControlRuleActionParametersNoStoreRemoveDirectiveOperation = "set" Link to this property const PhaseGetResponseRulesSetCacheControlRuleActionParametersNoStoreRemoveDirectiveOperationRemove PhaseGetResponseRulesSetCacheControlRuleActionParametersNoStoreRemoveDirectiveOperation = "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 PhaseGetResponseRulesSetCacheControlRuleActionParametersNoTransformOptional A cache-control directive configuration. One of the following:
type PhaseGetResponseRulesSetCacheControlRuleActionParametersNoTransformSetDirective struct{…} Set the directive.
Operation PhaseGetResponseRulesSetCacheControlRuleActionParametersNoTransformSetDirectiveOperation The operation to perform on the cache-control directive. One of the following: const PhaseGetResponseRulesSetCacheControlRuleActionParametersNoTransformSetDirectiveOperationSet PhaseGetResponseRulesSetCacheControlRuleActionParametersNoTransformSetDirectiveOperation = "set" Link to this property const PhaseGetResponseRulesSetCacheControlRuleActionParametersNoTransformSetDirectiveOperationRemove PhaseGetResponseRulesSetCacheControlRuleActionParametersNoTransformSetDirectiveOperation = "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 PhaseGetResponseRulesSetCacheControlRuleActionParametersNoTransformRemoveDirective struct{…} Remove the directive.
Operation PhaseGetResponseRulesSetCacheControlRuleActionParametersNoTransformRemoveDirectiveOperation The operation to perform on the cache-control directive. One of the following: const PhaseGetResponseRulesSetCacheControlRuleActionParametersNoTransformRemoveDirectiveOperationSet PhaseGetResponseRulesSetCacheControlRuleActionParametersNoTransformRemoveDirectiveOperation = "set" Link to this property const PhaseGetResponseRulesSetCacheControlRuleActionParametersNoTransformRemoveDirectiveOperationRemove PhaseGetResponseRulesSetCacheControlRuleActionParametersNoTransformRemoveDirectiveOperation = "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 PhaseGetResponseRulesSetCacheControlRuleActionParametersPrivateOptional A cache-control directive configuration that accepts optional qualifiers (header names). One of the following:
type PhaseGetResponseRulesSetCacheControlRuleActionParametersPrivateSetDirective struct{…} Set the directive with optional qualifiers.
Operation PhaseGetResponseRulesSetCacheControlRuleActionParametersPrivateSetDirectiveOperation The operation to perform on the cache-control directive. One of the following: const PhaseGetResponseRulesSetCacheControlRuleActionParametersPrivateSetDirectiveOperationSet PhaseGetResponseRulesSetCacheControlRuleActionParametersPrivateSetDirectiveOperation = "set" Link to this property const PhaseGetResponseRulesSetCacheControlRuleActionParametersPrivateSetDirectiveOperationRemove PhaseGetResponseRulesSetCacheControlRuleActionParametersPrivateSetDirectiveOperation = "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 PhaseGetResponseRulesSetCacheControlRuleActionParametersPrivateRemoveDirective struct{…} Remove the directive.
Operation PhaseGetResponseRulesSetCacheControlRuleActionParametersPrivateRemoveDirectiveOperation The operation to perform on the cache-control directive. One of the following: const PhaseGetResponseRulesSetCacheControlRuleActionParametersPrivateRemoveDirectiveOperationSet PhaseGetResponseRulesSetCacheControlRuleActionParametersPrivateRemoveDirectiveOperation = "set" Link to this property const PhaseGetResponseRulesSetCacheControlRuleActionParametersPrivateRemoveDirectiveOperationRemove PhaseGetResponseRulesSetCacheControlRuleActionParametersPrivateRemoveDirectiveOperation = "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 PhaseGetResponseRulesSetCacheControlRuleActionParametersProxyRevalidateOptional A cache-control directive configuration. One of the following:
type PhaseGetResponseRulesSetCacheControlRuleActionParametersProxyRevalidateSetDirective struct{…} Set the directive.
Operation PhaseGetResponseRulesSetCacheControlRuleActionParametersProxyRevalidateSetDirectiveOperation The operation to perform on the cache-control directive. One of the following: const PhaseGetResponseRulesSetCacheControlRuleActionParametersProxyRevalidateSetDirectiveOperationSet PhaseGetResponseRulesSetCacheControlRuleActionParametersProxyRevalidateSetDirectiveOperation = "set" Link to this property const PhaseGetResponseRulesSetCacheControlRuleActionParametersProxyRevalidateSetDirectiveOperationRemove PhaseGetResponseRulesSetCacheControlRuleActionParametersProxyRevalidateSetDirectiveOperation = "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 PhaseGetResponseRulesSetCacheControlRuleActionParametersProxyRevalidateRemoveDirective struct{…} Remove the directive.
Operation PhaseGetResponseRulesSetCacheControlRuleActionParametersProxyRevalidateRemoveDirectiveOperation The operation to perform on the cache-control directive. One of the following: const PhaseGetResponseRulesSetCacheControlRuleActionParametersProxyRevalidateRemoveDirectiveOperationSet PhaseGetResponseRulesSetCacheControlRuleActionParametersProxyRevalidateRemoveDirectiveOperation = "set" Link to this property const PhaseGetResponseRulesSetCacheControlRuleActionParametersProxyRevalidateRemoveDirectiveOperationRemove PhaseGetResponseRulesSetCacheControlRuleActionParametersProxyRevalidateRemoveDirectiveOperation = "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 PhaseGetResponseRulesSetCacheControlRuleActionParametersPublicOptional A cache-control directive configuration. One of the following:
type PhaseGetResponseRulesSetCacheControlRuleActionParametersPublicSetDirective struct{…} Set the directive.
Operation PhaseGetResponseRulesSetCacheControlRuleActionParametersPublicSetDirectiveOperation The operation to perform on the cache-control directive. One of the following: const PhaseGetResponseRulesSetCacheControlRuleActionParametersPublicSetDirectiveOperationSet PhaseGetResponseRulesSetCacheControlRuleActionParametersPublicSetDirectiveOperation = "set" Link to this property const PhaseGetResponseRulesSetCacheControlRuleActionParametersPublicSetDirectiveOperationRemove PhaseGetResponseRulesSetCacheControlRuleActionParametersPublicSetDirectiveOperation = "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 PhaseGetResponseRulesSetCacheControlRuleActionParametersPublicRemoveDirective struct{…} Remove the directive.
Operation PhaseGetResponseRulesSetCacheControlRuleActionParametersPublicRemoveDirectiveOperation The operation to perform on the cache-control directive. One of the following: const PhaseGetResponseRulesSetCacheControlRuleActionParametersPublicRemoveDirectiveOperationSet PhaseGetResponseRulesSetCacheControlRuleActionParametersPublicRemoveDirectiveOperation = "set" Link to this property const PhaseGetResponseRulesSetCacheControlRuleActionParametersPublicRemoveDirectiveOperationRemove PhaseGetResponseRulesSetCacheControlRuleActionParametersPublicRemoveDirectiveOperation = "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 PhaseGetResponseRulesSetCacheControlRuleActionParametersSMaxageOptional A cache-control directive configuration that accepts a duration value in seconds. One of the following:
type PhaseGetResponseRulesSetCacheControlRuleActionParametersSMaxageSetDirective struct{…} Set the directive with a duration value in seconds.
Operation PhaseGetResponseRulesSetCacheControlRuleActionParametersSMaxageSetDirectiveOperation The operation to perform on the cache-control directive. One of the following: const PhaseGetResponseRulesSetCacheControlRuleActionParametersSMaxageSetDirectiveOperationSet PhaseGetResponseRulesSetCacheControlRuleActionParametersSMaxageSetDirectiveOperation = "set" Link to this property const PhaseGetResponseRulesSetCacheControlRuleActionParametersSMaxageSetDirectiveOperationRemove PhaseGetResponseRulesSetCacheControlRuleActionParametersSMaxageSetDirectiveOperation = "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 PhaseGetResponseRulesSetCacheControlRuleActionParametersSMaxageRemoveDirective struct{…} Remove the directive.
Operation PhaseGetResponseRulesSetCacheControlRuleActionParametersSMaxageRemoveDirectiveOperation The operation to perform on the cache-control directive. One of the following: const PhaseGetResponseRulesSetCacheControlRuleActionParametersSMaxageRemoveDirectiveOperationSet PhaseGetResponseRulesSetCacheControlRuleActionParametersSMaxageRemoveDirectiveOperation = "set" Link to this property const PhaseGetResponseRulesSetCacheControlRuleActionParametersSMaxageRemoveDirectiveOperationRemove PhaseGetResponseRulesSetCacheControlRuleActionParametersSMaxageRemoveDirectiveOperation = "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 PhaseGetResponseRulesSetCacheControlRuleActionParametersStaleIfErrorOptional A cache-control directive configuration that accepts a duration value in seconds. One of the following:
type PhaseGetResponseRulesSetCacheControlRuleActionParametersStaleIfErrorSetDirective struct{…} Set the directive with a duration value in seconds.
Operation PhaseGetResponseRulesSetCacheControlRuleActionParametersStaleIfErrorSetDirectiveOperation The operation to perform on the cache-control directive. One of the following: const PhaseGetResponseRulesSetCacheControlRuleActionParametersStaleIfErrorSetDirectiveOperationSet PhaseGetResponseRulesSetCacheControlRuleActionParametersStaleIfErrorSetDirectiveOperation = "set" Link to this property const PhaseGetResponseRulesSetCacheControlRuleActionParametersStaleIfErrorSetDirectiveOperationRemove PhaseGetResponseRulesSetCacheControlRuleActionParametersStaleIfErrorSetDirectiveOperation = "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 PhaseGetResponseRulesSetCacheControlRuleActionParametersStaleIfErrorRemoveDirective struct{…} Remove the directive.
Operation PhaseGetResponseRulesSetCacheControlRuleActionParametersStaleIfErrorRemoveDirectiveOperation The operation to perform on the cache-control directive. One of the following: const PhaseGetResponseRulesSetCacheControlRuleActionParametersStaleIfErrorRemoveDirectiveOperationSet PhaseGetResponseRulesSetCacheControlRuleActionParametersStaleIfErrorRemoveDirectiveOperation = "set" Link to this property const PhaseGetResponseRulesSetCacheControlRuleActionParametersStaleIfErrorRemoveDirectiveOperationRemove PhaseGetResponseRulesSetCacheControlRuleActionParametersStaleIfErrorRemoveDirectiveOperation = "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 PhaseGetResponseRulesSetCacheControlRuleActionParametersStaleWhileRevalidateOptional A cache-control directive configuration that accepts a duration value in seconds. One of the following:
type PhaseGetResponseRulesSetCacheControlRuleActionParametersStaleWhileRevalidateSetDirective struct{…} Set the directive with a duration value in seconds.
Operation PhaseGetResponseRulesSetCacheControlRuleActionParametersStaleWhileRevalidateSetDirectiveOperation The operation to perform on the cache-control directive. One of the following: const PhaseGetResponseRulesSetCacheControlRuleActionParametersStaleWhileRevalidateSetDirectiveOperationSet PhaseGetResponseRulesSetCacheControlRuleActionParametersStaleWhileRevalidateSetDirectiveOperation = "set" Link to this property const PhaseGetResponseRulesSetCacheControlRuleActionParametersStaleWhileRevalidateSetDirectiveOperationRemove PhaseGetResponseRulesSetCacheControlRuleActionParametersStaleWhileRevalidateSetDirectiveOperation = "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 PhaseGetResponseRulesSetCacheControlRuleActionParametersStaleWhileRevalidateRemoveDirective struct{…} Remove the directive.
Operation PhaseGetResponseRulesSetCacheControlRuleActionParametersStaleWhileRevalidateRemoveDirectiveOperation The operation to perform on the cache-control directive. One of the following: const PhaseGetResponseRulesSetCacheControlRuleActionParametersStaleWhileRevalidateRemoveDirectiveOperationSet PhaseGetResponseRulesSetCacheControlRuleActionParametersStaleWhileRevalidateRemoveDirectiveOperation = "set" Link to this property const PhaseGetResponseRulesSetCacheControlRuleActionParametersStaleWhileRevalidateRemoveDirectiveOperationRemove PhaseGetResponseRulesSetCacheControlRuleActionParametersStaleWhileRevalidateRemoveDirectiveOperation = "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 PhaseGetResponseRulesSetCacheControlRuleExposedCredentialCheckOptional 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 PhaseGetResponseRulesSetCacheControlRuleRatelimitOptional 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 PhaseGetResponseRulesSetCacheSettingsRule 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 PhaseGetResponseRulesSetCacheTagsRule struct{…} ID string The unique ID of the rule. Link to this property Action PhaseGetResponseRulesSetCacheTagsRuleAction 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 PhaseGetResponseRulesSetCacheTagsRuleActionParametersOptional The parameters configuring the rule’s action. One of the following:
type PhaseGetResponseRulesSetCacheTagsRuleActionParametersAddCacheTagsValues struct{…} Add cache tags using a list of values.
Operation PhaseGetResponseRulesSetCacheTagsRuleActionParametersAddCacheTagsValuesOperation The operation to perform on the cache tags. One of the following: const PhaseGetResponseRulesSetCacheTagsRuleActionParametersAddCacheTagsValuesOperationAdd PhaseGetResponseRulesSetCacheTagsRuleActionParametersAddCacheTagsValuesOperation = "add" Link to this property const PhaseGetResponseRulesSetCacheTagsRuleActionParametersAddCacheTagsValuesOperationRemove PhaseGetResponseRulesSetCacheTagsRuleActionParametersAddCacheTagsValuesOperation = "remove" Link to this property const PhaseGetResponseRulesSetCacheTagsRuleActionParametersAddCacheTagsValuesOperationSet PhaseGetResponseRulesSetCacheTagsRuleActionParametersAddCacheTagsValuesOperation = "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 PhaseGetResponseRulesSetCacheTagsRuleActionParametersAddCacheTagsExpression 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 PhaseGetResponseRulesSetCacheTagsRuleActionParametersAddCacheTagsExpressionOperation The operation to perform on the cache tags. One of the following: const PhaseGetResponseRulesSetCacheTagsRuleActionParametersAddCacheTagsExpressionOperationAdd PhaseGetResponseRulesSetCacheTagsRuleActionParametersAddCacheTagsExpressionOperation = "add" Link to this property const PhaseGetResponseRulesSetCacheTagsRuleActionParametersAddCacheTagsExpressionOperationRemove PhaseGetResponseRulesSetCacheTagsRuleActionParametersAddCacheTagsExpressionOperation = "remove" Link to this property const PhaseGetResponseRulesSetCacheTagsRuleActionParametersAddCacheTagsExpressionOperationSet PhaseGetResponseRulesSetCacheTagsRuleActionParametersAddCacheTagsExpressionOperation = "set" Link to this property
Link to this property
Link to this property
type PhaseGetResponseRulesSetCacheTagsRuleActionParametersRemoveCacheTagsValues struct{…} Remove cache tags using a list of values.
Operation PhaseGetResponseRulesSetCacheTagsRuleActionParametersRemoveCacheTagsValuesOperation The operation to perform on the cache tags. One of the following: const PhaseGetResponseRulesSetCacheTagsRuleActionParametersRemoveCacheTagsValuesOperationAdd PhaseGetResponseRulesSetCacheTagsRuleActionParametersRemoveCacheTagsValuesOperation = "add" Link to this property const PhaseGetResponseRulesSetCacheTagsRuleActionParametersRemoveCacheTagsValuesOperationRemove PhaseGetResponseRulesSetCacheTagsRuleActionParametersRemoveCacheTagsValuesOperation = "remove" Link to this property const PhaseGetResponseRulesSetCacheTagsRuleActionParametersRemoveCacheTagsValuesOperationSet PhaseGetResponseRulesSetCacheTagsRuleActionParametersRemoveCacheTagsValuesOperation = "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 PhaseGetResponseRulesSetCacheTagsRuleActionParametersRemoveCacheTagsExpression 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 PhaseGetResponseRulesSetCacheTagsRuleActionParametersRemoveCacheTagsExpressionOperation The operation to perform on the cache tags. One of the following: const PhaseGetResponseRulesSetCacheTagsRuleActionParametersRemoveCacheTagsExpressionOperationAdd PhaseGetResponseRulesSetCacheTagsRuleActionParametersRemoveCacheTagsExpressionOperation = "add" Link to this property const PhaseGetResponseRulesSetCacheTagsRuleActionParametersRemoveCacheTagsExpressionOperationRemove PhaseGetResponseRulesSetCacheTagsRuleActionParametersRemoveCacheTagsExpressionOperation = "remove" Link to this property const PhaseGetResponseRulesSetCacheTagsRuleActionParametersRemoveCacheTagsExpressionOperationSet PhaseGetResponseRulesSetCacheTagsRuleActionParametersRemoveCacheTagsExpressionOperation = "set" Link to this property
Link to this property
Link to this property
type PhaseGetResponseRulesSetCacheTagsRuleActionParametersSetCacheTagsValues struct{…} Set cache tags using a list of values.
Operation PhaseGetResponseRulesSetCacheTagsRuleActionParametersSetCacheTagsValuesOperation The operation to perform on the cache tags. One of the following: const PhaseGetResponseRulesSetCacheTagsRuleActionParametersSetCacheTagsValuesOperationAdd PhaseGetResponseRulesSetCacheTagsRuleActionParametersSetCacheTagsValuesOperation = "add" Link to this property const PhaseGetResponseRulesSetCacheTagsRuleActionParametersSetCacheTagsValuesOperationRemove PhaseGetResponseRulesSetCacheTagsRuleActionParametersSetCacheTagsValuesOperation = "remove" Link to this property const PhaseGetResponseRulesSetCacheTagsRuleActionParametersSetCacheTagsValuesOperationSet PhaseGetResponseRulesSetCacheTagsRuleActionParametersSetCacheTagsValuesOperation = "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 PhaseGetResponseRulesSetCacheTagsRuleActionParametersSetCacheTagsExpression 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 PhaseGetResponseRulesSetCacheTagsRuleActionParametersSetCacheTagsExpressionOperation The operation to perform on the cache tags. One of the following: const PhaseGetResponseRulesSetCacheTagsRuleActionParametersSetCacheTagsExpressionOperationAdd PhaseGetResponseRulesSetCacheTagsRuleActionParametersSetCacheTagsExpressionOperation = "add" Link to this property const PhaseGetResponseRulesSetCacheTagsRuleActionParametersSetCacheTagsExpressionOperationRemove PhaseGetResponseRulesSetCacheTagsRuleActionParametersSetCacheTagsExpressionOperation = "remove" Link to this property const PhaseGetResponseRulesSetCacheTagsRuleActionParametersSetCacheTagsExpressionOperationSet PhaseGetResponseRulesSetCacheTagsRuleActionParametersSetCacheTagsExpressionOperation = "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 PhaseGetResponseRulesSetCacheTagsRuleExposedCredentialCheckOptional 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 PhaseGetResponseRulesSetCacheTagsRuleRatelimitOptional 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 PhaseGetResponseRulesSetConfigurationRule 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 PhaseGetResponseRulesSkipRule 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 PhaseGetResponseRulesTransformResponseHTMLRule struct{…} ID string The unique ID of the rule. Link to this property Action PhaseGetResponseRulesTransformResponseHTMLRuleAction 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 PhaseGetResponseRulesTransformResponseHTMLRuleActionParametersOptional 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 PhaseGetResponseRulesTransformResponseHTMLRuleExposedCredentialCheckOptional 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 PhaseGetResponseRulesTransformResponseHTMLRuleRatelimitOptional 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.phases%20%3E%20(model)%20PhaseGetResponse%20%3E%20(schema)>) ### Get an account or zone entry point 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"), ) phase, err := client.Rulesets.Phases.Get( context.TODO(), rulesets.PhaseHTTPRequestFirewallCustom, rulesets.PhaseGetParams{ }, ) if err != nil { panic(err.Error()) } fmt.Printf("%+v\n", phase.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 } ```