API Reference

Rulesets

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 WriteMass URL Redirects ReadMagic Firewall WriteMagic Firewall ReadL4 DDoS Managed Ruleset WriteL4 DDoS Managed Ruleset ReadTransform Rules WriteTransform Rules ReadSelect Configuration WriteSelect Configuration ReadAccount WAF WriteAccount WAF ReadAccount Rulesets ReadAccount Rulesets WriteLogs WriteLogs Read

ParametersExpand Collapse

RulesetPhase Phase

The phase of the ruleset.

One of the following:

const PhaseDDoSL4 Phase = "ddos_l4"

const PhaseDDoSL7 Phase = "ddos_l7"

const PhaseHTTPConfigSettings Phase = "http_config_settings"

const PhaseHTTPCustomErrors Phase = "http_custom_errors"

const PhaseHTTPLogCustomFields Phase = "http_log_custom_fields"

const PhaseHTTPRatelimit Phase = "http_ratelimit"

const PhaseHTTPRequestCacheSettings Phase = "http_request_cache_settings"

const PhaseHTTPRequestDynamicRedirect Phase = "http_request_dynamic_redirect"

const PhaseHTTPRequestFirewallCustom Phase = "http_request_firewall_custom"

const PhaseHTTPRequestFirewallManaged Phase = "http_request_firewall_managed"

const PhaseHTTPRequestLateTransform Phase = "http_request_late_transform"

const PhaseHTTPRequestOrigin Phase = "http_request_origin"

const PhaseHTTPRequestRedirect Phase = "http_request_redirect"

const PhaseHTTPRequestSanitize Phase = "http_request_sanitize"

const PhaseHTTPRequestSBFM Phase = "http_request_sbfm"

const PhaseHTTPRequestTransform Phase = "http_request_transform"

const PhaseHTTPResponseCacheSettings Phase = "http_response_cache_settings"

const PhaseHTTPResponseCompression Phase = "http_response_compression"

const PhaseHTTPResponseFirewallCustom Phase = "http_response_firewall_custom"

const PhaseHTTPResponseFirewallManaged Phase = "http_response_firewall_managed"

const PhaseHTTPResponseHeadersTransform Phase = "http_response_headers_transform"

const PhaseMagicTransit Phase = "magic_transit"

const PhaseMagicTransitIDsManaged Phase = "magic_transit_ids_managed"

const PhaseMagicTransitManaged Phase = "magic_transit_managed"

const PhaseMagicTransitRatelimit Phase = "magic_transit_ratelimit"

query PhaseGetParams

AccountID param.Field[string]Optional

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

ZoneID param.Field[string]Optional

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

ReturnsExpand Collapse

type PhaseGetResponse interface{…}

A result.

One of the following:

type PhaseGetResponseObject struct{…}

ID stringOptional

The unique ID of the ruleset.

Description stringOptional

An informative description of the ruleset.

Kind KindOptional

The kind of the ruleset.

One of the following:

const KindManaged Kind = "managed"

const KindCustom Kind = "custom"

const KindRoot Kind = "root"

const KindZone Kind = "zone"

LastUpdated TimeOptional

The timestamp of when the ruleset was last modified.

formatdate-time

Name stringOptional

The human-readable name of the ruleset.

minLength1

Phase PhaseOptional

The phase of the ruleset.

One of the following:

const PhaseDDoSL4 Phase = "ddos_l4"

const PhaseDDoSL7 Phase = "ddos_l7"

const PhaseHTTPConfigSettings Phase = "http_config_settings"

const PhaseHTTPCustomErrors Phase = "http_custom_errors"

const PhaseHTTPLogCustomFields Phase = "http_log_custom_fields"

const PhaseHTTPRatelimit Phase = "http_ratelimit"

const PhaseHTTPRequestCacheSettings Phase = "http_request_cache_settings"

const PhaseHTTPRequestDynamicRedirect Phase = "http_request_dynamic_redirect"

const PhaseHTTPRequestFirewallCustom Phase = "http_request_firewall_custom"

const PhaseHTTPRequestFirewallManaged Phase = "http_request_firewall_managed"

const PhaseHTTPRequestLateTransform Phase = "http_request_late_transform"

const PhaseHTTPRequestOrigin Phase = "http_request_origin"

const PhaseHTTPRequestRedirect Phase = "http_request_redirect"

const PhaseHTTPRequestSanitize Phase = "http_request_sanitize"

const PhaseHTTPRequestSBFM Phase = "http_request_sbfm"

const PhaseHTTPRequestTransform Phase = "http_request_transform"

const PhaseHTTPResponseCacheSettings Phase = "http_response_cache_settings"

const PhaseHTTPResponseCompression Phase = "http_response_compression"

const PhaseHTTPResponseFirewallCustom Phase = "http_response_firewall_custom"

const PhaseHTTPResponseFirewallManaged Phase = "http_response_firewall_managed"

const PhaseHTTPResponseHeadersTransform Phase = "http_response_headers_transform"

const PhaseMagicTransit Phase = "magic_transit"

const PhaseMagicTransitIDsManaged Phase = "magic_transit_ids_managed"

const PhaseMagicTransitManaged Phase = "magic_transit_managed"

const PhaseMagicTransitRatelimit Phase = "magic_transit_ratelimit"

Rules []PhaseGetResponseObjectRuleOptional

The list of rules in the ruleset.

One of the following:

type PhaseGetResponseObjectRulesBlockRule struct{…}

ID string

Action string

Enabled bool

Expression string

Ref string

type PhaseGetResponseObjectRulesChallengeRule struct{…}

ID string

The unique ID of the rule.

Action PhaseGetResponseObjectRulesChallengeRuleAction

The action to perform when the rule matches.

Enabled bool

Whether the rule should be executed.

Expression string

The expression defining which traffic will match the rule.

minLength1

LastUpdated Time

The timestamp of when the rule was last modified.

formatdate-time

Ref string

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

minLength1

Version string

The version of the rule.

ActionParameters unknownOptional

The parameters configuring the rule’s action.

Categories []stringOptional

The categories of the rule.

Description stringOptional

An informative description of the rule.

ExposedCredentialCheck PhaseGetResponseObjectRulesChallengeRuleExposedCredentialCheckOptional

Configuration for exposed credential checking.

PasswordExpression string

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

minLength1

UsernameExpression string

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

minLength1

Logging LoggingOptional

An object configuring the rule’s logging behavior.

Enabled bool

Whether to generate a log when the rule matches.

Ratelimit PhaseGetResponseObjectRulesChallengeRuleRatelimitOptional

An object configuring the rule’s rate limit behavior.

Characteristics []string

Characteristics of the request on which the rate limit counter will be incremented.

Period int64

Period in seconds over which the counter is being incremented.

minimum0

CountingExpression stringOptional

An expression that defines when the rate limit counter should be incremented. It defaults to the same as the rule’s expression.

minLength1

MitigationTimeout int64Optional

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

RequestsPerPeriod int64Optional

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

minimum1

RequestsToOrigin boolOptional

Whether counting is only performed when an origin is reached.

ScorePerPeriod int64Optional

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

ScoreResponseHeaderName stringOptional

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

minLength1

type PhaseGetResponseObjectRulesResponseCompressionRule struct{…}

ID string

Action string

Enabled bool

Expression string

Ref string

type PhaseGetResponseObjectRulesDDoSDynamicRule struct{…}

ID string

Action string

Enabled bool

Expression string

Ref string

type PhaseGetResponseObjectRulesExecuteRule struct{…}

ID string

Action string

Enabled bool

Expression string

Ref string

type PhaseGetResponseObjectRulesForceConnectionCloseRule struct{…}

ID string

Action string

Enabled bool

Expression string

Ref string

type PhaseGetResponseObjectRulesJavaScriptChallengeRule struct{…}

ID string

The unique ID of the rule.

Action PhaseGetResponseObjectRulesJavaScriptChallengeRuleAction

The action to perform when the rule matches.

Enabled bool

Whether the rule should be executed.

Expression string

The expression defining which traffic will match the rule.

minLength1

LastUpdated Time

The timestamp of when the rule was last modified.

formatdate-time

Ref string

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

minLength1

Version string

The version of the rule.

ActionParameters unknownOptional

The parameters configuring the rule’s action.

Categories []stringOptional

The categories of the rule.

Description stringOptional

An informative description of the rule.

ExposedCredentialCheck PhaseGetResponseObjectRulesJavaScriptChallengeRuleExposedCredentialCheckOptional

Configuration for exposed credential checking.

PasswordExpression string

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

minLength1

UsernameExpression string

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

minLength1

Logging LoggingOptional

An object configuring the rule’s logging behavior.

Enabled bool

Whether to generate a log when the rule matches.

Ratelimit PhaseGetResponseObjectRulesJavaScriptChallengeRuleRatelimitOptional

An object configuring the rule’s rate limit behavior.

Characteristics []string

Characteristics of the request on which the rate limit counter will be incremented.

Period int64

Period in seconds over which the counter is being incremented.

minimum0

CountingExpression stringOptional

An expression that defines when the rate limit counter should be incremented. It defaults to the same as the rule’s expression.

minLength1

MitigationTimeout int64Optional

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

RequestsPerPeriod int64Optional

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

minimum1

RequestsToOrigin boolOptional

Whether counting is only performed when an origin is reached.

ScorePerPeriod int64Optional

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

ScoreResponseHeaderName stringOptional

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

minLength1

type PhaseGetResponseObjectRulesLogRule struct{…}

ID string

Action string

Enabled bool

Expression string

Ref string

type PhaseGetResponseObjectRulesLogCustomFieldRule struct{…}

ID string

Action string

Enabled bool

Expression string

Ref string

type PhaseGetResponseObjectRulesManagedChallengeRule struct{…}

ID string

Action string

Enabled bool

Expression string

Ref string

type PhaseGetResponseObjectRulesRedirectRule struct{…}

ID string

Action string

Enabled bool

Expression string

Ref string

type PhaseGetResponseObjectRulesRewriteRule struct{…}

ID string

Action string

Enabled bool

Expression string

Ref string

type PhaseGetResponseObjectRulesRouteRule struct{…}

ID string

Action string

Enabled bool

Expression string

Ref string

type PhaseGetResponseObjectRulesScoreRule struct{…}

ID string

Action string

Enabled bool

Expression string

Ref string

type PhaseGetResponseObjectRulesServeErrorRule struct{…}

ID string

Action string

Enabled bool

Expression string

Ref string

type PhaseGetResponseObjectRulesSetCacheControlRule struct{…}

ID string

The unique ID of the rule.

Action PhaseGetResponseObjectRulesSetCacheControlRuleAction

The action to perform when the rule matches.

Enabled bool

Expression string

The expression defining which traffic will match the rule.

minLength1

LastUpdated Time

The timestamp of when the rule was last modified.

formatdate-time

Ref string

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

minLength1

Version string

The version of the rule.

ActionParameters PhaseGetResponseObjectRulesSetCacheControlRuleActionParametersOptional

The parameters configuring the rule’s action.

Immutable PhaseGetResponseObjectRulesSetCacheControlRuleActionParametersImmutableOptional

A cache-control directive configuration.

One of the following:

type PhaseGetResponseObjectRulesSetCacheControlRuleActionParametersImmutableSetDirective struct{…}

Set the directive.

Operation PhaseGetResponseObjectRulesSetCacheControlRuleActionParametersImmutableSetDirectiveOperation

The operation to perform on the cache-control directive.

One of the following:

const PhaseGetResponseObjectRulesSetCacheControlRuleActionParametersImmutableSetDirectiveOperationSet PhaseGetResponseObjectRulesSetCacheControlRuleActionParametersImmutableSetDirectiveOperation = "set"

const PhaseGetResponseObjectRulesSetCacheControlRuleActionParametersImmutableSetDirectiveOperationRemove PhaseGetResponseObjectRulesSetCacheControlRuleActionParametersImmutableSetDirectiveOperation = "remove"

CloudflareOnly boolOptional

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

type PhaseGetResponseObjectRulesSetCacheControlRuleActionParametersImmutableRemoveDirective struct{…}

Remove the directive.

Operation PhaseGetResponseObjectRulesSetCacheControlRuleActionParametersImmutableRemoveDirectiveOperation

The operation to perform on the cache-control directive.

One of the following:

const PhaseGetResponseObjectRulesSetCacheControlRuleActionParametersImmutableRemoveDirectiveOperationSet PhaseGetResponseObjectRulesSetCacheControlRuleActionParametersImmutableRemoveDirectiveOperation = "set"

const PhaseGetResponseObjectRulesSetCacheControlRuleActionParametersImmutableRemoveDirectiveOperationRemove PhaseGetResponseObjectRulesSetCacheControlRuleActionParametersImmutableRemoveDirectiveOperation = "remove"

CloudflareOnly boolOptional

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

MaxAge PhaseGetResponseObjectRulesSetCacheControlRuleActionParametersMaxAgeOptional

A cache-control directive configuration that accepts a duration value in seconds.

One of the following:

type PhaseGetResponseObjectRulesSetCacheControlRuleActionParametersMaxAgeSetDirective struct{…}

Set the directive with a duration value in seconds.

Operation PhaseGetResponseObjectRulesSetCacheControlRuleActionParametersMaxAgeSetDirectiveOperation

The operation to perform on the cache-control directive.

One of the following:

const PhaseGetResponseObjectRulesSetCacheControlRuleActionParametersMaxAgeSetDirectiveOperationSet PhaseGetResponseObjectRulesSetCacheControlRuleActionParametersMaxAgeSetDirectiveOperation = "set"

const PhaseGetResponseObjectRulesSetCacheControlRuleActionParametersMaxAgeSetDirectiveOperationRemove PhaseGetResponseObjectRulesSetCacheControlRuleActionParametersMaxAgeSetDirectiveOperation = "remove"

Value int64

The duration value in seconds for the directive.

minimum0

CloudflareOnly boolOptional

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

type PhaseGetResponseObjectRulesSetCacheControlRuleActionParametersMaxAgeRemoveDirective struct{…}

Remove the directive.

Operation PhaseGetResponseObjectRulesSetCacheControlRuleActionParametersMaxAgeRemoveDirectiveOperation

The operation to perform on the cache-control directive.

One of the following:

const PhaseGetResponseObjectRulesSetCacheControlRuleActionParametersMaxAgeRemoveDirectiveOperationSet PhaseGetResponseObjectRulesSetCacheControlRuleActionParametersMaxAgeRemoveDirectiveOperation = "set"

const PhaseGetResponseObjectRulesSetCacheControlRuleActionParametersMaxAgeRemoveDirectiveOperationRemove PhaseGetResponseObjectRulesSetCacheControlRuleActionParametersMaxAgeRemoveDirectiveOperation = "remove"

CloudflareOnly boolOptional

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

MustRevalidate PhaseGetResponseObjectRulesSetCacheControlRuleActionParametersMustRevalidateOptional

A cache-control directive configuration.

One of the following:

type PhaseGetResponseObjectRulesSetCacheControlRuleActionParametersMustRevalidateSetDirective struct{…}

Set the directive.

Operation PhaseGetResponseObjectRulesSetCacheControlRuleActionParametersMustRevalidateSetDirectiveOperation

The operation to perform on the cache-control directive.

One of the following:

const PhaseGetResponseObjectRulesSetCacheControlRuleActionParametersMustRevalidateSetDirectiveOperationSet PhaseGetResponseObjectRulesSetCacheControlRuleActionParametersMustRevalidateSetDirectiveOperation = "set"

const PhaseGetResponseObjectRulesSetCacheControlRuleActionParametersMustRevalidateSetDirectiveOperationRemove PhaseGetResponseObjectRulesSetCacheControlRuleActionParametersMustRevalidateSetDirectiveOperation = "remove"

CloudflareOnly boolOptional

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

type PhaseGetResponseObjectRulesSetCacheControlRuleActionParametersMustRevalidateRemoveDirective struct{…}

Remove the directive.

Operation PhaseGetResponseObjectRulesSetCacheControlRuleActionParametersMustRevalidateRemoveDirectiveOperation

The operation to perform on the cache-control directive.

One of the following:

const PhaseGetResponseObjectRulesSetCacheControlRuleActionParametersMustRevalidateRemoveDirectiveOperationSet PhaseGetResponseObjectRulesSetCacheControlRuleActionParametersMustRevalidateRemoveDirectiveOperation = "set"

const PhaseGetResponseObjectRulesSetCacheControlRuleActionParametersMustRevalidateRemoveDirectiveOperationRemove PhaseGetResponseObjectRulesSetCacheControlRuleActionParametersMustRevalidateRemoveDirectiveOperation = "remove"

CloudflareOnly boolOptional

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

MustUnderstand PhaseGetResponseObjectRulesSetCacheControlRuleActionParametersMustUnderstandOptional

A cache-control directive configuration.

One of the following:

type PhaseGetResponseObjectRulesSetCacheControlRuleActionParametersMustUnderstandSetDirective struct{…}

Set the directive.

Operation PhaseGetResponseObjectRulesSetCacheControlRuleActionParametersMustUnderstandSetDirectiveOperation

The operation to perform on the cache-control directive.

One of the following:

const PhaseGetResponseObjectRulesSetCacheControlRuleActionParametersMustUnderstandSetDirectiveOperationSet PhaseGetResponseObjectRulesSetCacheControlRuleActionParametersMustUnderstandSetDirectiveOperation = "set"

const PhaseGetResponseObjectRulesSetCacheControlRuleActionParametersMustUnderstandSetDirectiveOperationRemove PhaseGetResponseObjectRulesSetCacheControlRuleActionParametersMustUnderstandSetDirectiveOperation = "remove"

CloudflareOnly boolOptional

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

type PhaseGetResponseObjectRulesSetCacheControlRuleActionParametersMustUnderstandRemoveDirective struct{…}

Remove the directive.

Operation PhaseGetResponseObjectRulesSetCacheControlRuleActionParametersMustUnderstandRemoveDirectiveOperation

The operation to perform on the cache-control directive.

One of the following:

const PhaseGetResponseObjectRulesSetCacheControlRuleActionParametersMustUnderstandRemoveDirectiveOperationSet PhaseGetResponseObjectRulesSetCacheControlRuleActionParametersMustUnderstandRemoveDirectiveOperation = "set"

const PhaseGetResponseObjectRulesSetCacheControlRuleActionParametersMustUnderstandRemoveDirectiveOperationRemove PhaseGetResponseObjectRulesSetCacheControlRuleActionParametersMustUnderstandRemoveDirectiveOperation = "remove"

CloudflareOnly boolOptional

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

NoCache PhaseGetResponseObjectRulesSetCacheControlRuleActionParametersNoCacheOptional

A cache-control directive configuration that accepts optional qualifiers (header names).

One of the following:

type PhaseGetResponseObjectRulesSetCacheControlRuleActionParametersNoCacheSetDirective struct{…}

Set the directive with optional qualifiers.

Operation PhaseGetResponseObjectRulesSetCacheControlRuleActionParametersNoCacheSetDirectiveOperation

The operation to perform on the cache-control directive.

One of the following:

const PhaseGetResponseObjectRulesSetCacheControlRuleActionParametersNoCacheSetDirectiveOperationSet PhaseGetResponseObjectRulesSetCacheControlRuleActionParametersNoCacheSetDirectiveOperation = "set"

const PhaseGetResponseObjectRulesSetCacheControlRuleActionParametersNoCacheSetDirectiveOperationRemove PhaseGetResponseObjectRulesSetCacheControlRuleActionParametersNoCacheSetDirectiveOperation = "remove"

CloudflareOnly boolOptional

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

Qualifiers []stringOptional

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

type PhaseGetResponseObjectRulesSetCacheControlRuleActionParametersNoCacheRemoveDirective struct{…}

Remove the directive.

Operation PhaseGetResponseObjectRulesSetCacheControlRuleActionParametersNoCacheRemoveDirectiveOperation

The operation to perform on the cache-control directive.

One of the following:

const PhaseGetResponseObjectRulesSetCacheControlRuleActionParametersNoCacheRemoveDirectiveOperationSet PhaseGetResponseObjectRulesSetCacheControlRuleActionParametersNoCacheRemoveDirectiveOperation = "set"

const PhaseGetResponseObjectRulesSetCacheControlRuleActionParametersNoCacheRemoveDirectiveOperationRemove PhaseGetResponseObjectRulesSetCacheControlRuleActionParametersNoCacheRemoveDirectiveOperation = "remove"

CloudflareOnly boolOptional

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

NoStore PhaseGetResponseObjectRulesSetCacheControlRuleActionParametersNoStoreOptional

A cache-control directive configuration.

One of the following:

type PhaseGetResponseObjectRulesSetCacheControlRuleActionParametersNoStoreSetDirective struct{…}

Set the directive.

Operation PhaseGetResponseObjectRulesSetCacheControlRuleActionParametersNoStoreSetDirectiveOperation

The operation to perform on the cache-control directive.

One of the following:

const PhaseGetResponseObjectRulesSetCacheControlRuleActionParametersNoStoreSetDirectiveOperationSet PhaseGetResponseObjectRulesSetCacheControlRuleActionParametersNoStoreSetDirectiveOperation = "set"

const PhaseGetResponseObjectRulesSetCacheControlRuleActionParametersNoStoreSetDirectiveOperationRemove PhaseGetResponseObjectRulesSetCacheControlRuleActionParametersNoStoreSetDirectiveOperation = "remove"

CloudflareOnly boolOptional

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

type PhaseGetResponseObjectRulesSetCacheControlRuleActionParametersNoStoreRemoveDirective struct{…}

Remove the directive.

Operation PhaseGetResponseObjectRulesSetCacheControlRuleActionParametersNoStoreRemoveDirectiveOperation

The operation to perform on the cache-control directive.

One of the following:

const PhaseGetResponseObjectRulesSetCacheControlRuleActionParametersNoStoreRemoveDirectiveOperationSet PhaseGetResponseObjectRulesSetCacheControlRuleActionParametersNoStoreRemoveDirectiveOperation = "set"

const PhaseGetResponseObjectRulesSetCacheControlRuleActionParametersNoStoreRemoveDirectiveOperationRemove PhaseGetResponseObjectRulesSetCacheControlRuleActionParametersNoStoreRemoveDirectiveOperation = "remove"

CloudflareOnly boolOptional

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

NoTransform PhaseGetResponseObjectRulesSetCacheControlRuleActionParametersNoTransformOptional

A cache-control directive configuration.

One of the following:

type PhaseGetResponseObjectRulesSetCacheControlRuleActionParametersNoTransformSetDirective struct{…}

Set the directive.

Operation PhaseGetResponseObjectRulesSetCacheControlRuleActionParametersNoTransformSetDirectiveOperation

The operation to perform on the cache-control directive.

One of the following:

const PhaseGetResponseObjectRulesSetCacheControlRuleActionParametersNoTransformSetDirectiveOperationSet PhaseGetResponseObjectRulesSetCacheControlRuleActionParametersNoTransformSetDirectiveOperation = "set"

const PhaseGetResponseObjectRulesSetCacheControlRuleActionParametersNoTransformSetDirectiveOperationRemove PhaseGetResponseObjectRulesSetCacheControlRuleActionParametersNoTransformSetDirectiveOperation = "remove"

CloudflareOnly boolOptional

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

type PhaseGetResponseObjectRulesSetCacheControlRuleActionParametersNoTransformRemoveDirective struct{…}

Remove the directive.

Operation PhaseGetResponseObjectRulesSetCacheControlRuleActionParametersNoTransformRemoveDirectiveOperation

The operation to perform on the cache-control directive.

One of the following:

const PhaseGetResponseObjectRulesSetCacheControlRuleActionParametersNoTransformRemoveDirectiveOperationSet PhaseGetResponseObjectRulesSetCacheControlRuleActionParametersNoTransformRemoveDirectiveOperation = "set"

const PhaseGetResponseObjectRulesSetCacheControlRuleActionParametersNoTransformRemoveDirectiveOperationRemove PhaseGetResponseObjectRulesSetCacheControlRuleActionParametersNoTransformRemoveDirectiveOperation = "remove"

CloudflareOnly boolOptional

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

Private PhaseGetResponseObjectRulesSetCacheControlRuleActionParametersPrivateOptional

A cache-control directive configuration that accepts optional qualifiers (header names).

One of the following:

type PhaseGetResponseObjectRulesSetCacheControlRuleActionParametersPrivateSetDirective struct{…}

Set the directive with optional qualifiers.

Operation PhaseGetResponseObjectRulesSetCacheControlRuleActionParametersPrivateSetDirectiveOperation

The operation to perform on the cache-control directive.

One of the following:

const PhaseGetResponseObjectRulesSetCacheControlRuleActionParametersPrivateSetDirectiveOperationSet PhaseGetResponseObjectRulesSetCacheControlRuleActionParametersPrivateSetDirectiveOperation = "set"

const PhaseGetResponseObjectRulesSetCacheControlRuleActionParametersPrivateSetDirectiveOperationRemove PhaseGetResponseObjectRulesSetCacheControlRuleActionParametersPrivateSetDirectiveOperation = "remove"

CloudflareOnly boolOptional

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

Qualifiers []stringOptional

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

type PhaseGetResponseObjectRulesSetCacheControlRuleActionParametersPrivateRemoveDirective struct{…}

Remove the directive.

Operation PhaseGetResponseObjectRulesSetCacheControlRuleActionParametersPrivateRemoveDirectiveOperation

The operation to perform on the cache-control directive.

One of the following:

const PhaseGetResponseObjectRulesSetCacheControlRuleActionParametersPrivateRemoveDirectiveOperationSet PhaseGetResponseObjectRulesSetCacheControlRuleActionParametersPrivateRemoveDirectiveOperation = "set"

const PhaseGetResponseObjectRulesSetCacheControlRuleActionParametersPrivateRemoveDirectiveOperationRemove PhaseGetResponseObjectRulesSetCacheControlRuleActionParametersPrivateRemoveDirectiveOperation = "remove"

CloudflareOnly boolOptional

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

ProxyRevalidate PhaseGetResponseObjectRulesSetCacheControlRuleActionParametersProxyRevalidateOptional

A cache-control directive configuration.

One of the following:

type PhaseGetResponseObjectRulesSetCacheControlRuleActionParametersProxyRevalidateSetDirective struct{…}

Set the directive.

Operation PhaseGetResponseObjectRulesSetCacheControlRuleActionParametersProxyRevalidateSetDirectiveOperation

The operation to perform on the cache-control directive.

One of the following:

const PhaseGetResponseObjectRulesSetCacheControlRuleActionParametersProxyRevalidateSetDirectiveOperationSet PhaseGetResponseObjectRulesSetCacheControlRuleActionParametersProxyRevalidateSetDirectiveOperation = "set"

const PhaseGetResponseObjectRulesSetCacheControlRuleActionParametersProxyRevalidateSetDirectiveOperationRemove PhaseGetResponseObjectRulesSetCacheControlRuleActionParametersProxyRevalidateSetDirectiveOperation = "remove"

CloudflareOnly boolOptional

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

type PhaseGetResponseObjectRulesSetCacheControlRuleActionParametersProxyRevalidateRemoveDirective struct{…}

Remove the directive.

Operation PhaseGetResponseObjectRulesSetCacheControlRuleActionParametersProxyRevalidateRemoveDirectiveOperation

The operation to perform on the cache-control directive.

One of the following:

const PhaseGetResponseObjectRulesSetCacheControlRuleActionParametersProxyRevalidateRemoveDirectiveOperationSet PhaseGetResponseObjectRulesSetCacheControlRuleActionParametersProxyRevalidateRemoveDirectiveOperation = "set"

const PhaseGetResponseObjectRulesSetCacheControlRuleActionParametersProxyRevalidateRemoveDirectiveOperationRemove PhaseGetResponseObjectRulesSetCacheControlRuleActionParametersProxyRevalidateRemoveDirectiveOperation = "remove"

CloudflareOnly boolOptional

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

Public PhaseGetResponseObjectRulesSetCacheControlRuleActionParametersPublicOptional

A cache-control directive configuration.

One of the following:

type PhaseGetResponseObjectRulesSetCacheControlRuleActionParametersPublicSetDirective struct{…}

Set the directive.

Operation PhaseGetResponseObjectRulesSetCacheControlRuleActionParametersPublicSetDirectiveOperation

The operation to perform on the cache-control directive.

One of the following:

const PhaseGetResponseObjectRulesSetCacheControlRuleActionParametersPublicSetDirectiveOperationSet PhaseGetResponseObjectRulesSetCacheControlRuleActionParametersPublicSetDirectiveOperation = "set"

const PhaseGetResponseObjectRulesSetCacheControlRuleActionParametersPublicSetDirectiveOperationRemove PhaseGetResponseObjectRulesSetCacheControlRuleActionParametersPublicSetDirectiveOperation = "remove"

CloudflareOnly boolOptional

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

type PhaseGetResponseObjectRulesSetCacheControlRuleActionParametersPublicRemoveDirective struct{…}

Remove the directive.

Operation PhaseGetResponseObjectRulesSetCacheControlRuleActionParametersPublicRemoveDirectiveOperation

The operation to perform on the cache-control directive.

One of the following:

const PhaseGetResponseObjectRulesSetCacheControlRuleActionParametersPublicRemoveDirectiveOperationSet PhaseGetResponseObjectRulesSetCacheControlRuleActionParametersPublicRemoveDirectiveOperation = "set"

const PhaseGetResponseObjectRulesSetCacheControlRuleActionParametersPublicRemoveDirectiveOperationRemove PhaseGetResponseObjectRulesSetCacheControlRuleActionParametersPublicRemoveDirectiveOperation = "remove"

CloudflareOnly boolOptional

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

SMaxage PhaseGetResponseObjectRulesSetCacheControlRuleActionParametersSMaxageOptional

A cache-control directive configuration that accepts a duration value in seconds.

One of the following:

type PhaseGetResponseObjectRulesSetCacheControlRuleActionParametersSMaxageSetDirective struct{…}

Set the directive with a duration value in seconds.

Operation PhaseGetResponseObjectRulesSetCacheControlRuleActionParametersSMaxageSetDirectiveOperation

The operation to perform on the cache-control directive.

One of the following:

const PhaseGetResponseObjectRulesSetCacheControlRuleActionParametersSMaxageSetDirectiveOperationSet PhaseGetResponseObjectRulesSetCacheControlRuleActionParametersSMaxageSetDirectiveOperation = "set"

const PhaseGetResponseObjectRulesSetCacheControlRuleActionParametersSMaxageSetDirectiveOperationRemove PhaseGetResponseObjectRulesSetCacheControlRuleActionParametersSMaxageSetDirectiveOperation = "remove"

Value int64

The duration value in seconds for the directive.

minimum0

CloudflareOnly boolOptional

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

type PhaseGetResponseObjectRulesSetCacheControlRuleActionParametersSMaxageRemoveDirective struct{…}

Remove the directive.

Operation PhaseGetResponseObjectRulesSetCacheControlRuleActionParametersSMaxageRemoveDirectiveOperation

The operation to perform on the cache-control directive.

One of the following:

const PhaseGetResponseObjectRulesSetCacheControlRuleActionParametersSMaxageRemoveDirectiveOperationSet PhaseGetResponseObjectRulesSetCacheControlRuleActionParametersSMaxageRemoveDirectiveOperation = "set"

const PhaseGetResponseObjectRulesSetCacheControlRuleActionParametersSMaxageRemoveDirectiveOperationRemove PhaseGetResponseObjectRulesSetCacheControlRuleActionParametersSMaxageRemoveDirectiveOperation = "remove"

CloudflareOnly boolOptional

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

StaleIfError PhaseGetResponseObjectRulesSetCacheControlRuleActionParametersStaleIfErrorOptional

A cache-control directive configuration that accepts a duration value in seconds.

One of the following:

type PhaseGetResponseObjectRulesSetCacheControlRuleActionParametersStaleIfErrorSetDirective struct{…}

Set the directive with a duration value in seconds.

Operation PhaseGetResponseObjectRulesSetCacheControlRuleActionParametersStaleIfErrorSetDirectiveOperation

The operation to perform on the cache-control directive.

One of the following:

const PhaseGetResponseObjectRulesSetCacheControlRuleActionParametersStaleIfErrorSetDirectiveOperationSet PhaseGetResponseObjectRulesSetCacheControlRuleActionParametersStaleIfErrorSetDirectiveOperation = "set"

const PhaseGetResponseObjectRulesSetCacheControlRuleActionParametersStaleIfErrorSetDirectiveOperationRemove PhaseGetResponseObjectRulesSetCacheControlRuleActionParametersStaleIfErrorSetDirectiveOperation = "remove"

Value int64

The duration value in seconds for the directive.

minimum0

CloudflareOnly boolOptional

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

type PhaseGetResponseObjectRulesSetCacheControlRuleActionParametersStaleIfErrorRemoveDirective struct{…}

Remove the directive.

Operation PhaseGetResponseObjectRulesSetCacheControlRuleActionParametersStaleIfErrorRemoveDirectiveOperation

The operation to perform on the cache-control directive.

One of the following:

const PhaseGetResponseObjectRulesSetCacheControlRuleActionParametersStaleIfErrorRemoveDirectiveOperationSet PhaseGetResponseObjectRulesSetCacheControlRuleActionParametersStaleIfErrorRemoveDirectiveOperation = "set"

const PhaseGetResponseObjectRulesSetCacheControlRuleActionParametersStaleIfErrorRemoveDirectiveOperationRemove PhaseGetResponseObjectRulesSetCacheControlRuleActionParametersStaleIfErrorRemoveDirectiveOperation = "remove"

CloudflareOnly boolOptional

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

StaleWhileRevalidate PhaseGetResponseObjectRulesSetCacheControlRuleActionParametersStaleWhileRevalidateOptional

A cache-control directive configuration that accepts a duration value in seconds.

One of the following:

type PhaseGetResponseObjectRulesSetCacheControlRuleActionParametersStaleWhileRevalidateSetDirective struct{…}

Set the directive with a duration value in seconds.

Operation PhaseGetResponseObjectRulesSetCacheControlRuleActionParametersStaleWhileRevalidateSetDirectiveOperation

The operation to perform on the cache-control directive.

One of the following:

const PhaseGetResponseObjectRulesSetCacheControlRuleActionParametersStaleWhileRevalidateSetDirectiveOperationSet PhaseGetResponseObjectRulesSetCacheControlRuleActionParametersStaleWhileRevalidateSetDirectiveOperation = "set"

const PhaseGetResponseObjectRulesSetCacheControlRuleActionParametersStaleWhileRevalidateSetDirectiveOperationRemove PhaseGetResponseObjectRulesSetCacheControlRuleActionParametersStaleWhileRevalidateSetDirectiveOperation = "remove"

Value int64

The duration value in seconds for the directive.

minimum0

CloudflareOnly boolOptional

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

type PhaseGetResponseObjectRulesSetCacheControlRuleActionParametersStaleWhileRevalidateRemoveDirective struct{…}

Remove the directive.

Operation PhaseGetResponseObjectRulesSetCacheControlRuleActionParametersStaleWhileRevalidateRemoveDirectiveOperation

The operation to perform on the cache-control directive.

One of the following:

const PhaseGetResponseObjectRulesSetCacheControlRuleActionParametersStaleWhileRevalidateRemoveDirectiveOperationSet PhaseGetResponseObjectRulesSetCacheControlRuleActionParametersStaleWhileRevalidateRemoveDirectiveOperation = "set"

const PhaseGetResponseObjectRulesSetCacheControlRuleActionParametersStaleWhileRevalidateRemoveDirectiveOperationRemove PhaseGetResponseObjectRulesSetCacheControlRuleActionParametersStaleWhileRevalidateRemoveDirectiveOperation = "remove"

CloudflareOnly boolOptional

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

Categories []stringOptional

The categories of the rule.

Description stringOptional

An informative description of the rule.

ExposedCredentialCheck PhaseGetResponseObjectRulesSetCacheControlRuleExposedCredentialCheckOptional

Configuration for exposed credential checking.

PasswordExpression string

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

minLength1

UsernameExpression string

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

minLength1

Logging LoggingOptional

An object configuring the rule’s logging behavior.

Enabled bool

Whether to generate a log when the rule matches.

Ratelimit PhaseGetResponseObjectRulesSetCacheControlRuleRatelimitOptional

An object configuring the rule’s rate limit behavior.

Characteristics []string

Characteristics of the request on which the rate limit counter will be incremented.

Period int64

Period in seconds over which the counter is being incremented.

minimum0

CountingExpression stringOptional

An expression that defines when the rate limit counter should be incremented. It defaults to the same as the rule’s expression.

minLength1

MitigationTimeout int64Optional

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

RequestsPerPeriod int64Optional

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

minimum1

RequestsToOrigin boolOptional

Whether counting is only performed when an origin is reached.

ScorePerPeriod int64Optional

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

ScoreResponseHeaderName stringOptional

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

minLength1

type PhaseGetResponseObjectRulesSetCacheSettingsRule struct{…}

ID string

Action string

Enabled bool

Expression string

Ref string

type PhaseGetResponseObjectRulesSetCacheTagsRule struct{…}

ID string

The unique ID of the rule.

Action PhaseGetResponseObjectRulesSetCacheTagsRuleAction

The action to perform when the rule matches.

Enabled bool

Expression string

The expression defining which traffic will match the rule.

minLength1

LastUpdated Time

The timestamp of when the rule was last modified.

formatdate-time

Ref string

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

minLength1

Version string

The version of the rule.

ActionParameters PhaseGetResponseObjectRulesSetCacheTagsRuleActionParametersOptional

The parameters configuring the rule’s action.

One of the following:

type PhaseGetResponseObjectRulesSetCacheTagsRuleActionParametersAddCacheTagsValues struct{…}

Add cache tags using a list of values.

Operation PhaseGetResponseObjectRulesSetCacheTagsRuleActionParametersAddCacheTagsValuesOperation

The operation to perform on the cache tags.

One of the following:

const PhaseGetResponseObjectRulesSetCacheTagsRuleActionParametersAddCacheTagsValuesOperationAdd PhaseGetResponseObjectRulesSetCacheTagsRuleActionParametersAddCacheTagsValuesOperation = "add"

const PhaseGetResponseObjectRulesSetCacheTagsRuleActionParametersAddCacheTagsValuesOperationRemove PhaseGetResponseObjectRulesSetCacheTagsRuleActionParametersAddCacheTagsValuesOperation = "remove"

const PhaseGetResponseObjectRulesSetCacheTagsRuleActionParametersAddCacheTagsValuesOperationSet PhaseGetResponseObjectRulesSetCacheTagsRuleActionParametersAddCacheTagsValuesOperation = "set"

Values []string

A list of cache tag values.

type PhaseGetResponseObjectRulesSetCacheTagsRuleActionParametersAddCacheTagsExpression struct{…}

Add cache tags using an expression.

Expression string

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

minLength1

Operation PhaseGetResponseObjectRulesSetCacheTagsRuleActionParametersAddCacheTagsExpressionOperation

The operation to perform on the cache tags.

One of the following:

const PhaseGetResponseObjectRulesSetCacheTagsRuleActionParametersAddCacheTagsExpressionOperationAdd PhaseGetResponseObjectRulesSetCacheTagsRuleActionParametersAddCacheTagsExpressionOperation = "add"

const PhaseGetResponseObjectRulesSetCacheTagsRuleActionParametersAddCacheTagsExpressionOperationRemove PhaseGetResponseObjectRulesSetCacheTagsRuleActionParametersAddCacheTagsExpressionOperation = "remove"

const PhaseGetResponseObjectRulesSetCacheTagsRuleActionParametersAddCacheTagsExpressionOperationSet PhaseGetResponseObjectRulesSetCacheTagsRuleActionParametersAddCacheTagsExpressionOperation = "set"

type PhaseGetResponseObjectRulesSetCacheTagsRuleActionParametersRemoveCacheTagsValues struct{…}

Remove cache tags using a list of values.

Operation PhaseGetResponseObjectRulesSetCacheTagsRuleActionParametersRemoveCacheTagsValuesOperation

The operation to perform on the cache tags.

One of the following:

const PhaseGetResponseObjectRulesSetCacheTagsRuleActionParametersRemoveCacheTagsValuesOperationAdd PhaseGetResponseObjectRulesSetCacheTagsRuleActionParametersRemoveCacheTagsValuesOperation = "add"

const PhaseGetResponseObjectRulesSetCacheTagsRuleActionParametersRemoveCacheTagsValuesOperationRemove PhaseGetResponseObjectRulesSetCacheTagsRuleActionParametersRemoveCacheTagsValuesOperation = "remove"

const PhaseGetResponseObjectRulesSetCacheTagsRuleActionParametersRemoveCacheTagsValuesOperationSet PhaseGetResponseObjectRulesSetCacheTagsRuleActionParametersRemoveCacheTagsValuesOperation = "set"

Values []string

A list of cache tag values.

type PhaseGetResponseObjectRulesSetCacheTagsRuleActionParametersRemoveCacheTagsExpression struct{…}

Remove cache tags using an expression.

Expression string

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

minLength1

Operation PhaseGetResponseObjectRulesSetCacheTagsRuleActionParametersRemoveCacheTagsExpressionOperation

The operation to perform on the cache tags.

One of the following:

const PhaseGetResponseObjectRulesSetCacheTagsRuleActionParametersRemoveCacheTagsExpressionOperationAdd PhaseGetResponseObjectRulesSetCacheTagsRuleActionParametersRemoveCacheTagsExpressionOperation = "add"

const PhaseGetResponseObjectRulesSetCacheTagsRuleActionParametersRemoveCacheTagsExpressionOperationRemove PhaseGetResponseObjectRulesSetCacheTagsRuleActionParametersRemoveCacheTagsExpressionOperation = "remove"

const PhaseGetResponseObjectRulesSetCacheTagsRuleActionParametersRemoveCacheTagsExpressionOperationSet PhaseGetResponseObjectRulesSetCacheTagsRuleActionParametersRemoveCacheTagsExpressionOperation = "set"

type PhaseGetResponseObjectRulesSetCacheTagsRuleActionParametersSetCacheTagsValues struct{…}

Set cache tags using a list of values.

Operation PhaseGetResponseObjectRulesSetCacheTagsRuleActionParametersSetCacheTagsValuesOperation

The operation to perform on the cache tags.

One of the following:

const PhaseGetResponseObjectRulesSetCacheTagsRuleActionParametersSetCacheTagsValuesOperationAdd PhaseGetResponseObjectRulesSetCacheTagsRuleActionParametersSetCacheTagsValuesOperation = "add"

const PhaseGetResponseObjectRulesSetCacheTagsRuleActionParametersSetCacheTagsValuesOperationRemove PhaseGetResponseObjectRulesSetCacheTagsRuleActionParametersSetCacheTagsValuesOperation = "remove"

const PhaseGetResponseObjectRulesSetCacheTagsRuleActionParametersSetCacheTagsValuesOperationSet PhaseGetResponseObjectRulesSetCacheTagsRuleActionParametersSetCacheTagsValuesOperation = "set"

Values []string

A list of cache tag values.

type PhaseGetResponseObjectRulesSetCacheTagsRuleActionParametersSetCacheTagsExpression struct{…}

Set cache tags using an expression.

Expression string

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

minLength1

Operation PhaseGetResponseObjectRulesSetCacheTagsRuleActionParametersSetCacheTagsExpressionOperation

The operation to perform on the cache tags.

One of the following:

const PhaseGetResponseObjectRulesSetCacheTagsRuleActionParametersSetCacheTagsExpressionOperationAdd PhaseGetResponseObjectRulesSetCacheTagsRuleActionParametersSetCacheTagsExpressionOperation = "add"

const PhaseGetResponseObjectRulesSetCacheTagsRuleActionParametersSetCacheTagsExpressionOperationRemove PhaseGetResponseObjectRulesSetCacheTagsRuleActionParametersSetCacheTagsExpressionOperation = "remove"

const PhaseGetResponseObjectRulesSetCacheTagsRuleActionParametersSetCacheTagsExpressionOperationSet PhaseGetResponseObjectRulesSetCacheTagsRuleActionParametersSetCacheTagsExpressionOperation = "set"

Categories []stringOptional

The categories of the rule.

Description stringOptional

An informative description of the rule.

ExposedCredentialCheck PhaseGetResponseObjectRulesSetCacheTagsRuleExposedCredentialCheckOptional

Configuration for exposed credential checking.

PasswordExpression string

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

minLength1

UsernameExpression string

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

minLength1

Logging LoggingOptional

An object configuring the rule’s logging behavior.

Enabled bool

Whether to generate a log when the rule matches.

Ratelimit PhaseGetResponseObjectRulesSetCacheTagsRuleRatelimitOptional

An object configuring the rule’s rate limit behavior.

Characteristics []string

Characteristics of the request on which the rate limit counter will be incremented.

Period int64

Period in seconds over which the counter is being incremented.

minimum0

CountingExpression stringOptional

An expression that defines when the rate limit counter should be incremented. It defaults to the same as the rule’s expression.

minLength1

MitigationTimeout int64Optional

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

RequestsPerPeriod int64Optional

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

minimum1

RequestsToOrigin boolOptional

Whether counting is only performed when an origin is reached.

ScorePerPeriod int64Optional

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

ScoreResponseHeaderName stringOptional

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

minLength1

type PhaseGetResponseObjectRulesSetConfigurationRule struct{…}

ID string

Action string

Enabled bool

Expression string

Ref string

type PhaseGetResponseObjectRulesSkipRule struct{…}

ID string

Action string

Enabled bool

Expression string

Ref string

type PhaseGetResponseObjectRulesTransformResponseHTMLRule struct{…}

ID string

The unique ID of the rule.

Action PhaseGetResponseObjectRulesTransformResponseHTMLRuleAction

The action to perform when the rule matches.

Enabled bool

Expression string

The expression defining which traffic will match the rule.

minLength1

LastUpdated Time

The timestamp of when the rule was last modified.

formatdate-time

Ref string

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

minLength1

Version string

The version of the rule.

ActionParameters PhaseGetResponseObjectRulesTransformResponseHTMLRuleActionParametersOptional

The parameters configuring the rule’s action.

LinkMaze unknown

Enables the link maze transformation on the response.

Categories []stringOptional

The categories of the rule.

Description stringOptional

An informative description of the rule.

ExposedCredentialCheck PhaseGetResponseObjectRulesTransformResponseHTMLRuleExposedCredentialCheckOptional

Configuration for exposed credential checking.

PasswordExpression string

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

minLength1

UsernameExpression string

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

minLength1

Logging LoggingOptional

An object configuring the rule’s logging behavior.

Enabled bool

Whether to generate a log when the rule matches.

Ratelimit PhaseGetResponseObjectRulesTransformResponseHTMLRuleRatelimitOptional

An object configuring the rule’s rate limit behavior.

Characteristics []string

Characteristics of the request on which the rate limit counter will be incremented.

Period int64

Period in seconds over which the counter is being incremented.

minimum0

CountingExpression stringOptional

An expression that defines when the rate limit counter should be incremented. It defaults to the same as the rule’s expression.

minLength1

MitigationTimeout int64Optional

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

RequestsPerPeriod int64Optional

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

minimum1

RequestsToOrigin boolOptional

Whether counting is only performed when an origin is reached.

ScorePerPeriod int64Optional

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

ScoreResponseHeaderName stringOptional

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

minLength1

Version stringOptional

The version of the ruleset.

type PhaseGetResponseObject struct{…}

ID stringOptional

The unique ID of the ruleset.

Description stringOptional

An informative description of the ruleset.

Kind KindOptional

The kind of the ruleset.

One of the following:

const KindManaged Kind = "managed"

const KindCustom Kind = "custom"

const KindRoot Kind = "root"

const KindZone Kind = "zone"

LastUpdated TimeOptional

The timestamp of when the ruleset was last modified.

formatdate-time

Name stringOptional

The human-readable name of the ruleset.

minLength1

Phase PhaseOptional

The phase of the ruleset.

One of the following:

const PhaseDDoSL4 Phase = "ddos_l4"

const PhaseDDoSL7 Phase = "ddos_l7"

const PhaseHTTPConfigSettings Phase = "http_config_settings"

const PhaseHTTPCustomErrors Phase = "http_custom_errors"

const PhaseHTTPLogCustomFields Phase = "http_log_custom_fields"

const PhaseHTTPRatelimit Phase = "http_ratelimit"

const PhaseHTTPRequestCacheSettings Phase = "http_request_cache_settings"

const PhaseHTTPRequestDynamicRedirect Phase = "http_request_dynamic_redirect"

const PhaseHTTPRequestFirewallCustom Phase = "http_request_firewall_custom"

const PhaseHTTPRequestFirewallManaged Phase = "http_request_firewall_managed"

const PhaseHTTPRequestLateTransform Phase = "http_request_late_transform"

const PhaseHTTPRequestOrigin Phase = "http_request_origin"

const PhaseHTTPRequestRedirect Phase = "http_request_redirect"

const PhaseHTTPRequestSanitize Phase = "http_request_sanitize"

const PhaseHTTPRequestSBFM Phase = "http_request_sbfm"

const PhaseHTTPRequestTransform Phase = "http_request_transform"

const PhaseHTTPResponseCacheSettings Phase = "http_response_cache_settings"

const PhaseHTTPResponseCompression Phase = "http_response_compression"

const PhaseHTTPResponseFirewallCustom Phase = "http_response_firewall_custom"

const PhaseHTTPResponseFirewallManaged Phase = "http_response_firewall_managed"

const PhaseHTTPResponseHeadersTransform Phase = "http_response_headers_transform"

const PhaseMagicTransit Phase = "magic_transit"

const PhaseMagicTransitIDsManaged Phase = "magic_transit_ids_managed"

const PhaseMagicTransitManaged Phase = "magic_transit_managed"

const PhaseMagicTransitRatelimit Phase = "magic_transit_ratelimit"

Rules []PhaseGetResponseObjectRuleOptional

The list of rules in the ruleset.

One of the following:

type PhaseGetResponseObjectRulesBlockRule struct{…}

ID string

Action string

Enabled bool

Expression string

Ref string

type PhaseGetResponseObjectRulesChallengeRule struct{…}

ID string

The unique ID of the rule.

Action PhaseGetResponseObjectRulesChallengeRuleAction

The action to perform when the rule matches.

Enabled bool

Whether the rule should be executed.

Expression string

The expression defining which traffic will match the rule.

minLength1

LastUpdated Time

The timestamp of when the rule was last modified.

formatdate-time

Ref string

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

minLength1

Version string

The version of the rule.

ActionParameters unknownOptional

The parameters configuring the rule’s action.

Categories []stringOptional

The categories of the rule.

Description stringOptional

An informative description of the rule.

ExposedCredentialCheck PhaseGetResponseObjectRulesChallengeRuleExposedCredentialCheckOptional

Configuration for exposed credential checking.

PasswordExpression string

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

minLength1

UsernameExpression string

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

minLength1

Logging LoggingOptional

An object configuring the rule’s logging behavior.

Enabled bool

Whether to generate a log when the rule matches.

Ratelimit PhaseGetResponseObjectRulesChallengeRuleRatelimitOptional

An object configuring the rule’s rate limit behavior.

Characteristics []string

Characteristics of the request on which the rate limit counter will be incremented.

Period int64

Period in seconds over which the counter is being incremented.

minimum0

CountingExpression stringOptional

An expression that defines when the rate limit counter should be incremented. It defaults to the same as the rule’s expression.

minLength1

MitigationTimeout int64Optional

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

RequestsPerPeriod int64Optional

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

minimum1

RequestsToOrigin boolOptional

Whether counting is only performed when an origin is reached.

ScorePerPeriod int64Optional

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

ScoreResponseHeaderName stringOptional

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

minLength1

type PhaseGetResponseObjectRulesResponseCompressionRule struct{…}

ID string

Action string

Enabled bool

Expression string

Ref string

type PhaseGetResponseObjectRulesDDoSDynamicRule struct{…}

ID string

Action string

Enabled bool

Expression string

Ref string

type PhaseGetResponseObjectRulesExecuteRule struct{…}

ID string

Action string

Enabled bool

Expression string

Ref string

type PhaseGetResponseObjectRulesForceConnectionCloseRule struct{…}

ID string

Action string

Enabled bool

Expression string

Ref string

type PhaseGetResponseObjectRulesJavaScriptChallengeRule struct{…}

ID string

The unique ID of the rule.

Action PhaseGetResponseObjectRulesJavaScriptChallengeRuleAction

The action to perform when the rule matches.

Enabled bool

Whether the rule should be executed.

Expression string

The expression defining which traffic will match the rule.

minLength1

LastUpdated Time

The timestamp of when the rule was last modified.

formatdate-time

Ref string

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

minLength1

Version string

The version of the rule.

ActionParameters unknownOptional

The parameters configuring the rule’s action.

Categories []stringOptional

The categories of the rule.

Description stringOptional

An informative description of the rule.

ExposedCredentialCheck PhaseGetResponseObjectRulesJavaScriptChallengeRuleExposedCredentialCheckOptional

Configuration for exposed credential checking.

PasswordExpression string

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

minLength1

UsernameExpression string

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

minLength1

Logging LoggingOptional

An object configuring the rule’s logging behavior.

Enabled bool

Whether to generate a log when the rule matches.

Ratelimit PhaseGetResponseObjectRulesJavaScriptChallengeRuleRatelimitOptional

An object configuring the rule’s rate limit behavior.

Characteristics []string

Characteristics of the request on which the rate limit counter will be incremented.

Period int64

Period in seconds over which the counter is being incremented.

minimum0

CountingExpression stringOptional

An expression that defines when the rate limit counter should be incremented. It defaults to the same as the rule’s expression.

minLength1

MitigationTimeout int64Optional

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

RequestsPerPeriod int64Optional

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

minimum1

RequestsToOrigin boolOptional

Whether counting is only performed when an origin is reached.

ScorePerPeriod int64Optional

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

ScoreResponseHeaderName stringOptional

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

minLength1

type PhaseGetResponseObjectRulesLogRule struct{…}

ID string

Action string

Enabled bool

Expression string

Ref string

type PhaseGetResponseObjectRulesLogCustomFieldRule struct{…}

ID string

Action string

Enabled bool

Expression string

Ref string

type PhaseGetResponseObjectRulesManagedChallengeRule struct{…}

ID string

Action string

Enabled bool

Expression string

Ref string

type PhaseGetResponseObjectRulesRedirectRule struct{…}

ID string

Action string

Enabled bool

Expression string

Ref string

type PhaseGetResponseObjectRulesRewriteRule struct{…}

ID string

Action string

Enabled bool

Expression string

Ref string

type PhaseGetResponseObjectRulesRouteRule struct{…}

ID string

Action string

Enabled bool

Expression string

Ref string

type PhaseGetResponseObjectRulesScoreRule struct{…}

ID string

Action string

Enabled bool

Expression string

Ref string

type PhaseGetResponseObjectRulesServeErrorRule struct{…}

ID string

Action string

Enabled bool

Expression string

Ref string

type PhaseGetResponseObjectRulesSetCacheControlRule struct{…}

ID string

The unique ID of the rule.

Action PhaseGetResponseObjectRulesSetCacheControlRuleAction

The action to perform when the rule matches.

Enabled bool

Expression string

The expression defining which traffic will match the rule.

minLength1

LastUpdated Time

The timestamp of when the rule was last modified.

formatdate-time

Ref string

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

minLength1

Version string

The version of the rule.

ActionParameters PhaseGetResponseObjectRulesSetCacheControlRuleActionParametersOptional

The parameters configuring the rule’s action.

Immutable PhaseGetResponseObjectRulesSetCacheControlRuleActionParametersImmutableOptional

A cache-control directive configuration.

One of the following:

type PhaseGetResponseObjectRulesSetCacheControlRuleActionParametersImmutableSetDirective struct{…}

Set the directive.

Operation PhaseGetResponseObjectRulesSetCacheControlRuleActionParametersImmutableSetDirectiveOperation

The operation to perform on the cache-control directive.

One of the following:

const PhaseGetResponseObjectRulesSetCacheControlRuleActionParametersImmutableSetDirectiveOperationSet PhaseGetResponseObjectRulesSetCacheControlRuleActionParametersImmutableSetDirectiveOperation = "set"

const PhaseGetResponseObjectRulesSetCacheControlRuleActionParametersImmutableSetDirectiveOperationRemove PhaseGetResponseObjectRulesSetCacheControlRuleActionParametersImmutableSetDirectiveOperation = "remove"

CloudflareOnly boolOptional

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

type PhaseGetResponseObjectRulesSetCacheControlRuleActionParametersImmutableRemoveDirective struct{…}

Remove the directive.

Operation PhaseGetResponseObjectRulesSetCacheControlRuleActionParametersImmutableRemoveDirectiveOperation

The operation to perform on the cache-control directive.

One of the following:

const PhaseGetResponseObjectRulesSetCacheControlRuleActionParametersImmutableRemoveDirectiveOperationSet PhaseGetResponseObjectRulesSetCacheControlRuleActionParametersImmutableRemoveDirectiveOperation = "set"

const PhaseGetResponseObjectRulesSetCacheControlRuleActionParametersImmutableRemoveDirectiveOperationRemove PhaseGetResponseObjectRulesSetCacheControlRuleActionParametersImmutableRemoveDirectiveOperation = "remove"

CloudflareOnly boolOptional

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

MaxAge PhaseGetResponseObjectRulesSetCacheControlRuleActionParametersMaxAgeOptional

A cache-control directive configuration that accepts a duration value in seconds.

One of the following:

type PhaseGetResponseObjectRulesSetCacheControlRuleActionParametersMaxAgeSetDirective struct{…}

Set the directive with a duration value in seconds.

Operation PhaseGetResponseObjectRulesSetCacheControlRuleActionParametersMaxAgeSetDirectiveOperation

The operation to perform on the cache-control directive.

One of the following:

const PhaseGetResponseObjectRulesSetCacheControlRuleActionParametersMaxAgeSetDirectiveOperationSet PhaseGetResponseObjectRulesSetCacheControlRuleActionParametersMaxAgeSetDirectiveOperation = "set"

const PhaseGetResponseObjectRulesSetCacheControlRuleActionParametersMaxAgeSetDirectiveOperationRemove PhaseGetResponseObjectRulesSetCacheControlRuleActionParametersMaxAgeSetDirectiveOperation = "remove"

Value int64

The duration value in seconds for the directive.

minimum0

CloudflareOnly boolOptional

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

type PhaseGetResponseObjectRulesSetCacheControlRuleActionParametersMaxAgeRemoveDirective struct{…}

Remove the directive.

Operation PhaseGetResponseObjectRulesSetCacheControlRuleActionParametersMaxAgeRemoveDirectiveOperation

The operation to perform on the cache-control directive.

One of the following:

const PhaseGetResponseObjectRulesSetCacheControlRuleActionParametersMaxAgeRemoveDirectiveOperationSet PhaseGetResponseObjectRulesSetCacheControlRuleActionParametersMaxAgeRemoveDirectiveOperation = "set"

const PhaseGetResponseObjectRulesSetCacheControlRuleActionParametersMaxAgeRemoveDirectiveOperationRemove PhaseGetResponseObjectRulesSetCacheControlRuleActionParametersMaxAgeRemoveDirectiveOperation = "remove"

CloudflareOnly boolOptional

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

MustRevalidate PhaseGetResponseObjectRulesSetCacheControlRuleActionParametersMustRevalidateOptional

A cache-control directive configuration.

One of the following:

type PhaseGetResponseObjectRulesSetCacheControlRuleActionParametersMustRevalidateSetDirective struct{…}

Set the directive.

Operation PhaseGetResponseObjectRulesSetCacheControlRuleActionParametersMustRevalidateSetDirectiveOperation

The operation to perform on the cache-control directive.

One of the following:

const PhaseGetResponseObjectRulesSetCacheControlRuleActionParametersMustRevalidateSetDirectiveOperationSet PhaseGetResponseObjectRulesSetCacheControlRuleActionParametersMustRevalidateSetDirectiveOperation = "set"

const PhaseGetResponseObjectRulesSetCacheControlRuleActionParametersMustRevalidateSetDirectiveOperationRemove PhaseGetResponseObjectRulesSetCacheControlRuleActionParametersMustRevalidateSetDirectiveOperation = "remove"

CloudflareOnly boolOptional

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

type PhaseGetResponseObjectRulesSetCacheControlRuleActionParametersMustRevalidateRemoveDirective struct{…}

Remove the directive.

Operation PhaseGetResponseObjectRulesSetCacheControlRuleActionParametersMustRevalidateRemoveDirectiveOperation

The operation to perform on the cache-control directive.

One of the following:

const PhaseGetResponseObjectRulesSetCacheControlRuleActionParametersMustRevalidateRemoveDirectiveOperationSet PhaseGetResponseObjectRulesSetCacheControlRuleActionParametersMustRevalidateRemoveDirectiveOperation = "set"

const PhaseGetResponseObjectRulesSetCacheControlRuleActionParametersMustRevalidateRemoveDirectiveOperationRemove PhaseGetResponseObjectRulesSetCacheControlRuleActionParametersMustRevalidateRemoveDirectiveOperation = "remove"

CloudflareOnly boolOptional

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

MustUnderstand PhaseGetResponseObjectRulesSetCacheControlRuleActionParametersMustUnderstandOptional

A cache-control directive configuration.

One of the following:

type PhaseGetResponseObjectRulesSetCacheControlRuleActionParametersMustUnderstandSetDirective struct{…}

Set the directive.

Operation PhaseGetResponseObjectRulesSetCacheControlRuleActionParametersMustUnderstandSetDirectiveOperation

The operation to perform on the cache-control directive.

One of the following:

const PhaseGetResponseObjectRulesSetCacheControlRuleActionParametersMustUnderstandSetDirectiveOperationSet PhaseGetResponseObjectRulesSetCacheControlRuleActionParametersMustUnderstandSetDirectiveOperation = "set"

const PhaseGetResponseObjectRulesSetCacheControlRuleActionParametersMustUnderstandSetDirectiveOperationRemove PhaseGetResponseObjectRulesSetCacheControlRuleActionParametersMustUnderstandSetDirectiveOperation = "remove"

CloudflareOnly boolOptional

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

type PhaseGetResponseObjectRulesSetCacheControlRuleActionParametersMustUnderstandRemoveDirective struct{…}

Remove the directive.

Operation PhaseGetResponseObjectRulesSetCacheControlRuleActionParametersMustUnderstandRemoveDirectiveOperation

The operation to perform on the cache-control directive.

One of the following:

const PhaseGetResponseObjectRulesSetCacheControlRuleActionParametersMustUnderstandRemoveDirectiveOperationSet PhaseGetResponseObjectRulesSetCacheControlRuleActionParametersMustUnderstandRemoveDirectiveOperation = "set"

const PhaseGetResponseObjectRulesSetCacheControlRuleActionParametersMustUnderstandRemoveDirectiveOperationRemove PhaseGetResponseObjectRulesSetCacheControlRuleActionParametersMustUnderstandRemoveDirectiveOperation = "remove"

CloudflareOnly boolOptional

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

NoCache PhaseGetResponseObjectRulesSetCacheControlRuleActionParametersNoCacheOptional

A cache-control directive configuration that accepts optional qualifiers (header names).

One of the following:

type PhaseGetResponseObjectRulesSetCacheControlRuleActionParametersNoCacheSetDirective struct{…}

Set the directive with optional qualifiers.

Operation PhaseGetResponseObjectRulesSetCacheControlRuleActionParametersNoCacheSetDirectiveOperation

The operation to perform on the cache-control directive.

One of the following:

const PhaseGetResponseObjectRulesSetCacheControlRuleActionParametersNoCacheSetDirectiveOperationSet PhaseGetResponseObjectRulesSetCacheControlRuleActionParametersNoCacheSetDirectiveOperation = "set"

const PhaseGetResponseObjectRulesSetCacheControlRuleActionParametersNoCacheSetDirectiveOperationRemove PhaseGetResponseObjectRulesSetCacheControlRuleActionParametersNoCacheSetDirectiveOperation = "remove"

CloudflareOnly boolOptional

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

Qualifiers []stringOptional

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

type PhaseGetResponseObjectRulesSetCacheControlRuleActionParametersNoCacheRemoveDirective struct{…}

Remove the directive.

Operation PhaseGetResponseObjectRulesSetCacheControlRuleActionParametersNoCacheRemoveDirectiveOperation

The operation to perform on the cache-control directive.

One of the following:

const PhaseGetResponseObjectRulesSetCacheControlRuleActionParametersNoCacheRemoveDirectiveOperationSet PhaseGetResponseObjectRulesSetCacheControlRuleActionParametersNoCacheRemoveDirectiveOperation = "set"

const PhaseGetResponseObjectRulesSetCacheControlRuleActionParametersNoCacheRemoveDirectiveOperationRemove PhaseGetResponseObjectRulesSetCacheControlRuleActionParametersNoCacheRemoveDirectiveOperation = "remove"

CloudflareOnly boolOptional

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

NoStore PhaseGetResponseObjectRulesSetCacheControlRuleActionParametersNoStoreOptional

A cache-control directive configuration.

One of the following:

type PhaseGetResponseObjectRulesSetCacheControlRuleActionParametersNoStoreSetDirective struct{…}

Set the directive.

Operation PhaseGetResponseObjectRulesSetCacheControlRuleActionParametersNoStoreSetDirectiveOperation

The operation to perform on the cache-control directive.

One of the following:

const PhaseGetResponseObjectRulesSetCacheControlRuleActionParametersNoStoreSetDirectiveOperationSet PhaseGetResponseObjectRulesSetCacheControlRuleActionParametersNoStoreSetDirectiveOperation = "set"

const PhaseGetResponseObjectRulesSetCacheControlRuleActionParametersNoStoreSetDirectiveOperationRemove PhaseGetResponseObjectRulesSetCacheControlRuleActionParametersNoStoreSetDirectiveOperation = "remove"

CloudflareOnly boolOptional

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

type PhaseGetResponseObjectRulesSetCacheControlRuleActionParametersNoStoreRemoveDirective struct{…}

Remove the directive.

Operation PhaseGetResponseObjectRulesSetCacheControlRuleActionParametersNoStoreRemoveDirectiveOperation

The operation to perform on the cache-control directive.

One of the following:

const PhaseGetResponseObjectRulesSetCacheControlRuleActionParametersNoStoreRemoveDirectiveOperationSet PhaseGetResponseObjectRulesSetCacheControlRuleActionParametersNoStoreRemoveDirectiveOperation = "set"

const PhaseGetResponseObjectRulesSetCacheControlRuleActionParametersNoStoreRemoveDirectiveOperationRemove PhaseGetResponseObjectRulesSetCacheControlRuleActionParametersNoStoreRemoveDirectiveOperation = "remove"

CloudflareOnly boolOptional

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

NoTransform PhaseGetResponseObjectRulesSetCacheControlRuleActionParametersNoTransformOptional

A cache-control directive configuration.

One of the following:

type PhaseGetResponseObjectRulesSetCacheControlRuleActionParametersNoTransformSetDirective struct{…}

Set the directive.

Operation PhaseGetResponseObjectRulesSetCacheControlRuleActionParametersNoTransformSetDirectiveOperation

The operation to perform on the cache-control directive.

One of the following:

const PhaseGetResponseObjectRulesSetCacheControlRuleActionParametersNoTransformSetDirectiveOperationSet PhaseGetResponseObjectRulesSetCacheControlRuleActionParametersNoTransformSetDirectiveOperation = "set"

const PhaseGetResponseObjectRulesSetCacheControlRuleActionParametersNoTransformSetDirectiveOperationRemove PhaseGetResponseObjectRulesSetCacheControlRuleActionParametersNoTransformSetDirectiveOperation = "remove"

CloudflareOnly boolOptional

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

type PhaseGetResponseObjectRulesSetCacheControlRuleActionParametersNoTransformRemoveDirective struct{…}

Remove the directive.

Operation PhaseGetResponseObjectRulesSetCacheControlRuleActionParametersNoTransformRemoveDirectiveOperation

The operation to perform on the cache-control directive.

One of the following:

const PhaseGetResponseObjectRulesSetCacheControlRuleActionParametersNoTransformRemoveDirectiveOperationSet PhaseGetResponseObjectRulesSetCacheControlRuleActionParametersNoTransformRemoveDirectiveOperation = "set"

const PhaseGetResponseObjectRulesSetCacheControlRuleActionParametersNoTransformRemoveDirectiveOperationRemove PhaseGetResponseObjectRulesSetCacheControlRuleActionParametersNoTransformRemoveDirectiveOperation = "remove"

CloudflareOnly boolOptional

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

Private PhaseGetResponseObjectRulesSetCacheControlRuleActionParametersPrivateOptional

A cache-control directive configuration that accepts optional qualifiers (header names).

One of the following:

type PhaseGetResponseObjectRulesSetCacheControlRuleActionParametersPrivateSetDirective struct{…}

Set the directive with optional qualifiers.

Operation PhaseGetResponseObjectRulesSetCacheControlRuleActionParametersPrivateSetDirectiveOperation

The operation to perform on the cache-control directive.

One of the following:

const PhaseGetResponseObjectRulesSetCacheControlRuleActionParametersPrivateSetDirectiveOperationSet PhaseGetResponseObjectRulesSetCacheControlRuleActionParametersPrivateSetDirectiveOperation = "set"

const PhaseGetResponseObjectRulesSetCacheControlRuleActionParametersPrivateSetDirectiveOperationRemove PhaseGetResponseObjectRulesSetCacheControlRuleActionParametersPrivateSetDirectiveOperation = "remove"

CloudflareOnly boolOptional

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

Qualifiers []stringOptional

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

type PhaseGetResponseObjectRulesSetCacheControlRuleActionParametersPrivateRemoveDirective struct{…}

Remove the directive.

Operation PhaseGetResponseObjectRulesSetCacheControlRuleActionParametersPrivateRemoveDirectiveOperation

The operation to perform on the cache-control directive.

One of the following:

const PhaseGetResponseObjectRulesSetCacheControlRuleActionParametersPrivateRemoveDirectiveOperationSet PhaseGetResponseObjectRulesSetCacheControlRuleActionParametersPrivateRemoveDirectiveOperation = "set"

const PhaseGetResponseObjectRulesSetCacheControlRuleActionParametersPrivateRemoveDirectiveOperationRemove PhaseGetResponseObjectRulesSetCacheControlRuleActionParametersPrivateRemoveDirectiveOperation = "remove"

CloudflareOnly boolOptional

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

ProxyRevalidate PhaseGetResponseObjectRulesSetCacheControlRuleActionParametersProxyRevalidateOptional

A cache-control directive configuration.

One of the following:

type PhaseGetResponseObjectRulesSetCacheControlRuleActionParametersProxyRevalidateSetDirective struct{…}

Set the directive.

Operation PhaseGetResponseObjectRulesSetCacheControlRuleActionParametersProxyRevalidateSetDirectiveOperation

The operation to perform on the cache-control directive.

One of the following:

const PhaseGetResponseObjectRulesSetCacheControlRuleActionParametersProxyRevalidateSetDirectiveOperationSet PhaseGetResponseObjectRulesSetCacheControlRuleActionParametersProxyRevalidateSetDirectiveOperation = "set"

const PhaseGetResponseObjectRulesSetCacheControlRuleActionParametersProxyRevalidateSetDirectiveOperationRemove PhaseGetResponseObjectRulesSetCacheControlRuleActionParametersProxyRevalidateSetDirectiveOperation = "remove"

CloudflareOnly boolOptional

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

type PhaseGetResponseObjectRulesSetCacheControlRuleActionParametersProxyRevalidateRemoveDirective struct{…}

Remove the directive.

Operation PhaseGetResponseObjectRulesSetCacheControlRuleActionParametersProxyRevalidateRemoveDirectiveOperation

The operation to perform on the cache-control directive.

One of the following:

const PhaseGetResponseObjectRulesSetCacheControlRuleActionParametersProxyRevalidateRemoveDirectiveOperationSet PhaseGetResponseObjectRulesSetCacheControlRuleActionParametersProxyRevalidateRemoveDirectiveOperation = "set"

const PhaseGetResponseObjectRulesSetCacheControlRuleActionParametersProxyRevalidateRemoveDirectiveOperationRemove PhaseGetResponseObjectRulesSetCacheControlRuleActionParametersProxyRevalidateRemoveDirectiveOperation = "remove"

CloudflareOnly boolOptional

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

Public PhaseGetResponseObjectRulesSetCacheControlRuleActionParametersPublicOptional

A cache-control directive configuration.

One of the following:

type PhaseGetResponseObjectRulesSetCacheControlRuleActionParametersPublicSetDirective struct{…}

Set the directive.

Operation PhaseGetResponseObjectRulesSetCacheControlRuleActionParametersPublicSetDirectiveOperation

The operation to perform on the cache-control directive.

One of the following:

const PhaseGetResponseObjectRulesSetCacheControlRuleActionParametersPublicSetDirectiveOperationSet PhaseGetResponseObjectRulesSetCacheControlRuleActionParametersPublicSetDirectiveOperation = "set"

const PhaseGetResponseObjectRulesSetCacheControlRuleActionParametersPublicSetDirectiveOperationRemove PhaseGetResponseObjectRulesSetCacheControlRuleActionParametersPublicSetDirectiveOperation = "remove"

CloudflareOnly boolOptional

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

type PhaseGetResponseObjectRulesSetCacheControlRuleActionParametersPublicRemoveDirective struct{…}

Remove the directive.

Operation PhaseGetResponseObjectRulesSetCacheControlRuleActionParametersPublicRemoveDirectiveOperation

The operation to perform on the cache-control directive.

One of the following:

const PhaseGetResponseObjectRulesSetCacheControlRuleActionParametersPublicRemoveDirectiveOperationSet PhaseGetResponseObjectRulesSetCacheControlRuleActionParametersPublicRemoveDirectiveOperation = "set"

const PhaseGetResponseObjectRulesSetCacheControlRuleActionParametersPublicRemoveDirectiveOperationRemove PhaseGetResponseObjectRulesSetCacheControlRuleActionParametersPublicRemoveDirectiveOperation = "remove"

CloudflareOnly boolOptional

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

SMaxage PhaseGetResponseObjectRulesSetCacheControlRuleActionParametersSMaxageOptional

A cache-control directive configuration that accepts a duration value in seconds.

One of the following:

type PhaseGetResponseObjectRulesSetCacheControlRuleActionParametersSMaxageSetDirective struct{…}

Set the directive with a duration value in seconds.

Operation PhaseGetResponseObjectRulesSetCacheControlRuleActionParametersSMaxageSetDirectiveOperation

The operation to perform on the cache-control directive.

One of the following:

const PhaseGetResponseObjectRulesSetCacheControlRuleActionParametersSMaxageSetDirectiveOperationSet PhaseGetResponseObjectRulesSetCacheControlRuleActionParametersSMaxageSetDirectiveOperation = "set"

const PhaseGetResponseObjectRulesSetCacheControlRuleActionParametersSMaxageSetDirectiveOperationRemove PhaseGetResponseObjectRulesSetCacheControlRuleActionParametersSMaxageSetDirectiveOperation = "remove"

Value int64

The duration value in seconds for the directive.

minimum0

CloudflareOnly boolOptional

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

type PhaseGetResponseObjectRulesSetCacheControlRuleActionParametersSMaxageRemoveDirective struct{…}

Remove the directive.

Operation PhaseGetResponseObjectRulesSetCacheControlRuleActionParametersSMaxageRemoveDirectiveOperation

The operation to perform on the cache-control directive.

One of the following:

const PhaseGetResponseObjectRulesSetCacheControlRuleActionParametersSMaxageRemoveDirectiveOperationSet PhaseGetResponseObjectRulesSetCacheControlRuleActionParametersSMaxageRemoveDirectiveOperation = "set"

const PhaseGetResponseObjectRulesSetCacheControlRuleActionParametersSMaxageRemoveDirectiveOperationRemove PhaseGetResponseObjectRulesSetCacheControlRuleActionParametersSMaxageRemoveDirectiveOperation = "remove"

CloudflareOnly boolOptional

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

StaleIfError PhaseGetResponseObjectRulesSetCacheControlRuleActionParametersStaleIfErrorOptional

A cache-control directive configuration that accepts a duration value in seconds.

One of the following:

type PhaseGetResponseObjectRulesSetCacheControlRuleActionParametersStaleIfErrorSetDirective struct{…}

Set the directive with a duration value in seconds.

Operation PhaseGetResponseObjectRulesSetCacheControlRuleActionParametersStaleIfErrorSetDirectiveOperation

The operation to perform on the cache-control directive.

One of the following:

const PhaseGetResponseObjectRulesSetCacheControlRuleActionParametersStaleIfErrorSetDirectiveOperationSet PhaseGetResponseObjectRulesSetCacheControlRuleActionParametersStaleIfErrorSetDirectiveOperation = "set"

const PhaseGetResponseObjectRulesSetCacheControlRuleActionParametersStaleIfErrorSetDirectiveOperationRemove PhaseGetResponseObjectRulesSetCacheControlRuleActionParametersStaleIfErrorSetDirectiveOperation = "remove"

Value int64

The duration value in seconds for the directive.

minimum0

CloudflareOnly boolOptional

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

type PhaseGetResponseObjectRulesSetCacheControlRuleActionParametersStaleIfErrorRemoveDirective struct{…}

Remove the directive.

Operation PhaseGetResponseObjectRulesSetCacheControlRuleActionParametersStaleIfErrorRemoveDirectiveOperation

The operation to perform on the cache-control directive.

One of the following:

const PhaseGetResponseObjectRulesSetCacheControlRuleActionParametersStaleIfErrorRemoveDirectiveOperationSet PhaseGetResponseObjectRulesSetCacheControlRuleActionParametersStaleIfErrorRemoveDirectiveOperation = "set"

const PhaseGetResponseObjectRulesSetCacheControlRuleActionParametersStaleIfErrorRemoveDirectiveOperationRemove PhaseGetResponseObjectRulesSetCacheControlRuleActionParametersStaleIfErrorRemoveDirectiveOperation = "remove"

CloudflareOnly boolOptional

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

StaleWhileRevalidate PhaseGetResponseObjectRulesSetCacheControlRuleActionParametersStaleWhileRevalidateOptional

A cache-control directive configuration that accepts a duration value in seconds.

One of the following:

type PhaseGetResponseObjectRulesSetCacheControlRuleActionParametersStaleWhileRevalidateSetDirective struct{…}

Set the directive with a duration value in seconds.

Operation PhaseGetResponseObjectRulesSetCacheControlRuleActionParametersStaleWhileRevalidateSetDirectiveOperation

The operation to perform on the cache-control directive.

One of the following:

const PhaseGetResponseObjectRulesSetCacheControlRuleActionParametersStaleWhileRevalidateSetDirectiveOperationSet PhaseGetResponseObjectRulesSetCacheControlRuleActionParametersStaleWhileRevalidateSetDirectiveOperation = "set"

const PhaseGetResponseObjectRulesSetCacheControlRuleActionParametersStaleWhileRevalidateSetDirectiveOperationRemove PhaseGetResponseObjectRulesSetCacheControlRuleActionParametersStaleWhileRevalidateSetDirectiveOperation = "remove"

Value int64

The duration value in seconds for the directive.

minimum0

CloudflareOnly boolOptional

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

type PhaseGetResponseObjectRulesSetCacheControlRuleActionParametersStaleWhileRevalidateRemoveDirective struct{…}

Remove the directive.

Operation PhaseGetResponseObjectRulesSetCacheControlRuleActionParametersStaleWhileRevalidateRemoveDirectiveOperation

The operation to perform on the cache-control directive.

One of the following:

const PhaseGetResponseObjectRulesSetCacheControlRuleActionParametersStaleWhileRevalidateRemoveDirectiveOperationSet PhaseGetResponseObjectRulesSetCacheControlRuleActionParametersStaleWhileRevalidateRemoveDirectiveOperation = "set"

const PhaseGetResponseObjectRulesSetCacheControlRuleActionParametersStaleWhileRevalidateRemoveDirectiveOperationRemove PhaseGetResponseObjectRulesSetCacheControlRuleActionParametersStaleWhileRevalidateRemoveDirectiveOperation = "remove"

CloudflareOnly boolOptional

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

Categories []stringOptional

The categories of the rule.

Description stringOptional

An informative description of the rule.

ExposedCredentialCheck PhaseGetResponseObjectRulesSetCacheControlRuleExposedCredentialCheckOptional

Configuration for exposed credential checking.

PasswordExpression string

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

minLength1

UsernameExpression string

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

minLength1

Logging LoggingOptional

An object configuring the rule’s logging behavior.

Enabled bool

Whether to generate a log when the rule matches.

Ratelimit PhaseGetResponseObjectRulesSetCacheControlRuleRatelimitOptional

An object configuring the rule’s rate limit behavior.

Characteristics []string

Characteristics of the request on which the rate limit counter will be incremented.

Period int64

Period in seconds over which the counter is being incremented.

minimum0

CountingExpression stringOptional

An expression that defines when the rate limit counter should be incremented. It defaults to the same as the rule’s expression.

minLength1

MitigationTimeout int64Optional

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

RequestsPerPeriod int64Optional

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

minimum1

RequestsToOrigin boolOptional

Whether counting is only performed when an origin is reached.

ScorePerPeriod int64Optional

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

ScoreResponseHeaderName stringOptional

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

minLength1

type PhaseGetResponseObjectRulesSetCacheSettingsRule struct{…}

ID string

Action string

Enabled bool

Expression string

Ref string

type PhaseGetResponseObjectRulesSetCacheTagsRule struct{…}

ID string

The unique ID of the rule.

Action PhaseGetResponseObjectRulesSetCacheTagsRuleAction

The action to perform when the rule matches.

Enabled bool

Expression string

The expression defining which traffic will match the rule.

minLength1

LastUpdated Time

The timestamp of when the rule was last modified.

formatdate-time

Ref string

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

minLength1

Version string

The version of the rule.

ActionParameters PhaseGetResponseObjectRulesSetCacheTagsRuleActionParametersOptional

The parameters configuring the rule’s action.

One of the following:

type PhaseGetResponseObjectRulesSetCacheTagsRuleActionParametersAddCacheTagsValues struct{…}

Add cache tags using a list of values.

Operation PhaseGetResponseObjectRulesSetCacheTagsRuleActionParametersAddCacheTagsValuesOperation

The operation to perform on the cache tags.

One of the following:

const PhaseGetResponseObjectRulesSetCacheTagsRuleActionParametersAddCacheTagsValuesOperationAdd PhaseGetResponseObjectRulesSetCacheTagsRuleActionParametersAddCacheTagsValuesOperation = "add"

const PhaseGetResponseObjectRulesSetCacheTagsRuleActionParametersAddCacheTagsValuesOperationRemove PhaseGetResponseObjectRulesSetCacheTagsRuleActionParametersAddCacheTagsValuesOperation = "remove"

const PhaseGetResponseObjectRulesSetCacheTagsRuleActionParametersAddCacheTagsValuesOperationSet PhaseGetResponseObjectRulesSetCacheTagsRuleActionParametersAddCacheTagsValuesOperation = "set"

Values []string

A list of cache tag values.

type PhaseGetResponseObjectRulesSetCacheTagsRuleActionParametersAddCacheTagsExpression struct{…}

Add cache tags using an expression.

Expression string

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

minLength1

Operation PhaseGetResponseObjectRulesSetCacheTagsRuleActionParametersAddCacheTagsExpressionOperation

The operation to perform on the cache tags.

One of the following:

const PhaseGetResponseObjectRulesSetCacheTagsRuleActionParametersAddCacheTagsExpressionOperationAdd PhaseGetResponseObjectRulesSetCacheTagsRuleActionParametersAddCacheTagsExpressionOperation = "add"

const PhaseGetResponseObjectRulesSetCacheTagsRuleActionParametersAddCacheTagsExpressionOperationRemove PhaseGetResponseObjectRulesSetCacheTagsRuleActionParametersAddCacheTagsExpressionOperation = "remove"

const PhaseGetResponseObjectRulesSetCacheTagsRuleActionParametersAddCacheTagsExpressionOperationSet PhaseGetResponseObjectRulesSetCacheTagsRuleActionParametersAddCacheTagsExpressionOperation = "set"

type PhaseGetResponseObjectRulesSetCacheTagsRuleActionParametersRemoveCacheTagsValues struct{…}

Remove cache tags using a list of values.

Operation PhaseGetResponseObjectRulesSetCacheTagsRuleActionParametersRemoveCacheTagsValuesOperation

The operation to perform on the cache tags.

One of the following:

const PhaseGetResponseObjectRulesSetCacheTagsRuleActionParametersRemoveCacheTagsValuesOperationAdd PhaseGetResponseObjectRulesSetCacheTagsRuleActionParametersRemoveCacheTagsValuesOperation = "add"

const PhaseGetResponseObjectRulesSetCacheTagsRuleActionParametersRemoveCacheTagsValuesOperationRemove PhaseGetResponseObjectRulesSetCacheTagsRuleActionParametersRemoveCacheTagsValuesOperation = "remove"

const PhaseGetResponseObjectRulesSetCacheTagsRuleActionParametersRemoveCacheTagsValuesOperationSet PhaseGetResponseObjectRulesSetCacheTagsRuleActionParametersRemoveCacheTagsValuesOperation = "set"

Values []string

A list of cache tag values.

type PhaseGetResponseObjectRulesSetCacheTagsRuleActionParametersRemoveCacheTagsExpression struct{…}

Remove cache tags using an expression.

Expression string

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

minLength1

Operation PhaseGetResponseObjectRulesSetCacheTagsRuleActionParametersRemoveCacheTagsExpressionOperation

The operation to perform on the cache tags.

One of the following:

const PhaseGetResponseObjectRulesSetCacheTagsRuleActionParametersRemoveCacheTagsExpressionOperationAdd PhaseGetResponseObjectRulesSetCacheTagsRuleActionParametersRemoveCacheTagsExpressionOperation = "add"

const PhaseGetResponseObjectRulesSetCacheTagsRuleActionParametersRemoveCacheTagsExpressionOperationRemove PhaseGetResponseObjectRulesSetCacheTagsRuleActionParametersRemoveCacheTagsExpressionOperation = "remove"

const PhaseGetResponseObjectRulesSetCacheTagsRuleActionParametersRemoveCacheTagsExpressionOperationSet PhaseGetResponseObjectRulesSetCacheTagsRuleActionParametersRemoveCacheTagsExpressionOperation = "set"

type PhaseGetResponseObjectRulesSetCacheTagsRuleActionParametersSetCacheTagsValues struct{…}

Set cache tags using a list of values.

Operation PhaseGetResponseObjectRulesSetCacheTagsRuleActionParametersSetCacheTagsValuesOperation

The operation to perform on the cache tags.

One of the following:

const PhaseGetResponseObjectRulesSetCacheTagsRuleActionParametersSetCacheTagsValuesOperationAdd PhaseGetResponseObjectRulesSetCacheTagsRuleActionParametersSetCacheTagsValuesOperation = "add"

const PhaseGetResponseObjectRulesSetCacheTagsRuleActionParametersSetCacheTagsValuesOperationRemove PhaseGetResponseObjectRulesSetCacheTagsRuleActionParametersSetCacheTagsValuesOperation = "remove"

const PhaseGetResponseObjectRulesSetCacheTagsRuleActionParametersSetCacheTagsValuesOperationSet PhaseGetResponseObjectRulesSetCacheTagsRuleActionParametersSetCacheTagsValuesOperation = "set"

Values []string

A list of cache tag values.

type PhaseGetResponseObjectRulesSetCacheTagsRuleActionParametersSetCacheTagsExpression struct{…}

Set cache tags using an expression.

Expression string

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

minLength1

Operation PhaseGetResponseObjectRulesSetCacheTagsRuleActionParametersSetCacheTagsExpressionOperation

The operation to perform on the cache tags.

One of the following:

const PhaseGetResponseObjectRulesSetCacheTagsRuleActionParametersSetCacheTagsExpressionOperationAdd PhaseGetResponseObjectRulesSetCacheTagsRuleActionParametersSetCacheTagsExpressionOperation = "add"

const PhaseGetResponseObjectRulesSetCacheTagsRuleActionParametersSetCacheTagsExpressionOperationRemove PhaseGetResponseObjectRulesSetCacheTagsRuleActionParametersSetCacheTagsExpressionOperation = "remove"

const PhaseGetResponseObjectRulesSetCacheTagsRuleActionParametersSetCacheTagsExpressionOperationSet PhaseGetResponseObjectRulesSetCacheTagsRuleActionParametersSetCacheTagsExpressionOperation = "set"

Categories []stringOptional

The categories of the rule.

Description stringOptional

An informative description of the rule.

ExposedCredentialCheck PhaseGetResponseObjectRulesSetCacheTagsRuleExposedCredentialCheckOptional

Configuration for exposed credential checking.

PasswordExpression string

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

minLength1

UsernameExpression string

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

minLength1

Logging LoggingOptional

An object configuring the rule’s logging behavior.

Enabled bool

Whether to generate a log when the rule matches.

Ratelimit PhaseGetResponseObjectRulesSetCacheTagsRuleRatelimitOptional

An object configuring the rule’s rate limit behavior.

Characteristics []string

Characteristics of the request on which the rate limit counter will be incremented.

Period int64

Period in seconds over which the counter is being incremented.

minimum0

CountingExpression stringOptional

An expression that defines when the rate limit counter should be incremented. It defaults to the same as the rule’s expression.

minLength1

MitigationTimeout int64Optional

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

RequestsPerPeriod int64Optional

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

minimum1

RequestsToOrigin boolOptional

Whether counting is only performed when an origin is reached.

ScorePerPeriod int64Optional

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

ScoreResponseHeaderName stringOptional

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

minLength1

type PhaseGetResponseObjectRulesSetConfigurationRule struct{…}

ID string

Action string

Enabled bool

Expression string

Ref string

type PhaseGetResponseObjectRulesSkipRule struct{…}

ID string

Action string

Enabled bool

Expression string

Ref string

type PhaseGetResponseObjectRulesTransformResponseHTMLRule struct{…}

ID string

The unique ID of the rule.

Action PhaseGetResponseObjectRulesTransformResponseHTMLRuleAction

The action to perform when the rule matches.

Enabled bool

Expression string

The expression defining which traffic will match the rule.

minLength1

LastUpdated Time

The timestamp of when the rule was last modified.

formatdate-time

Ref string

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

minLength1

Version string

The version of the rule.

ActionParameters PhaseGetResponseObjectRulesTransformResponseHTMLRuleActionParametersOptional

The parameters configuring the rule’s action.

LinkMaze unknown

Enables the link maze transformation on the response.

Categories []stringOptional

The categories of the rule.

Description stringOptional

An informative description of the rule.

ExposedCredentialCheck PhaseGetResponseObjectRulesTransformResponseHTMLRuleExposedCredentialCheckOptional

Configuration for exposed credential checking.

PasswordExpression string

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

minLength1

UsernameExpression string

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

minLength1

Logging LoggingOptional

An object configuring the rule’s logging behavior.

Enabled bool

Whether to generate a log when the rule matches.

Ratelimit PhaseGetResponseObjectRulesTransformResponseHTMLRuleRatelimitOptional

An object configuring the rule’s rate limit behavior.

Characteristics []string

Characteristics of the request on which the rate limit counter will be incremented.

Period int64

Period in seconds over which the counter is being incremented.

minimum0

CountingExpression stringOptional

An expression that defines when the rate limit counter should be incremented. It defaults to the same as the rule’s expression.

minLength1

MitigationTimeout int64Optional

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

RequestsPerPeriod int64Optional

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

minimum1

RequestsToOrigin boolOptional

Whether counting is only performed when an origin is reached.

ScorePerPeriod int64Optional

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

ScoreResponseHeaderName stringOptional

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

minLength1

Version stringOptional

The version of the ruleset.

type PhaseGetResponseObject struct{…}

ID stringOptional

The unique ID of the ruleset.

Description stringOptional

An informative description of the ruleset.

Kind KindOptional

The kind of the ruleset.

One of the following:

const KindManaged Kind = "managed"

const KindCustom Kind = "custom"

const KindRoot Kind = "root"

const KindZone Kind = "zone"

LastUpdated TimeOptional

The timestamp of when the ruleset was last modified.

formatdate-time

Name stringOptional

The human-readable name of the ruleset.

minLength1

Phase PhaseOptional

The phase of the ruleset.

One of the following:

const PhaseDDoSL4 Phase = "ddos_l4"

const PhaseDDoSL7 Phase = "ddos_l7"

const PhaseHTTPConfigSettings Phase = "http_config_settings"

const PhaseHTTPCustomErrors Phase = "http_custom_errors"

const PhaseHTTPLogCustomFields Phase = "http_log_custom_fields"

const PhaseHTTPRatelimit Phase = "http_ratelimit"

const PhaseHTTPRequestCacheSettings Phase = "http_request_cache_settings"

const PhaseHTTPRequestDynamicRedirect Phase = "http_request_dynamic_redirect"

const PhaseHTTPRequestFirewallCustom Phase = "http_request_firewall_custom"

const PhaseHTTPRequestFirewallManaged Phase = "http_request_firewall_managed"

const PhaseHTTPRequestLateTransform Phase = "http_request_late_transform"

const PhaseHTTPRequestOrigin Phase = "http_request_origin"

const PhaseHTTPRequestRedirect Phase = "http_request_redirect"

const PhaseHTTPRequestSanitize Phase = "http_request_sanitize"

const PhaseHTTPRequestSBFM Phase = "http_request_sbfm"

const PhaseHTTPRequestTransform Phase = "http_request_transform"

const PhaseHTTPResponseCacheSettings Phase = "http_response_cache_settings"

const PhaseHTTPResponseCompression Phase = "http_response_compression"

const PhaseHTTPResponseFirewallCustom Phase = "http_response_firewall_custom"

const PhaseHTTPResponseFirewallManaged Phase = "http_response_firewall_managed"

const PhaseHTTPResponseHeadersTransform Phase = "http_response_headers_transform"

const PhaseMagicTransit Phase = "magic_transit"

const PhaseMagicTransitIDsManaged Phase = "magic_transit_ids_managed"

const PhaseMagicTransitManaged Phase = "magic_transit_managed"

const PhaseMagicTransitRatelimit Phase = "magic_transit_ratelimit"

Rules []PhaseGetResponseObjectRuleOptional

The list of rules in the ruleset.

One of the following:

type PhaseGetResponseObjectRulesBlockRule struct{…}

ID string

Action string

Enabled bool

Expression string

Ref string

type PhaseGetResponseObjectRulesChallengeRule struct{…}

ID string

The unique ID of the rule.

Action PhaseGetResponseObjectRulesChallengeRuleAction

The action to perform when the rule matches.

Enabled bool

Whether the rule should be executed.

Expression string

The expression defining which traffic will match the rule.

minLength1

LastUpdated Time

The timestamp of when the rule was last modified.

formatdate-time

Ref string

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

minLength1

Version string

The version of the rule.

ActionParameters unknownOptional

The parameters configuring the rule’s action.

Categories []stringOptional

The categories of the rule.

Description stringOptional

An informative description of the rule.

ExposedCredentialCheck PhaseGetResponseObjectRulesChallengeRuleExposedCredentialCheckOptional

Configuration for exposed credential checking.

PasswordExpression string

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

minLength1

UsernameExpression string

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

minLength1

Logging LoggingOptional

An object configuring the rule’s logging behavior.

Enabled bool

Whether to generate a log when the rule matches.

Ratelimit PhaseGetResponseObjectRulesChallengeRuleRatelimitOptional

An object configuring the rule’s rate limit behavior.

Characteristics []string

Characteristics of the request on which the rate limit counter will be incremented.

Period int64

Period in seconds over which the counter is being incremented.

minimum0

CountingExpression stringOptional

An expression that defines when the rate limit counter should be incremented. It defaults to the same as the rule’s expression.

minLength1

MitigationTimeout int64Optional

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

RequestsPerPeriod int64Optional

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

minimum1

RequestsToOrigin boolOptional

Whether counting is only performed when an origin is reached.

ScorePerPeriod int64Optional

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

ScoreResponseHeaderName stringOptional

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

minLength1

type PhaseGetResponseObjectRulesResponseCompressionRule struct{…}

ID string

Action string

Enabled bool

Expression string

Ref string

type PhaseGetResponseObjectRulesDDoSDynamicRule struct{…}

ID string

Action string

Enabled bool

Expression string

Ref string

type PhaseGetResponseObjectRulesExecuteRule struct{…}

ID string

Action string

Enabled bool

Expression string

Ref string

type PhaseGetResponseObjectRulesForceConnectionCloseRule struct{…}

ID string

Action string

Enabled bool

Expression string

Ref string

type PhaseGetResponseObjectRulesJavaScriptChallengeRule struct{…}

ID string

The unique ID of the rule.

Action PhaseGetResponseObjectRulesJavaScriptChallengeRuleAction

The action to perform when the rule matches.

Enabled bool

Whether the rule should be executed.

Expression string

The expression defining which traffic will match the rule.

minLength1

LastUpdated Time

The timestamp of when the rule was last modified.

formatdate-time

Ref string

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

minLength1

Version string

The version of the rule.

ActionParameters unknownOptional

The parameters configuring the rule’s action.

Categories []stringOptional

The categories of the rule.

Description stringOptional

An informative description of the rule.

ExposedCredentialCheck PhaseGetResponseObjectRulesJavaScriptChallengeRuleExposedCredentialCheckOptional

Configuration for exposed credential checking.

PasswordExpression string

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

minLength1

UsernameExpression string

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

minLength1

Logging LoggingOptional

An object configuring the rule’s logging behavior.

Enabled bool

Whether to generate a log when the rule matches.

Ratelimit PhaseGetResponseObjectRulesJavaScriptChallengeRuleRatelimitOptional

An object configuring the rule’s rate limit behavior.

Characteristics []string

Characteristics of the request on which the rate limit counter will be incremented.

Period int64

Period in seconds over which the counter is being incremented.

minimum0

CountingExpression stringOptional

An expression that defines when the rate limit counter should be incremented. It defaults to the same as the rule’s expression.

minLength1

MitigationTimeout int64Optional

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

RequestsPerPeriod int64Optional

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

minimum1

RequestsToOrigin boolOptional

Whether counting is only performed when an origin is reached.

ScorePerPeriod int64Optional

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

ScoreResponseHeaderName stringOptional

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

minLength1

type PhaseGetResponseObjectRulesLogRule struct{…}

ID string

Action string

Enabled bool

Expression string

Ref string

type PhaseGetResponseObjectRulesLogCustomFieldRule struct{…}

ID string

Action string

Enabled bool

Expression string

Ref string

type PhaseGetResponseObjectRulesManagedChallengeRule struct{…}

ID string

Action string

Enabled bool

Expression string

Ref string

type PhaseGetResponseObjectRulesRedirectRule struct{…}

ID string

Action string

Enabled bool

Expression string

Ref string

type PhaseGetResponseObjectRulesRewriteRule struct{…}

ID string

Action string

Enabled bool

Expression string

Ref string

type PhaseGetResponseObjectRulesRouteRule struct{…}

ID string

Action string

Enabled bool

Expression string

Ref string

type PhaseGetResponseObjectRulesScoreRule struct{…}

ID string

Action string

Enabled bool

Expression string

Ref string

type PhaseGetResponseObjectRulesServeErrorRule struct{…}

ID string

Action string

Enabled bool

Expression string

Ref string

type PhaseGetResponseObjectRulesSetCacheControlRule struct{…}

ID string

The unique ID of the rule.

Action PhaseGetResponseObjectRulesSetCacheControlRuleAction

The action to perform when the rule matches.

Enabled bool

Expression string

The expression defining which traffic will match the rule.

minLength1

LastUpdated Time

The timestamp of when the rule was last modified.

formatdate-time

Ref string

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

minLength1

Version string

The version of the rule.

ActionParameters PhaseGetResponseObjectRulesSetCacheControlRuleActionParametersOptional

The parameters configuring the rule’s action.

Immutable PhaseGetResponseObjectRulesSetCacheControlRuleActionParametersImmutableOptional

A cache-control directive configuration.

One of the following:

type PhaseGetResponseObjectRulesSetCacheControlRuleActionParametersImmutableSetDirective struct{…}

Set the directive.

Operation PhaseGetResponseObjectRulesSetCacheControlRuleActionParametersImmutableSetDirectiveOperation

The operation to perform on the cache-control directive.

One of the following:

const PhaseGetResponseObjectRulesSetCacheControlRuleActionParametersImmutableSetDirectiveOperationSet PhaseGetResponseObjectRulesSetCacheControlRuleActionParametersImmutableSetDirectiveOperation = "set"

const PhaseGetResponseObjectRulesSetCacheControlRuleActionParametersImmutableSetDirectiveOperationRemove PhaseGetResponseObjectRulesSetCacheControlRuleActionParametersImmutableSetDirectiveOperation = "remove"

CloudflareOnly boolOptional

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

type PhaseGetResponseObjectRulesSetCacheControlRuleActionParametersImmutableRemoveDirective struct{…}

Remove the directive.

Operation PhaseGetResponseObjectRulesSetCacheControlRuleActionParametersImmutableRemoveDirectiveOperation

The operation to perform on the cache-control directive.

One of the following:

const PhaseGetResponseObjectRulesSetCacheControlRuleActionParametersImmutableRemoveDirectiveOperationSet PhaseGetResponseObjectRulesSetCacheControlRuleActionParametersImmutableRemoveDirectiveOperation = "set"

const PhaseGetResponseObjectRulesSetCacheControlRuleActionParametersImmutableRemoveDirectiveOperationRemove PhaseGetResponseObjectRulesSetCacheControlRuleActionParametersImmutableRemoveDirectiveOperation = "remove"

CloudflareOnly boolOptional

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

MaxAge PhaseGetResponseObjectRulesSetCacheControlRuleActionParametersMaxAgeOptional

A cache-control directive configuration that accepts a duration value in seconds.

One of the following:

type PhaseGetResponseObjectRulesSetCacheControlRuleActionParametersMaxAgeSetDirective struct{…}

Set the directive with a duration value in seconds.

Operation PhaseGetResponseObjectRulesSetCacheControlRuleActionParametersMaxAgeSetDirectiveOperation

The operation to perform on the cache-control directive.

One of the following:

const PhaseGetResponseObjectRulesSetCacheControlRuleActionParametersMaxAgeSetDirectiveOperationSet PhaseGetResponseObjectRulesSetCacheControlRuleActionParametersMaxAgeSetDirectiveOperation = "set"

const PhaseGetResponseObjectRulesSetCacheControlRuleActionParametersMaxAgeSetDirectiveOperationRemove PhaseGetResponseObjectRulesSetCacheControlRuleActionParametersMaxAgeSetDirectiveOperation = "remove"

Value int64

The duration value in seconds for the directive.

minimum0

CloudflareOnly boolOptional

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

type PhaseGetResponseObjectRulesSetCacheControlRuleActionParametersMaxAgeRemoveDirective struct{…}

Remove the directive.

Operation PhaseGetResponseObjectRulesSetCacheControlRuleActionParametersMaxAgeRemoveDirectiveOperation

The operation to perform on the cache-control directive.

One of the following:

const PhaseGetResponseObjectRulesSetCacheControlRuleActionParametersMaxAgeRemoveDirectiveOperationSet PhaseGetResponseObjectRulesSetCacheControlRuleActionParametersMaxAgeRemoveDirectiveOperation = "set"

const PhaseGetResponseObjectRulesSetCacheControlRuleActionParametersMaxAgeRemoveDirectiveOperationRemove PhaseGetResponseObjectRulesSetCacheControlRuleActionParametersMaxAgeRemoveDirectiveOperation = "remove"

CloudflareOnly boolOptional

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

MustRevalidate PhaseGetResponseObjectRulesSetCacheControlRuleActionParametersMustRevalidateOptional

A cache-control directive configuration.

One of the following:

type PhaseGetResponseObjectRulesSetCacheControlRuleActionParametersMustRevalidateSetDirective struct{…}

Set the directive.

Operation PhaseGetResponseObjectRulesSetCacheControlRuleActionParametersMustRevalidateSetDirectiveOperation

The operation to perform on the cache-control directive.

One of the following:

const PhaseGetResponseObjectRulesSetCacheControlRuleActionParametersMustRevalidateSetDirectiveOperationSet PhaseGetResponseObjectRulesSetCacheControlRuleActionParametersMustRevalidateSetDirectiveOperation = "set"

const PhaseGetResponseObjectRulesSetCacheControlRuleActionParametersMustRevalidateSetDirectiveOperationRemove PhaseGetResponseObjectRulesSetCacheControlRuleActionParametersMustRevalidateSetDirectiveOperation = "remove"

CloudflareOnly boolOptional

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

type PhaseGetResponseObjectRulesSetCacheControlRuleActionParametersMustRevalidateRemoveDirective struct{…}

Remove the directive.

Operation PhaseGetResponseObjectRulesSetCacheControlRuleActionParametersMustRevalidateRemoveDirectiveOperation

The operation to perform on the cache-control directive.

One of the following:

const PhaseGetResponseObjectRulesSetCacheControlRuleActionParametersMustRevalidateRemoveDirectiveOperationSet PhaseGetResponseObjectRulesSetCacheControlRuleActionParametersMustRevalidateRemoveDirectiveOperation = "set"

const PhaseGetResponseObjectRulesSetCacheControlRuleActionParametersMustRevalidateRemoveDirectiveOperationRemove PhaseGetResponseObjectRulesSetCacheControlRuleActionParametersMustRevalidateRemoveDirectiveOperation = "remove"

CloudflareOnly boolOptional

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

MustUnderstand PhaseGetResponseObjectRulesSetCacheControlRuleActionParametersMustUnderstandOptional

A cache-control directive configuration.

One of the following:

type PhaseGetResponseObjectRulesSetCacheControlRuleActionParametersMustUnderstandSetDirective struct{…}

Set the directive.

Operation PhaseGetResponseObjectRulesSetCacheControlRuleActionParametersMustUnderstandSetDirectiveOperation

The operation to perform on the cache-control directive.

One of the following:

const PhaseGetResponseObjectRulesSetCacheControlRuleActionParametersMustUnderstandSetDirectiveOperationSet PhaseGetResponseObjectRulesSetCacheControlRuleActionParametersMustUnderstandSetDirectiveOperation = "set"

const PhaseGetResponseObjectRulesSetCacheControlRuleActionParametersMustUnderstandSetDirectiveOperationRemove PhaseGetResponseObjectRulesSetCacheControlRuleActionParametersMustUnderstandSetDirectiveOperation = "remove"

CloudflareOnly boolOptional

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

type PhaseGetResponseObjectRulesSetCacheControlRuleActionParametersMustUnderstandRemoveDirective struct{…}

Remove the directive.

Operation PhaseGetResponseObjectRulesSetCacheControlRuleActionParametersMustUnderstandRemoveDirectiveOperation

The operation to perform on the cache-control directive.

One of the following:

const PhaseGetResponseObjectRulesSetCacheControlRuleActionParametersMustUnderstandRemoveDirectiveOperationSet PhaseGetResponseObjectRulesSetCacheControlRuleActionParametersMustUnderstandRemoveDirectiveOperation = "set"

const PhaseGetResponseObjectRulesSetCacheControlRuleActionParametersMustUnderstandRemoveDirectiveOperationRemove PhaseGetResponseObjectRulesSetCacheControlRuleActionParametersMustUnderstandRemoveDirectiveOperation = "remove"

CloudflareOnly boolOptional

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

NoCache PhaseGetResponseObjectRulesSetCacheControlRuleActionParametersNoCacheOptional

A cache-control directive configuration that accepts optional qualifiers (header names).

One of the following:

type PhaseGetResponseObjectRulesSetCacheControlRuleActionParametersNoCacheSetDirective struct{…}

Set the directive with optional qualifiers.

Operation PhaseGetResponseObjectRulesSetCacheControlRuleActionParametersNoCacheSetDirectiveOperation

The operation to perform on the cache-control directive.

One of the following:

const PhaseGetResponseObjectRulesSetCacheControlRuleActionParametersNoCacheSetDirectiveOperationSet PhaseGetResponseObjectRulesSetCacheControlRuleActionParametersNoCacheSetDirectiveOperation = "set"

const PhaseGetResponseObjectRulesSetCacheControlRuleActionParametersNoCacheSetDirectiveOperationRemove PhaseGetResponseObjectRulesSetCacheControlRuleActionParametersNoCacheSetDirectiveOperation = "remove"

CloudflareOnly boolOptional

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

Qualifiers []stringOptional

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

type PhaseGetResponseObjectRulesSetCacheControlRuleActionParametersNoCacheRemoveDirective struct{…}

Remove the directive.

Operation PhaseGetResponseObjectRulesSetCacheControlRuleActionParametersNoCacheRemoveDirectiveOperation

The operation to perform on the cache-control directive.

One of the following:

const PhaseGetResponseObjectRulesSetCacheControlRuleActionParametersNoCacheRemoveDirectiveOperationSet PhaseGetResponseObjectRulesSetCacheControlRuleActionParametersNoCacheRemoveDirectiveOperation = "set"

const PhaseGetResponseObjectRulesSetCacheControlRuleActionParametersNoCacheRemoveDirectiveOperationRemove PhaseGetResponseObjectRulesSetCacheControlRuleActionParametersNoCacheRemoveDirectiveOperation = "remove"

CloudflareOnly boolOptional

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

NoStore PhaseGetResponseObjectRulesSetCacheControlRuleActionParametersNoStoreOptional

A cache-control directive configuration.

One of the following:

type PhaseGetResponseObjectRulesSetCacheControlRuleActionParametersNoStoreSetDirective struct{…}

Set the directive.

Operation PhaseGetResponseObjectRulesSetCacheControlRuleActionParametersNoStoreSetDirectiveOperation

The operation to perform on the cache-control directive.

One of the following:

const PhaseGetResponseObjectRulesSetCacheControlRuleActionParametersNoStoreSetDirectiveOperationSet PhaseGetResponseObjectRulesSetCacheControlRuleActionParametersNoStoreSetDirectiveOperation = "set"

const PhaseGetResponseObjectRulesSetCacheControlRuleActionParametersNoStoreSetDirectiveOperationRemove PhaseGetResponseObjectRulesSetCacheControlRuleActionParametersNoStoreSetDirectiveOperation = "remove"

CloudflareOnly boolOptional

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

type PhaseGetResponseObjectRulesSetCacheControlRuleActionParametersNoStoreRemoveDirective struct{…}

Remove the directive.

Operation PhaseGetResponseObjectRulesSetCacheControlRuleActionParametersNoStoreRemoveDirectiveOperation

The operation to perform on the cache-control directive.

One of the following:

const PhaseGetResponseObjectRulesSetCacheControlRuleActionParametersNoStoreRemoveDirectiveOperationSet PhaseGetResponseObjectRulesSetCacheControlRuleActionParametersNoStoreRemoveDirectiveOperation = "set"

const PhaseGetResponseObjectRulesSetCacheControlRuleActionParametersNoStoreRemoveDirectiveOperationRemove PhaseGetResponseObjectRulesSetCacheControlRuleActionParametersNoStoreRemoveDirectiveOperation = "remove"

CloudflareOnly boolOptional

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

NoTransform PhaseGetResponseObjectRulesSetCacheControlRuleActionParametersNoTransformOptional

A cache-control directive configuration.

One of the following:

type PhaseGetResponseObjectRulesSetCacheControlRuleActionParametersNoTransformSetDirective struct{…}

Set the directive.

Operation PhaseGetResponseObjectRulesSetCacheControlRuleActionParametersNoTransformSetDirectiveOperation

The operation to perform on the cache-control directive.

One of the following:

const PhaseGetResponseObjectRulesSetCacheControlRuleActionParametersNoTransformSetDirectiveOperationSet PhaseGetResponseObjectRulesSetCacheControlRuleActionParametersNoTransformSetDirectiveOperation = "set"

const PhaseGetResponseObjectRulesSetCacheControlRuleActionParametersNoTransformSetDirectiveOperationRemove PhaseGetResponseObjectRulesSetCacheControlRuleActionParametersNoTransformSetDirectiveOperation = "remove"

CloudflareOnly boolOptional

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

type PhaseGetResponseObjectRulesSetCacheControlRuleActionParametersNoTransformRemoveDirective struct{…}

Remove the directive.

Operation PhaseGetResponseObjectRulesSetCacheControlRuleActionParametersNoTransformRemoveDirectiveOperation

The operation to perform on the cache-control directive.

One of the following:

const PhaseGetResponseObjectRulesSetCacheControlRuleActionParametersNoTransformRemoveDirectiveOperationSet PhaseGetResponseObjectRulesSetCacheControlRuleActionParametersNoTransformRemoveDirectiveOperation = "set"

const PhaseGetResponseObjectRulesSetCacheControlRuleActionParametersNoTransformRemoveDirectiveOperationRemove PhaseGetResponseObjectRulesSetCacheControlRuleActionParametersNoTransformRemoveDirectiveOperation = "remove"

CloudflareOnly boolOptional

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

Private PhaseGetResponseObjectRulesSetCacheControlRuleActionParametersPrivateOptional

A cache-control directive configuration that accepts optional qualifiers (header names).

One of the following:

type PhaseGetResponseObjectRulesSetCacheControlRuleActionParametersPrivateSetDirective struct{…}

Set the directive with optional qualifiers.

Operation PhaseGetResponseObjectRulesSetCacheControlRuleActionParametersPrivateSetDirectiveOperation

The operation to perform on the cache-control directive.

One of the following:

const PhaseGetResponseObjectRulesSetCacheControlRuleActionParametersPrivateSetDirectiveOperationSet PhaseGetResponseObjectRulesSetCacheControlRuleActionParametersPrivateSetDirectiveOperation = "set"

const PhaseGetResponseObjectRulesSetCacheControlRuleActionParametersPrivateSetDirectiveOperationRemove PhaseGetResponseObjectRulesSetCacheControlRuleActionParametersPrivateSetDirectiveOperation = "remove"

CloudflareOnly boolOptional

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

Qualifiers []stringOptional

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

type PhaseGetResponseObjectRulesSetCacheControlRuleActionParametersPrivateRemoveDirective struct{…}

Remove the directive.

Operation PhaseGetResponseObjectRulesSetCacheControlRuleActionParametersPrivateRemoveDirectiveOperation

The operation to perform on the cache-control directive.

One of the following:

const PhaseGetResponseObjectRulesSetCacheControlRuleActionParametersPrivateRemoveDirectiveOperationSet PhaseGetResponseObjectRulesSetCacheControlRuleActionParametersPrivateRemoveDirectiveOperation = "set"

const PhaseGetResponseObjectRulesSetCacheControlRuleActionParametersPrivateRemoveDirectiveOperationRemove PhaseGetResponseObjectRulesSetCacheControlRuleActionParametersPrivateRemoveDirectiveOperation = "remove"

CloudflareOnly boolOptional

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

ProxyRevalidate PhaseGetResponseObjectRulesSetCacheControlRuleActionParametersProxyRevalidateOptional

A cache-control directive configuration.

One of the following:

type PhaseGetResponseObjectRulesSetCacheControlRuleActionParametersProxyRevalidateSetDirective struct{…}

Set the directive.

Operation PhaseGetResponseObjectRulesSetCacheControlRuleActionParametersProxyRevalidateSetDirectiveOperation

The operation to perform on the cache-control directive.

One of the following:

const PhaseGetResponseObjectRulesSetCacheControlRuleActionParametersProxyRevalidateSetDirectiveOperationSet PhaseGetResponseObjectRulesSetCacheControlRuleActionParametersProxyRevalidateSetDirectiveOperation = "set"

const PhaseGetResponseObjectRulesSetCacheControlRuleActionParametersProxyRevalidateSetDirectiveOperationRemove PhaseGetResponseObjectRulesSetCacheControlRuleActionParametersProxyRevalidateSetDirectiveOperation = "remove"

CloudflareOnly boolOptional

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

type PhaseGetResponseObjectRulesSetCacheControlRuleActionParametersProxyRevalidateRemoveDirective struct{…}

Remove the directive.

Operation PhaseGetResponseObjectRulesSetCacheControlRuleActionParametersProxyRevalidateRemoveDirectiveOperation

The operation to perform on the cache-control directive.

One of the following:

const PhaseGetResponseObjectRulesSetCacheControlRuleActionParametersProxyRevalidateRemoveDirectiveOperationSet PhaseGetResponseObjectRulesSetCacheControlRuleActionParametersProxyRevalidateRemoveDirectiveOperation = "set"

const PhaseGetResponseObjectRulesSetCacheControlRuleActionParametersProxyRevalidateRemoveDirectiveOperationRemove PhaseGetResponseObjectRulesSetCacheControlRuleActionParametersProxyRevalidateRemoveDirectiveOperation = "remove"

CloudflareOnly boolOptional

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

Public PhaseGetResponseObjectRulesSetCacheControlRuleActionParametersPublicOptional

A cache-control directive configuration.

One of the following:

type PhaseGetResponseObjectRulesSetCacheControlRuleActionParametersPublicSetDirective struct{…}

Set the directive.

Operation PhaseGetResponseObjectRulesSetCacheControlRuleActionParametersPublicSetDirectiveOperation

The operation to perform on the cache-control directive.

One of the following:

const PhaseGetResponseObjectRulesSetCacheControlRuleActionParametersPublicSetDirectiveOperationSet PhaseGetResponseObjectRulesSetCacheControlRuleActionParametersPublicSetDirectiveOperation = "set"

const PhaseGetResponseObjectRulesSetCacheControlRuleActionParametersPublicSetDirectiveOperationRemove PhaseGetResponseObjectRulesSetCacheControlRuleActionParametersPublicSetDirectiveOperation = "remove"

CloudflareOnly boolOptional

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

type PhaseGetResponseObjectRulesSetCacheControlRuleActionParametersPublicRemoveDirective struct{…}

Remove the directive.

Operation PhaseGetResponseObjectRulesSetCacheControlRuleActionParametersPublicRemoveDirectiveOperation

The operation to perform on the cache-control directive.

One of the following:

const PhaseGetResponseObjectRulesSetCacheControlRuleActionParametersPublicRemoveDirectiveOperationSet PhaseGetResponseObjectRulesSetCacheControlRuleActionParametersPublicRemoveDirectiveOperation = "set"

const PhaseGetResponseObjectRulesSetCacheControlRuleActionParametersPublicRemoveDirectiveOperationRemove PhaseGetResponseObjectRulesSetCacheControlRuleActionParametersPublicRemoveDirectiveOperation = "remove"

CloudflareOnly boolOptional

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

SMaxage PhaseGetResponseObjectRulesSetCacheControlRuleActionParametersSMaxageOptional

A cache-control directive configuration that accepts a duration value in seconds.

One of the following:

type PhaseGetResponseObjectRulesSetCacheControlRuleActionParametersSMaxageSetDirective struct{…}

Set the directive with a duration value in seconds.

Operation PhaseGetResponseObjectRulesSetCacheControlRuleActionParametersSMaxageSetDirectiveOperation

The operation to perform on the cache-control directive.

One of the following:

const PhaseGetResponseObjectRulesSetCacheControlRuleActionParametersSMaxageSetDirectiveOperationSet PhaseGetResponseObjectRulesSetCacheControlRuleActionParametersSMaxageSetDirectiveOperation = "set"

const PhaseGetResponseObjectRulesSetCacheControlRuleActionParametersSMaxageSetDirectiveOperationRemove PhaseGetResponseObjectRulesSetCacheControlRuleActionParametersSMaxageSetDirectiveOperation = "remove"

Value int64

The duration value in seconds for the directive.

minimum0

CloudflareOnly boolOptional

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

type PhaseGetResponseObjectRulesSetCacheControlRuleActionParametersSMaxageRemoveDirective struct{…}

Remove the directive.

Operation PhaseGetResponseObjectRulesSetCacheControlRuleActionParametersSMaxageRemoveDirectiveOperation

The operation to perform on the cache-control directive.

One of the following:

const PhaseGetResponseObjectRulesSetCacheControlRuleActionParametersSMaxageRemoveDirectiveOperationSet PhaseGetResponseObjectRulesSetCacheControlRuleActionParametersSMaxageRemoveDirectiveOperation = "set"

const PhaseGetResponseObjectRulesSetCacheControlRuleActionParametersSMaxageRemoveDirectiveOperationRemove PhaseGetResponseObjectRulesSetCacheControlRuleActionParametersSMaxageRemoveDirectiveOperation = "remove"

CloudflareOnly boolOptional

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

StaleIfError PhaseGetResponseObjectRulesSetCacheControlRuleActionParametersStaleIfErrorOptional

A cache-control directive configuration that accepts a duration value in seconds.

One of the following:

type PhaseGetResponseObjectRulesSetCacheControlRuleActionParametersStaleIfErrorSetDirective struct{…}

Set the directive with a duration value in seconds.

Operation PhaseGetResponseObjectRulesSetCacheControlRuleActionParametersStaleIfErrorSetDirectiveOperation

The operation to perform on the cache-control directive.

One of the following:

const PhaseGetResponseObjectRulesSetCacheControlRuleActionParametersStaleIfErrorSetDirectiveOperationSet PhaseGetResponseObjectRulesSetCacheControlRuleActionParametersStaleIfErrorSetDirectiveOperation = "set"

const PhaseGetResponseObjectRulesSetCacheControlRuleActionParametersStaleIfErrorSetDirectiveOperationRemove PhaseGetResponseObjectRulesSetCacheControlRuleActionParametersStaleIfErrorSetDirectiveOperation = "remove"

Value int64

The duration value in seconds for the directive.

minimum0

CloudflareOnly boolOptional

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

type PhaseGetResponseObjectRulesSetCacheControlRuleActionParametersStaleIfErrorRemoveDirective struct{…}

Remove the directive.

Operation PhaseGetResponseObjectRulesSetCacheControlRuleActionParametersStaleIfErrorRemoveDirectiveOperation

The operation to perform on the cache-control directive.

One of the following:

const PhaseGetResponseObjectRulesSetCacheControlRuleActionParametersStaleIfErrorRemoveDirectiveOperationSet PhaseGetResponseObjectRulesSetCacheControlRuleActionParametersStaleIfErrorRemoveDirectiveOperation = "set"

const PhaseGetResponseObjectRulesSetCacheControlRuleActionParametersStaleIfErrorRemoveDirectiveOperationRemove PhaseGetResponseObjectRulesSetCacheControlRuleActionParametersStaleIfErrorRemoveDirectiveOperation = "remove"

CloudflareOnly boolOptional

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

StaleWhileRevalidate PhaseGetResponseObjectRulesSetCacheControlRuleActionParametersStaleWhileRevalidateOptional

A cache-control directive configuration that accepts a duration value in seconds.

One of the following:

type PhaseGetResponseObjectRulesSetCacheControlRuleActionParametersStaleWhileRevalidateSetDirective struct{…}

Set the directive with a duration value in seconds.

Operation PhaseGetResponseObjectRulesSetCacheControlRuleActionParametersStaleWhileRevalidateSetDirectiveOperation

The operation to perform on the cache-control directive.

One of the following:

const PhaseGetResponseObjectRulesSetCacheControlRuleActionParametersStaleWhileRevalidateSetDirectiveOperationSet PhaseGetResponseObjectRulesSetCacheControlRuleActionParametersStaleWhileRevalidateSetDirectiveOperation = "set"

const PhaseGetResponseObjectRulesSetCacheControlRuleActionParametersStaleWhileRevalidateSetDirectiveOperationRemove PhaseGetResponseObjectRulesSetCacheControlRuleActionParametersStaleWhileRevalidateSetDirectiveOperation = "remove"

Value int64

The duration value in seconds for the directive.

minimum0

CloudflareOnly boolOptional

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

type PhaseGetResponseObjectRulesSetCacheControlRuleActionParametersStaleWhileRevalidateRemoveDirective struct{…}

Remove the directive.

Operation PhaseGetResponseObjectRulesSetCacheControlRuleActionParametersStaleWhileRevalidateRemoveDirectiveOperation

The operation to perform on the cache-control directive.

One of the following:

const PhaseGetResponseObjectRulesSetCacheControlRuleActionParametersStaleWhileRevalidateRemoveDirectiveOperationSet PhaseGetResponseObjectRulesSetCacheControlRuleActionParametersStaleWhileRevalidateRemoveDirectiveOperation = "set"

const PhaseGetResponseObjectRulesSetCacheControlRuleActionParametersStaleWhileRevalidateRemoveDirectiveOperationRemove PhaseGetResponseObjectRulesSetCacheControlRuleActionParametersStaleWhileRevalidateRemoveDirectiveOperation = "remove"

CloudflareOnly boolOptional

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

Categories []stringOptional

The categories of the rule.

Description stringOptional

An informative description of the rule.

ExposedCredentialCheck PhaseGetResponseObjectRulesSetCacheControlRuleExposedCredentialCheckOptional

Configuration for exposed credential checking.

PasswordExpression string

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

minLength1

UsernameExpression string

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

minLength1

Logging LoggingOptional

An object configuring the rule’s logging behavior.

Enabled bool

Whether to generate a log when the rule matches.

Ratelimit PhaseGetResponseObjectRulesSetCacheControlRuleRatelimitOptional

An object configuring the rule’s rate limit behavior.

Characteristics []string

Characteristics of the request on which the rate limit counter will be incremented.

Period int64

Period in seconds over which the counter is being incremented.

minimum0

CountingExpression stringOptional

An expression that defines when the rate limit counter should be incremented. It defaults to the same as the rule’s expression.

minLength1

MitigationTimeout int64Optional

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

RequestsPerPeriod int64Optional

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

minimum1

RequestsToOrigin boolOptional

Whether counting is only performed when an origin is reached.

ScorePerPeriod int64Optional

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

ScoreResponseHeaderName stringOptional

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

minLength1

type PhaseGetResponseObjectRulesSetCacheSettingsRule struct{…}

ID string

Action string

Enabled bool

Expression string

Ref string

type PhaseGetResponseObjectRulesSetCacheTagsRule struct{…}

ID string

The unique ID of the rule.

Action PhaseGetResponseObjectRulesSetCacheTagsRuleAction

The action to perform when the rule matches.

Enabled bool

Expression string

The expression defining which traffic will match the rule.

minLength1

LastUpdated Time

The timestamp of when the rule was last modified.

formatdate-time

Ref string

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

minLength1

Version string

The version of the rule.

ActionParameters PhaseGetResponseObjectRulesSetCacheTagsRuleActionParametersOptional

The parameters configuring the rule’s action.

One of the following:

type PhaseGetResponseObjectRulesSetCacheTagsRuleActionParametersAddCacheTagsValues struct{…}

Add cache tags using a list of values.

Operation PhaseGetResponseObjectRulesSetCacheTagsRuleActionParametersAddCacheTagsValuesOperation

The operation to perform on the cache tags.

One of the following:

const PhaseGetResponseObjectRulesSetCacheTagsRuleActionParametersAddCacheTagsValuesOperationAdd PhaseGetResponseObjectRulesSetCacheTagsRuleActionParametersAddCacheTagsValuesOperation = "add"

const PhaseGetResponseObjectRulesSetCacheTagsRuleActionParametersAddCacheTagsValuesOperationRemove PhaseGetResponseObjectRulesSetCacheTagsRuleActionParametersAddCacheTagsValuesOperation = "remove"

const PhaseGetResponseObjectRulesSetCacheTagsRuleActionParametersAddCacheTagsValuesOperationSet PhaseGetResponseObjectRulesSetCacheTagsRuleActionParametersAddCacheTagsValuesOperation = "set"

Values []string

A list of cache tag values.

type PhaseGetResponseObjectRulesSetCacheTagsRuleActionParametersAddCacheTagsExpression struct{…}

Add cache tags using an expression.

Expression string

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

minLength1

Operation PhaseGetResponseObjectRulesSetCacheTagsRuleActionParametersAddCacheTagsExpressionOperation

The operation to perform on the cache tags.

One of the following:

const PhaseGetResponseObjectRulesSetCacheTagsRuleActionParametersAddCacheTagsExpressionOperationAdd PhaseGetResponseObjectRulesSetCacheTagsRuleActionParametersAddCacheTagsExpressionOperation = "add"

const PhaseGetResponseObjectRulesSetCacheTagsRuleActionParametersAddCacheTagsExpressionOperationRemove PhaseGetResponseObjectRulesSetCacheTagsRuleActionParametersAddCacheTagsExpressionOperation = "remove"

const PhaseGetResponseObjectRulesSetCacheTagsRuleActionParametersAddCacheTagsExpressionOperationSet PhaseGetResponseObjectRulesSetCacheTagsRuleActionParametersAddCacheTagsExpressionOperation = "set"

type PhaseGetResponseObjectRulesSetCacheTagsRuleActionParametersRemoveCacheTagsValues struct{…}

Remove cache tags using a list of values.

Operation PhaseGetResponseObjectRulesSetCacheTagsRuleActionParametersRemoveCacheTagsValuesOperation

The operation to perform on the cache tags.

One of the following:

const PhaseGetResponseObjectRulesSetCacheTagsRuleActionParametersRemoveCacheTagsValuesOperationAdd PhaseGetResponseObjectRulesSetCacheTagsRuleActionParametersRemoveCacheTagsValuesOperation = "add"

const PhaseGetResponseObjectRulesSetCacheTagsRuleActionParametersRemoveCacheTagsValuesOperationRemove PhaseGetResponseObjectRulesSetCacheTagsRuleActionParametersRemoveCacheTagsValuesOperation = "remove"

const PhaseGetResponseObjectRulesSetCacheTagsRuleActionParametersRemoveCacheTagsValuesOperationSet PhaseGetResponseObjectRulesSetCacheTagsRuleActionParametersRemoveCacheTagsValuesOperation = "set"

Values []string

A list of cache tag values.

type PhaseGetResponseObjectRulesSetCacheTagsRuleActionParametersRemoveCacheTagsExpression struct{…}

Remove cache tags using an expression.

Expression string

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

minLength1

Operation PhaseGetResponseObjectRulesSetCacheTagsRuleActionParametersRemoveCacheTagsExpressionOperation

The operation to perform on the cache tags.

One of the following:

const PhaseGetResponseObjectRulesSetCacheTagsRuleActionParametersRemoveCacheTagsExpressionOperationAdd PhaseGetResponseObjectRulesSetCacheTagsRuleActionParametersRemoveCacheTagsExpressionOperation = "add"

const PhaseGetResponseObjectRulesSetCacheTagsRuleActionParametersRemoveCacheTagsExpressionOperationRemove PhaseGetResponseObjectRulesSetCacheTagsRuleActionParametersRemoveCacheTagsExpressionOperation = "remove"

const PhaseGetResponseObjectRulesSetCacheTagsRuleActionParametersRemoveCacheTagsExpressionOperationSet PhaseGetResponseObjectRulesSetCacheTagsRuleActionParametersRemoveCacheTagsExpressionOperation = "set"

type PhaseGetResponseObjectRulesSetCacheTagsRuleActionParametersSetCacheTagsValues struct{…}

Set cache tags using a list of values.

Operation PhaseGetResponseObjectRulesSetCacheTagsRuleActionParametersSetCacheTagsValuesOperation

The operation to perform on the cache tags.

One of the following:

const PhaseGetResponseObjectRulesSetCacheTagsRuleActionParametersSetCacheTagsValuesOperationAdd PhaseGetResponseObjectRulesSetCacheTagsRuleActionParametersSetCacheTagsValuesOperation = "add"

const PhaseGetResponseObjectRulesSetCacheTagsRuleActionParametersSetCacheTagsValuesOperationRemove PhaseGetResponseObjectRulesSetCacheTagsRuleActionParametersSetCacheTagsValuesOperation = "remove"

const PhaseGetResponseObjectRulesSetCacheTagsRuleActionParametersSetCacheTagsValuesOperationSet PhaseGetResponseObjectRulesSetCacheTagsRuleActionParametersSetCacheTagsValuesOperation = "set"

Values []string

A list of cache tag values.

type PhaseGetResponseObjectRulesSetCacheTagsRuleActionParametersSetCacheTagsExpression struct{…}

Set cache tags using an expression.

Expression string

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

minLength1

Operation PhaseGetResponseObjectRulesSetCacheTagsRuleActionParametersSetCacheTagsExpressionOperation

The operation to perform on the cache tags.

One of the following:

const PhaseGetResponseObjectRulesSetCacheTagsRuleActionParametersSetCacheTagsExpressionOperationAdd PhaseGetResponseObjectRulesSetCacheTagsRuleActionParametersSetCacheTagsExpressionOperation = "add"

const PhaseGetResponseObjectRulesSetCacheTagsRuleActionParametersSetCacheTagsExpressionOperationRemove PhaseGetResponseObjectRulesSetCacheTagsRuleActionParametersSetCacheTagsExpressionOperation = "remove"

const PhaseGetResponseObjectRulesSetCacheTagsRuleActionParametersSetCacheTagsExpressionOperationSet PhaseGetResponseObjectRulesSetCacheTagsRuleActionParametersSetCacheTagsExpressionOperation = "set"

Categories []stringOptional

The categories of the rule.

Description stringOptional

An informative description of the rule.

ExposedCredentialCheck PhaseGetResponseObjectRulesSetCacheTagsRuleExposedCredentialCheckOptional

Configuration for exposed credential checking.

PasswordExpression string

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

minLength1

UsernameExpression string

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

minLength1

Logging LoggingOptional

An object configuring the rule’s logging behavior.

Enabled bool

Whether to generate a log when the rule matches.

Ratelimit PhaseGetResponseObjectRulesSetCacheTagsRuleRatelimitOptional

An object configuring the rule’s rate limit behavior.

Characteristics []string

Characteristics of the request on which the rate limit counter will be incremented.

Period int64

Period in seconds over which the counter is being incremented.

minimum0

CountingExpression stringOptional

An expression that defines when the rate limit counter should be incremented. It defaults to the same as the rule’s expression.

minLength1

MitigationTimeout int64Optional

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

RequestsPerPeriod int64Optional

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

minimum1

RequestsToOrigin boolOptional

Whether counting is only performed when an origin is reached.

ScorePerPeriod int64Optional

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

ScoreResponseHeaderName stringOptional

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

minLength1

type PhaseGetResponseObjectRulesSetConfigurationRule struct{…}

ID string

Action string

Enabled bool

Expression string

Ref string

type PhaseGetResponseObjectRulesSkipRule struct{…}

ID string

Action string

Enabled bool

Expression string

Ref string

type PhaseGetResponseObjectRulesTransformResponseHTMLRule struct{…}

ID string

The unique ID of the rule.

Action PhaseGetResponseObjectRulesTransformResponseHTMLRuleAction

The action to perform when the rule matches.

Enabled bool

Expression string

The expression defining which traffic will match the rule.

minLength1

LastUpdated Time

The timestamp of when the rule was last modified.

formatdate-time

Ref string

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

minLength1

Version string

The version of the rule.

ActionParameters PhaseGetResponseObjectRulesTransformResponseHTMLRuleActionParametersOptional

The parameters configuring the rule’s action.

LinkMaze unknown

Enables the link maze transformation on the response.

Categories []stringOptional

The categories of the rule.

Description stringOptional

An informative description of the rule.

ExposedCredentialCheck PhaseGetResponseObjectRulesTransformResponseHTMLRuleExposedCredentialCheckOptional

Configuration for exposed credential checking.

PasswordExpression string

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

minLength1

UsernameExpression string

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

minLength1

Logging LoggingOptional

An object configuring the rule’s logging behavior.

Enabled bool

Whether to generate a log when the rule matches.

Ratelimit PhaseGetResponseObjectRulesTransformResponseHTMLRuleRatelimitOptional

An object configuring the rule’s rate limit behavior.

Characteristics []string

Characteristics of the request on which the rate limit counter will be incremented.

Period int64

Period in seconds over which the counter is being incremented.

minimum0

CountingExpression stringOptional

An expression that defines when the rate limit counter should be incremented. It defaults to the same as the rule’s expression.

minLength1

MitigationTimeout int64Optional

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

RequestsPerPeriod int64Optional

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

minimum1

RequestsToOrigin boolOptional

Whether counting is only performed when an origin is reached.

ScorePerPeriod int64Optional

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

ScoreResponseHeaderName stringOptional

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

minLength1

Version stringOptional

The version of the ruleset.

type PhaseGetResponseObject struct{…}

ID stringOptional

The unique ID of the ruleset.

Description stringOptional

An informative description of the ruleset.

Kind KindOptional

The kind of the ruleset.

One of the following:

const KindManaged Kind = "managed"

const KindCustom Kind = "custom"

const KindRoot Kind = "root"

const KindZone Kind = "zone"

LastUpdated TimeOptional

The timestamp of when the ruleset was last modified.

formatdate-time

Name stringOptional

The human-readable name of the ruleset.

minLength1

Phase PhaseOptional

The phase of the ruleset.

One of the following:

const PhaseDDoSL4 Phase = "ddos_l4"

const PhaseDDoSL7 Phase = "ddos_l7"

const PhaseHTTPConfigSettings Phase = "http_config_settings"

const PhaseHTTPCustomErrors Phase = "http_custom_errors"

const PhaseHTTPLogCustomFields Phase = "http_log_custom_fields"

const PhaseHTTPRatelimit Phase = "http_ratelimit"

const PhaseHTTPRequestCacheSettings Phase = "http_request_cache_settings"

const PhaseHTTPRequestDynamicRedirect Phase = "http_request_dynamic_redirect"

const PhaseHTTPRequestFirewallCustom Phase = "http_request_firewall_custom"

const PhaseHTTPRequestFirewallManaged Phase = "http_request_firewall_managed"

const PhaseHTTPRequestLateTransform Phase = "http_request_late_transform"

const PhaseHTTPRequestOrigin Phase = "http_request_origin"

const PhaseHTTPRequestRedirect Phase = "http_request_redirect"

const PhaseHTTPRequestSanitize Phase = "http_request_sanitize"

const PhaseHTTPRequestSBFM Phase = "http_request_sbfm"

const PhaseHTTPRequestTransform Phase = "http_request_transform"

const PhaseHTTPResponseCacheSettings Phase = "http_response_cache_settings"

const PhaseHTTPResponseCompression Phase = "http_response_compression"

const PhaseHTTPResponseFirewallCustom Phase = "http_response_firewall_custom"

const PhaseHTTPResponseFirewallManaged Phase = "http_response_firewall_managed"

const PhaseHTTPResponseHeadersTransform Phase = "http_response_headers_transform"

const PhaseMagicTransit Phase = "magic_transit"

const PhaseMagicTransitIDsManaged Phase = "magic_transit_ids_managed"

const PhaseMagicTransitManaged Phase = "magic_transit_managed"

const PhaseMagicTransitRatelimit Phase = "magic_transit_ratelimit"

Rules []PhaseGetResponseObjectRuleOptional

The list of rules in the ruleset.

One of the following:

type PhaseGetResponseObjectRulesBlockRule struct{…}

ID string

Action string

Enabled bool

Expression string

Ref string

type PhaseGetResponseObjectRulesChallengeRule struct{…}

ID string

The unique ID of the rule.

Action PhaseGetResponseObjectRulesChallengeRuleAction

The action to perform when the rule matches.

Enabled bool

Whether the rule should be executed.

Expression string

The expression defining which traffic will match the rule.

minLength1

LastUpdated Time

The timestamp of when the rule was last modified.

formatdate-time

Ref string

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

minLength1

Version string

The version of the rule.

ActionParameters unknownOptional

The parameters configuring the rule’s action.

Categories []stringOptional

The categories of the rule.

Description stringOptional

An informative description of the rule.

ExposedCredentialCheck PhaseGetResponseObjectRulesChallengeRuleExposedCredentialCheckOptional

Configuration for exposed credential checking.

PasswordExpression string

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

minLength1

UsernameExpression string

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

minLength1

Logging LoggingOptional

An object configuring the rule’s logging behavior.

Enabled bool

Whether to generate a log when the rule matches.

Ratelimit PhaseGetResponseObjectRulesChallengeRuleRatelimitOptional

An object configuring the rule’s rate limit behavior.

Characteristics []string

Characteristics of the request on which the rate limit counter will be incremented.

Period int64

Period in seconds over which the counter is being incremented.

minimum0

CountingExpression stringOptional

An expression that defines when the rate limit counter should be incremented. It defaults to the same as the rule’s expression.

minLength1

MitigationTimeout int64Optional

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

RequestsPerPeriod int64Optional

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

minimum1

RequestsToOrigin boolOptional

Whether counting is only performed when an origin is reached.

ScorePerPeriod int64Optional

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

ScoreResponseHeaderName stringOptional

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

minLength1

type PhaseGetResponseObjectRulesResponseCompressionRule struct{…}

ID string

Action string

Enabled bool

Expression string

Ref string

type PhaseGetResponseObjectRulesDDoSDynamicRule struct{…}

ID string

Action string

Enabled bool

Expression string

Ref string

type PhaseGetResponseObjectRulesExecuteRule struct{…}

ID string

Action string

Enabled bool

Expression string

Ref string

type PhaseGetResponseObjectRulesForceConnectionCloseRule struct{…}

ID string

Action string

Enabled bool

Expression string

Ref string

type PhaseGetResponseObjectRulesJavaScriptChallengeRule struct{…}

ID string

The unique ID of the rule.

Action PhaseGetResponseObjectRulesJavaScriptChallengeRuleAction

The action to perform when the rule matches.

Enabled bool

Whether the rule should be executed.

Expression string

The expression defining which traffic will match the rule.

minLength1

LastUpdated Time

The timestamp of when the rule was last modified.

formatdate-time

Ref string

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

minLength1

Version string

The version of the rule.

ActionParameters unknownOptional

The parameters configuring the rule’s action.

Categories []stringOptional

The categories of the rule.

Description stringOptional

An informative description of the rule.

ExposedCredentialCheck PhaseGetResponseObjectRulesJavaScriptChallengeRuleExposedCredentialCheckOptional

Configuration for exposed credential checking.

PasswordExpression string

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

minLength1

UsernameExpression string

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

minLength1

Logging LoggingOptional

An object configuring the rule’s logging behavior.

Enabled bool

Whether to generate a log when the rule matches.

Ratelimit PhaseGetResponseObjectRulesJavaScriptChallengeRuleRatelimitOptional

An object configuring the rule’s rate limit behavior.

Characteristics []string

Characteristics of the request on which the rate limit counter will be incremented.

Period int64

Period in seconds over which the counter is being incremented.

minimum0

CountingExpression stringOptional

An expression that defines when the rate limit counter should be incremented. It defaults to the same as the rule’s expression.

minLength1

MitigationTimeout int64Optional

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

RequestsPerPeriod int64Optional

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

minimum1

RequestsToOrigin boolOptional

Whether counting is only performed when an origin is reached.

ScorePerPeriod int64Optional

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

ScoreResponseHeaderName stringOptional

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

minLength1

type PhaseGetResponseObjectRulesLogRule struct{…}

ID string

Action string

Enabled bool

Expression string

Ref string

type PhaseGetResponseObjectRulesLogCustomFieldRule struct{…}

ID string

Action string

Enabled bool

Expression string

Ref string

type PhaseGetResponseObjectRulesManagedChallengeRule struct{…}

ID string

Action string

Enabled bool

Expression string

Ref string

type PhaseGetResponseObjectRulesRedirectRule struct{…}

ID string

Action string

Enabled bool

Expression string

Ref string

type PhaseGetResponseObjectRulesRewriteRule struct{…}

ID string

Action string

Enabled bool

Expression string

Ref string

type PhaseGetResponseObjectRulesRouteRule struct{…}

ID string

Action string

Enabled bool

Expression string

Ref string

type PhaseGetResponseObjectRulesScoreRule struct{…}

ID string

Action string

Enabled bool

Expression string

Ref string

type PhaseGetResponseObjectRulesServeErrorRule struct{…}

ID string

Action string

Enabled bool

Expression string

Ref string

type PhaseGetResponseObjectRulesSetCacheControlRule struct{…}

ID string

The unique ID of the rule.

Action PhaseGetResponseObjectRulesSetCacheControlRuleAction

The action to perform when the rule matches.

Enabled bool

Expression string

The expression defining which traffic will match the rule.

minLength1

LastUpdated Time

The timestamp of when the rule was last modified.

formatdate-time

Ref string

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

minLength1

Version string

The version of the rule.

ActionParameters PhaseGetResponseObjectRulesSetCacheControlRuleActionParametersOptional

The parameters configuring the rule’s action.

Immutable PhaseGetResponseObjectRulesSetCacheControlRuleActionParametersImmutableOptional

A cache-control directive configuration.

One of the following:

type PhaseGetResponseObjectRulesSetCacheControlRuleActionParametersImmutableSetDirective struct{…}

Set the directive.

Operation PhaseGetResponseObjectRulesSetCacheControlRuleActionParametersImmutableSetDirectiveOperation

The operation to perform on the cache-control directive.

One of the following:

const PhaseGetResponseObjectRulesSetCacheControlRuleActionParametersImmutableSetDirectiveOperationSet PhaseGetResponseObjectRulesSetCacheControlRuleActionParametersImmutableSetDirectiveOperation = "set"

const PhaseGetResponseObjectRulesSetCacheControlRuleActionParametersImmutableSetDirectiveOperationRemove PhaseGetResponseObjectRulesSetCacheControlRuleActionParametersImmutableSetDirectiveOperation = "remove"

CloudflareOnly boolOptional

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

type PhaseGetResponseObjectRulesSetCacheControlRuleActionParametersImmutableRemoveDirective struct{…}

Remove the directive.

Operation PhaseGetResponseObjectRulesSetCacheControlRuleActionParametersImmutableRemoveDirectiveOperation

The operation to perform on the cache-control directive.

One of the following:

const PhaseGetResponseObjectRulesSetCacheControlRuleActionParametersImmutableRemoveDirectiveOperationSet PhaseGetResponseObjectRulesSetCacheControlRuleActionParametersImmutableRemoveDirectiveOperation = "set"

const PhaseGetResponseObjectRulesSetCacheControlRuleActionParametersImmutableRemoveDirectiveOperationRemove PhaseGetResponseObjectRulesSetCacheControlRuleActionParametersImmutableRemoveDirectiveOperation = "remove"

CloudflareOnly boolOptional

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

MaxAge PhaseGetResponseObjectRulesSetCacheControlRuleActionParametersMaxAgeOptional

A cache-control directive configuration that accepts a duration value in seconds.

One of the following:

type PhaseGetResponseObjectRulesSetCacheControlRuleActionParametersMaxAgeSetDirective struct{…}

Set the directive with a duration value in seconds.

Operation PhaseGetResponseObjectRulesSetCacheControlRuleActionParametersMaxAgeSetDirectiveOperation

The operation to perform on the cache-control directive.

One of the following:

const PhaseGetResponseObjectRulesSetCacheControlRuleActionParametersMaxAgeSetDirectiveOperationSet PhaseGetResponseObjectRulesSetCacheControlRuleActionParametersMaxAgeSetDirectiveOperation = "set"

const PhaseGetResponseObjectRulesSetCacheControlRuleActionParametersMaxAgeSetDirectiveOperationRemove PhaseGetResponseObjectRulesSetCacheControlRuleActionParametersMaxAgeSetDirectiveOperation = "remove"

Value int64

The duration value in seconds for the directive.

minimum0

CloudflareOnly boolOptional

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

type PhaseGetResponseObjectRulesSetCacheControlRuleActionParametersMaxAgeRemoveDirective struct{…}

Remove the directive.

Operation PhaseGetResponseObjectRulesSetCacheControlRuleActionParametersMaxAgeRemoveDirectiveOperation

The operation to perform on the cache-control directive.

One of the following:

const PhaseGetResponseObjectRulesSetCacheControlRuleActionParametersMaxAgeRemoveDirectiveOperationSet PhaseGetResponseObjectRulesSetCacheControlRuleActionParametersMaxAgeRemoveDirectiveOperation = "set"

const PhaseGetResponseObjectRulesSetCacheControlRuleActionParametersMaxAgeRemoveDirectiveOperationRemove PhaseGetResponseObjectRulesSetCacheControlRuleActionParametersMaxAgeRemoveDirectiveOperation = "remove"

CloudflareOnly boolOptional

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

MustRevalidate PhaseGetResponseObjectRulesSetCacheControlRuleActionParametersMustRevalidateOptional

A cache-control directive configuration.

One of the following:

type PhaseGetResponseObjectRulesSetCacheControlRuleActionParametersMustRevalidateSetDirective struct{…}

Set the directive.

Operation PhaseGetResponseObjectRulesSetCacheControlRuleActionParametersMustRevalidateSetDirectiveOperation

The operation to perform on the cache-control directive.

One of the following:

const PhaseGetResponseObjectRulesSetCacheControlRuleActionParametersMustRevalidateSetDirectiveOperationSet PhaseGetResponseObjectRulesSetCacheControlRuleActionParametersMustRevalidateSetDirectiveOperation = "set"

const PhaseGetResponseObjectRulesSetCacheControlRuleActionParametersMustRevalidateSetDirectiveOperationRemove PhaseGetResponseObjectRulesSetCacheControlRuleActionParametersMustRevalidateSetDirectiveOperation = "remove"

CloudflareOnly boolOptional

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

type PhaseGetResponseObjectRulesSetCacheControlRuleActionParametersMustRevalidateRemoveDirective struct{…}

Remove the directive.

Operation PhaseGetResponseObjectRulesSetCacheControlRuleActionParametersMustRevalidateRemoveDirectiveOperation

The operation to perform on the cache-control directive.

One of the following:

const PhaseGetResponseObjectRulesSetCacheControlRuleActionParametersMustRevalidateRemoveDirectiveOperationSet PhaseGetResponseObjectRulesSetCacheControlRuleActionParametersMustRevalidateRemoveDirectiveOperation = "set"

const PhaseGetResponseObjectRulesSetCacheControlRuleActionParametersMustRevalidateRemoveDirectiveOperationRemove PhaseGetResponseObjectRulesSetCacheControlRuleActionParametersMustRevalidateRemoveDirectiveOperation = "remove"

CloudflareOnly boolOptional

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

MustUnderstand PhaseGetResponseObjectRulesSetCacheControlRuleActionParametersMustUnderstandOptional

A cache-control directive configuration.

One of the following:

type PhaseGetResponseObjectRulesSetCacheControlRuleActionParametersMustUnderstandSetDirective struct{…}

Set the directive.

Operation PhaseGetResponseObjectRulesSetCacheControlRuleActionParametersMustUnderstandSetDirectiveOperation

The operation to perform on the cache-control directive.

One of the following:

const PhaseGetResponseObjectRulesSetCacheControlRuleActionParametersMustUnderstandSetDirectiveOperationSet PhaseGetResponseObjectRulesSetCacheControlRuleActionParametersMustUnderstandSetDirectiveOperation = "set"

const PhaseGetResponseObjectRulesSetCacheControlRuleActionParametersMustUnderstandSetDirectiveOperationRemove PhaseGetResponseObjectRulesSetCacheControlRuleActionParametersMustUnderstandSetDirectiveOperation = "remove"

CloudflareOnly boolOptional

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

type PhaseGetResponseObjectRulesSetCacheControlRuleActionParametersMustUnderstandRemoveDirective struct{…}

Remove the directive.

Operation PhaseGetResponseObjectRulesSetCacheControlRuleActionParametersMustUnderstandRemoveDirectiveOperation

The operation to perform on the cache-control directive.

One of the following:

const PhaseGetResponseObjectRulesSetCacheControlRuleActionParametersMustUnderstandRemoveDirectiveOperationSet PhaseGetResponseObjectRulesSetCacheControlRuleActionParametersMustUnderstandRemoveDirectiveOperation = "set"

const PhaseGetResponseObjectRulesSetCacheControlRuleActionParametersMustUnderstandRemoveDirectiveOperationRemove PhaseGetResponseObjectRulesSetCacheControlRuleActionParametersMustUnderstandRemoveDirectiveOperation = "remove"

CloudflareOnly boolOptional

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

NoCache PhaseGetResponseObjectRulesSetCacheControlRuleActionParametersNoCacheOptional

A cache-control directive configuration that accepts optional qualifiers (header names).

One of the following:

type PhaseGetResponseObjectRulesSetCacheControlRuleActionParametersNoCacheSetDirective struct{…}

Set the directive with optional qualifiers.

Operation PhaseGetResponseObjectRulesSetCacheControlRuleActionParametersNoCacheSetDirectiveOperation

The operation to perform on the cache-control directive.

One of the following:

const PhaseGetResponseObjectRulesSetCacheControlRuleActionParametersNoCacheSetDirectiveOperationSet PhaseGetResponseObjectRulesSetCacheControlRuleActionParametersNoCacheSetDirectiveOperation = "set"

const PhaseGetResponseObjectRulesSetCacheControlRuleActionParametersNoCacheSetDirectiveOperationRemove PhaseGetResponseObjectRulesSetCacheControlRuleActionParametersNoCacheSetDirectiveOperation = "remove"

CloudflareOnly boolOptional

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

Qualifiers []stringOptional

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

type PhaseGetResponseObjectRulesSetCacheControlRuleActionParametersNoCacheRemoveDirective struct{…}

Remove the directive.

Operation PhaseGetResponseObjectRulesSetCacheControlRuleActionParametersNoCacheRemoveDirectiveOperation

The operation to perform on the cache-control directive.

One of the following:

const PhaseGetResponseObjectRulesSetCacheControlRuleActionParametersNoCacheRemoveDirectiveOperationSet PhaseGetResponseObjectRulesSetCacheControlRuleActionParametersNoCacheRemoveDirectiveOperation = "set"

const PhaseGetResponseObjectRulesSetCacheControlRuleActionParametersNoCacheRemoveDirectiveOperationRemove PhaseGetResponseObjectRulesSetCacheControlRuleActionParametersNoCacheRemoveDirectiveOperation = "remove"

CloudflareOnly boolOptional

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

NoStore PhaseGetResponseObjectRulesSetCacheControlRuleActionParametersNoStoreOptional

A cache-control directive configuration.

One of the following:

type PhaseGetResponseObjectRulesSetCacheControlRuleActionParametersNoStoreSetDirective struct{…}

Set the directive.

Operation PhaseGetResponseObjectRulesSetCacheControlRuleActionParametersNoStoreSetDirectiveOperation

The operation to perform on the cache-control directive.

One of the following:

const PhaseGetResponseObjectRulesSetCacheControlRuleActionParametersNoStoreSetDirectiveOperationSet PhaseGetResponseObjectRulesSetCacheControlRuleActionParametersNoStoreSetDirectiveOperation = "set"

const PhaseGetResponseObjectRulesSetCacheControlRuleActionParametersNoStoreSetDirectiveOperationRemove PhaseGetResponseObjectRulesSetCacheControlRuleActionParametersNoStoreSetDirectiveOperation = "remove"

CloudflareOnly boolOptional

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

type PhaseGetResponseObjectRulesSetCacheControlRuleActionParametersNoStoreRemoveDirective struct{…}

Remove the directive.

Operation PhaseGetResponseObjectRulesSetCacheControlRuleActionParametersNoStoreRemoveDirectiveOperation

The operation to perform on the cache-control directive.

One of the following:

const PhaseGetResponseObjectRulesSetCacheControlRuleActionParametersNoStoreRemoveDirectiveOperationSet PhaseGetResponseObjectRulesSetCacheControlRuleActionParametersNoStoreRemoveDirectiveOperation = "set"

const PhaseGetResponseObjectRulesSetCacheControlRuleActionParametersNoStoreRemoveDirectiveOperationRemove PhaseGetResponseObjectRulesSetCacheControlRuleActionParametersNoStoreRemoveDirectiveOperation = "remove"

CloudflareOnly boolOptional

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

NoTransform PhaseGetResponseObjectRulesSetCacheControlRuleActionParametersNoTransformOptional

A cache-control directive configuration.

One of the following:

type PhaseGetResponseObjectRulesSetCacheControlRuleActionParametersNoTransformSetDirective struct{…}

Set the directive.

Operation PhaseGetResponseObjectRulesSetCacheControlRuleActionParametersNoTransformSetDirectiveOperation

The operation to perform on the cache-control directive.

One of the following:

const PhaseGetResponseObjectRulesSetCacheControlRuleActionParametersNoTransformSetDirectiveOperationSet PhaseGetResponseObjectRulesSetCacheControlRuleActionParametersNoTransformSetDirectiveOperation = "set"

const PhaseGetResponseObjectRulesSetCacheControlRuleActionParametersNoTransformSetDirectiveOperationRemove PhaseGetResponseObjectRulesSetCacheControlRuleActionParametersNoTransformSetDirectiveOperation = "remove"

CloudflareOnly boolOptional

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

type PhaseGetResponseObjectRulesSetCacheControlRuleActionParametersNoTransformRemoveDirective struct{…}

Remove the directive.

Operation PhaseGetResponseObjectRulesSetCacheControlRuleActionParametersNoTransformRemoveDirectiveOperation

The operation to perform on the cache-control directive.

One of the following:

const PhaseGetResponseObjectRulesSetCacheControlRuleActionParametersNoTransformRemoveDirectiveOperationSet PhaseGetResponseObjectRulesSetCacheControlRuleActionParametersNoTransformRemoveDirectiveOperation = "set"

const PhaseGetResponseObjectRulesSetCacheControlRuleActionParametersNoTransformRemoveDirectiveOperationRemove PhaseGetResponseObjectRulesSetCacheControlRuleActionParametersNoTransformRemoveDirectiveOperation = "remove"

CloudflareOnly boolOptional

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

Private PhaseGetResponseObjectRulesSetCacheControlRuleActionParametersPrivateOptional

A cache-control directive configuration that accepts optional qualifiers (header names).

One of the following:

type PhaseGetResponseObjectRulesSetCacheControlRuleActionParametersPrivateSetDirective struct{…}

Set the directive with optional qualifiers.

Operation PhaseGetResponseObjectRulesSetCacheControlRuleActionParametersPrivateSetDirectiveOperation

The operation to perform on the cache-control directive.

One of the following:

const PhaseGetResponseObjectRulesSetCacheControlRuleActionParametersPrivateSetDirectiveOperationSet PhaseGetResponseObjectRulesSetCacheControlRuleActionParametersPrivateSetDirectiveOperation = "set"

const PhaseGetResponseObjectRulesSetCacheControlRuleActionParametersPrivateSetDirectiveOperationRemove PhaseGetResponseObjectRulesSetCacheControlRuleActionParametersPrivateSetDirectiveOperation = "remove"

CloudflareOnly boolOptional

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

Qualifiers []stringOptional

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

type PhaseGetResponseObjectRulesSetCacheControlRuleActionParametersPrivateRemoveDirective struct{…}

Remove the directive.

Operation PhaseGetResponseObjectRulesSetCacheControlRuleActionParametersPrivateRemoveDirectiveOperation

The operation to perform on the cache-control directive.

One of the following:

const PhaseGetResponseObjectRulesSetCacheControlRuleActionParametersPrivateRemoveDirectiveOperationSet PhaseGetResponseObjectRulesSetCacheControlRuleActionParametersPrivateRemoveDirectiveOperation = "set"

const PhaseGetResponseObjectRulesSetCacheControlRuleActionParametersPrivateRemoveDirectiveOperationRemove PhaseGetResponseObjectRulesSetCacheControlRuleActionParametersPrivateRemoveDirectiveOperation = "remove"

CloudflareOnly boolOptional

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

ProxyRevalidate PhaseGetResponseObjectRulesSetCacheControlRuleActionParametersProxyRevalidateOptional

A cache-control directive configuration.

One of the following:

type PhaseGetResponseObjectRulesSetCacheControlRuleActionParametersProxyRevalidateSetDirective struct{…}

Set the directive.

Operation PhaseGetResponseObjectRulesSetCacheControlRuleActionParametersProxyRevalidateSetDirectiveOperation

The operation to perform on the cache-control directive.

One of the following:

const PhaseGetResponseObjectRulesSetCacheControlRuleActionParametersProxyRevalidateSetDirectiveOperationSet PhaseGetResponseObjectRulesSetCacheControlRuleActionParametersProxyRevalidateSetDirectiveOperation = "set"

const PhaseGetResponseObjectRulesSetCacheControlRuleActionParametersProxyRevalidateSetDirectiveOperationRemove PhaseGetResponseObjectRulesSetCacheControlRuleActionParametersProxyRevalidateSetDirectiveOperation = "remove"

CloudflareOnly boolOptional

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

type PhaseGetResponseObjectRulesSetCacheControlRuleActionParametersProxyRevalidateRemoveDirective struct{…}

Remove the directive.

Operation PhaseGetResponseObjectRulesSetCacheControlRuleActionParametersProxyRevalidateRemoveDirectiveOperation

The operation to perform on the cache-control directive.

One of the following:

const PhaseGetResponseObjectRulesSetCacheControlRuleActionParametersProxyRevalidateRemoveDirectiveOperationSet PhaseGetResponseObjectRulesSetCacheControlRuleActionParametersProxyRevalidateRemoveDirectiveOperation = "set"

const PhaseGetResponseObjectRulesSetCacheControlRuleActionParametersProxyRevalidateRemoveDirectiveOperationRemove PhaseGetResponseObjectRulesSetCacheControlRuleActionParametersProxyRevalidateRemoveDirectiveOperation = "remove"

CloudflareOnly boolOptional

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

Public PhaseGetResponseObjectRulesSetCacheControlRuleActionParametersPublicOptional

A cache-control directive configuration.

One of the following:

type PhaseGetResponseObjectRulesSetCacheControlRuleActionParametersPublicSetDirective struct{…}

Set the directive.

Operation PhaseGetResponseObjectRulesSetCacheControlRuleActionParametersPublicSetDirectiveOperation

The operation to perform on the cache-control directive.

One of the following:

const PhaseGetResponseObjectRulesSetCacheControlRuleActionParametersPublicSetDirectiveOperationSet PhaseGetResponseObjectRulesSetCacheControlRuleActionParametersPublicSetDirectiveOperation = "set"

const PhaseGetResponseObjectRulesSetCacheControlRuleActionParametersPublicSetDirectiveOperationRemove PhaseGetResponseObjectRulesSetCacheControlRuleActionParametersPublicSetDirectiveOperation = "remove"

CloudflareOnly boolOptional

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

type PhaseGetResponseObjectRulesSetCacheControlRuleActionParametersPublicRemoveDirective struct{…}

Remove the directive.

Operation PhaseGetResponseObjectRulesSetCacheControlRuleActionParametersPublicRemoveDirectiveOperation

The operation to perform on the cache-control directive.

One of the following:

const PhaseGetResponseObjectRulesSetCacheControlRuleActionParametersPublicRemoveDirectiveOperationSet PhaseGetResponseObjectRulesSetCacheControlRuleActionParametersPublicRemoveDirectiveOperation = "set"

const PhaseGetResponseObjectRulesSetCacheControlRuleActionParametersPublicRemoveDirectiveOperationRemove PhaseGetResponseObjectRulesSetCacheControlRuleActionParametersPublicRemoveDirectiveOperation = "remove"

CloudflareOnly boolOptional

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

SMaxage PhaseGetResponseObjectRulesSetCacheControlRuleActionParametersSMaxageOptional

A cache-control directive configuration that accepts a duration value in seconds.

One of the following:

type PhaseGetResponseObjectRulesSetCacheControlRuleActionParametersSMaxageSetDirective struct{…}

Set the directive with a duration value in seconds.

Operation PhaseGetResponseObjectRulesSetCacheControlRuleActionParametersSMaxageSetDirectiveOperation

The operation to perform on the cache-control directive.

One of the following:

const PhaseGetResponseObjectRulesSetCacheControlRuleActionParametersSMaxageSetDirectiveOperationSet PhaseGetResponseObjectRulesSetCacheControlRuleActionParametersSMaxageSetDirectiveOperation = "set"

const PhaseGetResponseObjectRulesSetCacheControlRuleActionParametersSMaxageSetDirectiveOperationRemove PhaseGetResponseObjectRulesSetCacheControlRuleActionParametersSMaxageSetDirectiveOperation = "remove"

Value int64

The duration value in seconds for the directive.

minimum0

CloudflareOnly boolOptional

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

type PhaseGetResponseObjectRulesSetCacheControlRuleActionParametersSMaxageRemoveDirective struct{…}

Remove the directive.

Operation PhaseGetResponseObjectRulesSetCacheControlRuleActionParametersSMaxageRemoveDirectiveOperation

The operation to perform on the cache-control directive.

One of the following:

const PhaseGetResponseObjectRulesSetCacheControlRuleActionParametersSMaxageRemoveDirectiveOperationSet PhaseGetResponseObjectRulesSetCacheControlRuleActionParametersSMaxageRemoveDirectiveOperation = "set"

const PhaseGetResponseObjectRulesSetCacheControlRuleActionParametersSMaxageRemoveDirectiveOperationRemove PhaseGetResponseObjectRulesSetCacheControlRuleActionParametersSMaxageRemoveDirectiveOperation = "remove"

CloudflareOnly boolOptional

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

StaleIfError PhaseGetResponseObjectRulesSetCacheControlRuleActionParametersStaleIfErrorOptional

A cache-control directive configuration that accepts a duration value in seconds.

One of the following:

type PhaseGetResponseObjectRulesSetCacheControlRuleActionParametersStaleIfErrorSetDirective struct{…}

Set the directive with a duration value in seconds.

Operation PhaseGetResponseObjectRulesSetCacheControlRuleActionParametersStaleIfErrorSetDirectiveOperation

The operation to perform on the cache-control directive.

One of the following:

const PhaseGetResponseObjectRulesSetCacheControlRuleActionParametersStaleIfErrorSetDirectiveOperationSet PhaseGetResponseObjectRulesSetCacheControlRuleActionParametersStaleIfErrorSetDirectiveOperation = "set"

const PhaseGetResponseObjectRulesSetCacheControlRuleActionParametersStaleIfErrorSetDirectiveOperationRemove PhaseGetResponseObjectRulesSetCacheControlRuleActionParametersStaleIfErrorSetDirectiveOperation = "remove"

Value int64

The duration value in seconds for the directive.

minimum0

CloudflareOnly boolOptional

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

type PhaseGetResponseObjectRulesSetCacheControlRuleActionParametersStaleIfErrorRemoveDirective struct{…}

Remove the directive.

Operation PhaseGetResponseObjectRulesSetCacheControlRuleActionParametersStaleIfErrorRemoveDirectiveOperation

The operation to perform on the cache-control directive.

One of the following:

const PhaseGetResponseObjectRulesSetCacheControlRuleActionParametersStaleIfErrorRemoveDirectiveOperationSet PhaseGetResponseObjectRulesSetCacheControlRuleActionParametersStaleIfErrorRemoveDirectiveOperation = "set"

const PhaseGetResponseObjectRulesSetCacheControlRuleActionParametersStaleIfErrorRemoveDirectiveOperationRemove PhaseGetResponseObjectRulesSetCacheControlRuleActionParametersStaleIfErrorRemoveDirectiveOperation = "remove"

CloudflareOnly boolOptional

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

StaleWhileRevalidate PhaseGetResponseObjectRulesSetCacheControlRuleActionParametersStaleWhileRevalidateOptional

A cache-control directive configuration that accepts a duration value in seconds.

One of the following:

type PhaseGetResponseObjectRulesSetCacheControlRuleActionParametersStaleWhileRevalidateSetDirective struct{…}

Set the directive with a duration value in seconds.

Operation PhaseGetResponseObjectRulesSetCacheControlRuleActionParametersStaleWhileRevalidateSetDirectiveOperation

The operation to perform on the cache-control directive.

One of the following:

const PhaseGetResponseObjectRulesSetCacheControlRuleActionParametersStaleWhileRevalidateSetDirectiveOperationSet PhaseGetResponseObjectRulesSetCacheControlRuleActionParametersStaleWhileRevalidateSetDirectiveOperation = "set"

const PhaseGetResponseObjectRulesSetCacheControlRuleActionParametersStaleWhileRevalidateSetDirectiveOperationRemove PhaseGetResponseObjectRulesSetCacheControlRuleActionParametersStaleWhileRevalidateSetDirectiveOperation = "remove"

Value int64

The duration value in seconds for the directive.

minimum0

CloudflareOnly boolOptional

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

type PhaseGetResponseObjectRulesSetCacheControlRuleActionParametersStaleWhileRevalidateRemoveDirective struct{…}

Remove the directive.

Operation PhaseGetResponseObjectRulesSetCacheControlRuleActionParametersStaleWhileRevalidateRemoveDirectiveOperation

The operation to perform on the cache-control directive.

One of the following:

const PhaseGetResponseObjectRulesSetCacheControlRuleActionParametersStaleWhileRevalidateRemoveDirectiveOperationSet PhaseGetResponseObjectRulesSetCacheControlRuleActionParametersStaleWhileRevalidateRemoveDirectiveOperation = "set"

const PhaseGetResponseObjectRulesSetCacheControlRuleActionParametersStaleWhileRevalidateRemoveDirectiveOperationRemove PhaseGetResponseObjectRulesSetCacheControlRuleActionParametersStaleWhileRevalidateRemoveDirectiveOperation = "remove"

CloudflareOnly boolOptional

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

Categories []stringOptional

The categories of the rule.

Description stringOptional

An informative description of the rule.

ExposedCredentialCheck PhaseGetResponseObjectRulesSetCacheControlRuleExposedCredentialCheckOptional

Configuration for exposed credential checking.

PasswordExpression string

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

minLength1

UsernameExpression string

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

minLength1

Logging LoggingOptional

An object configuring the rule’s logging behavior.

Enabled bool

Whether to generate a log when the rule matches.

Ratelimit PhaseGetResponseObjectRulesSetCacheControlRuleRatelimitOptional

An object configuring the rule’s rate limit behavior.

Characteristics []string

Characteristics of the request on which the rate limit counter will be incremented.

Period int64

Period in seconds over which the counter is being incremented.

minimum0

CountingExpression stringOptional

An expression that defines when the rate limit counter should be incremented. It defaults to the same as the rule’s expression.

minLength1

MitigationTimeout int64Optional

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

RequestsPerPeriod int64Optional

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

minimum1

RequestsToOrigin boolOptional

Whether counting is only performed when an origin is reached.

ScorePerPeriod int64Optional

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

ScoreResponseHeaderName stringOptional

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

minLength1

type PhaseGetResponseObjectRulesSetCacheSettingsRule struct{…}

ID string

Action string

Enabled bool

Expression string

Ref string

type PhaseGetResponseObjectRulesSetCacheTagsRule struct{…}

ID string

The unique ID of the rule.

Action PhaseGetResponseObjectRulesSetCacheTagsRuleAction

The action to perform when the rule matches.

Enabled bool

Expression string

The expression defining which traffic will match the rule.

minLength1

LastUpdated Time

The timestamp of when the rule was last modified.

formatdate-time

Ref string

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

minLength1

Version string

The version of the rule.

ActionParameters PhaseGetResponseObjectRulesSetCacheTagsRuleActionParametersOptional

The parameters configuring the rule’s action.

One of the following:

type PhaseGetResponseObjectRulesSetCacheTagsRuleActionParametersAddCacheTagsValues struct{…}

Add cache tags using a list of values.

Operation PhaseGetResponseObjectRulesSetCacheTagsRuleActionParametersAddCacheTagsValuesOperation

The operation to perform on the cache tags.

One of the following:

const PhaseGetResponseObjectRulesSetCacheTagsRuleActionParametersAddCacheTagsValuesOperationAdd PhaseGetResponseObjectRulesSetCacheTagsRuleActionParametersAddCacheTagsValuesOperation = "add"

const PhaseGetResponseObjectRulesSetCacheTagsRuleActionParametersAddCacheTagsValuesOperationRemove PhaseGetResponseObjectRulesSetCacheTagsRuleActionParametersAddCacheTagsValuesOperation = "remove"

const PhaseGetResponseObjectRulesSetCacheTagsRuleActionParametersAddCacheTagsValuesOperationSet PhaseGetResponseObjectRulesSetCacheTagsRuleActionParametersAddCacheTagsValuesOperation = "set"

Values []string

A list of cache tag values.

type PhaseGetResponseObjectRulesSetCacheTagsRuleActionParametersAddCacheTagsExpression struct{…}

Add cache tags using an expression.

Expression string

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

minLength1

Operation PhaseGetResponseObjectRulesSetCacheTagsRuleActionParametersAddCacheTagsExpressionOperation

The operation to perform on the cache tags.

One of the following:

const PhaseGetResponseObjectRulesSetCacheTagsRuleActionParametersAddCacheTagsExpressionOperationAdd PhaseGetResponseObjectRulesSetCacheTagsRuleActionParametersAddCacheTagsExpressionOperation = "add"

const PhaseGetResponseObjectRulesSetCacheTagsRuleActionParametersAddCacheTagsExpressionOperationRemove PhaseGetResponseObjectRulesSetCacheTagsRuleActionParametersAddCacheTagsExpressionOperation = "remove"

const PhaseGetResponseObjectRulesSetCacheTagsRuleActionParametersAddCacheTagsExpressionOperationSet PhaseGetResponseObjectRulesSetCacheTagsRuleActionParametersAddCacheTagsExpressionOperation = "set"

type PhaseGetResponseObjectRulesSetCacheTagsRuleActionParametersRemoveCacheTagsValues struct{…}

Remove cache tags using a list of values.

Operation PhaseGetResponseObjectRulesSetCacheTagsRuleActionParametersRemoveCacheTagsValuesOperation

The operation to perform on the cache tags.

One of the following:

const PhaseGetResponseObjectRulesSetCacheTagsRuleActionParametersRemoveCacheTagsValuesOperationAdd PhaseGetResponseObjectRulesSetCacheTagsRuleActionParametersRemoveCacheTagsValuesOperation = "add"

const PhaseGetResponseObjectRulesSetCacheTagsRuleActionParametersRemoveCacheTagsValuesOperationRemove PhaseGetResponseObjectRulesSetCacheTagsRuleActionParametersRemoveCacheTagsValuesOperation = "remove"

const PhaseGetResponseObjectRulesSetCacheTagsRuleActionParametersRemoveCacheTagsValuesOperationSet PhaseGetResponseObjectRulesSetCacheTagsRuleActionParametersRemoveCacheTagsValuesOperation = "set"

Values []string

A list of cache tag values.

type PhaseGetResponseObjectRulesSetCacheTagsRuleActionParametersRemoveCacheTagsExpression struct{…}

Remove cache tags using an expression.

Expression string

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

minLength1

Operation PhaseGetResponseObjectRulesSetCacheTagsRuleActionParametersRemoveCacheTagsExpressionOperation

The operation to perform on the cache tags.

One of the following:

const PhaseGetResponseObjectRulesSetCacheTagsRuleActionParametersRemoveCacheTagsExpressionOperationAdd PhaseGetResponseObjectRulesSetCacheTagsRuleActionParametersRemoveCacheTagsExpressionOperation = "add"

const PhaseGetResponseObjectRulesSetCacheTagsRuleActionParametersRemoveCacheTagsExpressionOperationRemove PhaseGetResponseObjectRulesSetCacheTagsRuleActionParametersRemoveCacheTagsExpressionOperation = "remove"

const PhaseGetResponseObjectRulesSetCacheTagsRuleActionParametersRemoveCacheTagsExpressionOperationSet PhaseGetResponseObjectRulesSetCacheTagsRuleActionParametersRemoveCacheTagsExpressionOperation = "set"

type PhaseGetResponseObjectRulesSetCacheTagsRuleActionParametersSetCacheTagsValues struct{…}

Set cache tags using a list of values.

Operation PhaseGetResponseObjectRulesSetCacheTagsRuleActionParametersSetCacheTagsValuesOperation

The operation to perform on the cache tags.

One of the following:

const PhaseGetResponseObjectRulesSetCacheTagsRuleActionParametersSetCacheTagsValuesOperationAdd PhaseGetResponseObjectRulesSetCacheTagsRuleActionParametersSetCacheTagsValuesOperation = "add"

const PhaseGetResponseObjectRulesSetCacheTagsRuleActionParametersSetCacheTagsValuesOperationRemove PhaseGetResponseObjectRulesSetCacheTagsRuleActionParametersSetCacheTagsValuesOperation = "remove"

const PhaseGetResponseObjectRulesSetCacheTagsRuleActionParametersSetCacheTagsValuesOperationSet PhaseGetResponseObjectRulesSetCacheTagsRuleActionParametersSetCacheTagsValuesOperation = "set"

Values []string

A list of cache tag values.

type PhaseGetResponseObjectRulesSetCacheTagsRuleActionParametersSetCacheTagsExpression struct{…}

Set cache tags using an expression.

Expression string

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

minLength1

Operation PhaseGetResponseObjectRulesSetCacheTagsRuleActionParametersSetCacheTagsExpressionOperation

The operation to perform on the cache tags.

One of the following:

const PhaseGetResponseObjectRulesSetCacheTagsRuleActionParametersSetCacheTagsExpressionOperationAdd PhaseGetResponseObjectRulesSetCacheTagsRuleActionParametersSetCacheTagsExpressionOperation = "add"

const PhaseGetResponseObjectRulesSetCacheTagsRuleActionParametersSetCacheTagsExpressionOperationRemove PhaseGetResponseObjectRulesSetCacheTagsRuleActionParametersSetCacheTagsExpressionOperation = "remove"

const PhaseGetResponseObjectRulesSetCacheTagsRuleActionParametersSetCacheTagsExpressionOperationSet PhaseGetResponseObjectRulesSetCacheTagsRuleActionParametersSetCacheTagsExpressionOperation = "set"

Categories []stringOptional

The categories of the rule.

Description stringOptional

An informative description of the rule.

ExposedCredentialCheck PhaseGetResponseObjectRulesSetCacheTagsRuleExposedCredentialCheckOptional

Configuration for exposed credential checking.

PasswordExpression string

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

minLength1

UsernameExpression string

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

minLength1

Logging LoggingOptional

An object configuring the rule’s logging behavior.

Enabled bool

Whether to generate a log when the rule matches.

Ratelimit PhaseGetResponseObjectRulesSetCacheTagsRuleRatelimitOptional

An object configuring the rule’s rate limit behavior.

Characteristics []string

Characteristics of the request on which the rate limit counter will be incremented.

Period int64

Period in seconds over which the counter is being incremented.

minimum0

CountingExpression stringOptional

An expression that defines when the rate limit counter should be incremented. It defaults to the same as the rule’s expression.

minLength1

MitigationTimeout int64Optional

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

RequestsPerPeriod int64Optional

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

minimum1

RequestsToOrigin boolOptional

Whether counting is only performed when an origin is reached.

ScorePerPeriod int64Optional

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

ScoreResponseHeaderName stringOptional

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

minLength1

type PhaseGetResponseObjectRulesSetConfigurationRule struct{…}

ID string

Action string

Enabled bool

Expression string

Ref string

type PhaseGetResponseObjectRulesSkipRule struct{…}

ID string

Action string

Enabled bool

Expression string

Ref string

type PhaseGetResponseObjectRulesTransformResponseHTMLRule struct{…}

ID string

The unique ID of the rule.

Action PhaseGetResponseObjectRulesTransformResponseHTMLRuleAction

The action to perform when the rule matches.

Enabled bool

Expression string

The expression defining which traffic will match the rule.

minLength1

LastUpdated Time

The timestamp of when the rule was last modified.

formatdate-time

Ref string

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

minLength1

Version string

The version of the rule.

ActionParameters PhaseGetResponseObjectRulesTransformResponseHTMLRuleActionParametersOptional

The parameters configuring the rule’s action.

LinkMaze unknown

Enables the link maze transformation on the response.

Categories []stringOptional

The categories of the rule.

Description stringOptional

An informative description of the rule.

ExposedCredentialCheck PhaseGetResponseObjectRulesTransformResponseHTMLRuleExposedCredentialCheckOptional

Configuration for exposed credential checking.

PasswordExpression string

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

minLength1

UsernameExpression string

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

minLength1

Logging LoggingOptional

An object configuring the rule’s logging behavior.

Enabled bool

Whether to generate a log when the rule matches.

Ratelimit PhaseGetResponseObjectRulesTransformResponseHTMLRuleRatelimitOptional

An object configuring the rule’s rate limit behavior.

Characteristics []string

Characteristics of the request on which the rate limit counter will be incremented.

Period int64

Period in seconds over which the counter is being incremented.

minimum0

CountingExpression stringOptional

An expression that defines when the rate limit counter should be incremented. It defaults to the same as the rule’s expression.

minLength1

MitigationTimeout int64Optional

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

RequestsPerPeriod int64Optional

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

minimum1

RequestsToOrigin boolOptional

Whether counting is only performed when an origin is reached.

ScorePerPeriod int64Optional

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

ScoreResponseHeaderName stringOptional

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

minLength1

Version stringOptional

The version of the ruleset.

type PhaseGetResponseObject struct{…}

ID stringOptional

The unique ID of the ruleset.

Description stringOptional

An informative description of the ruleset.

Kind KindOptional

The kind of the ruleset.

One of the following:

const KindManaged Kind = "managed"

const KindCustom Kind = "custom"

const KindRoot Kind = "root"

const KindZone Kind = "zone"

LastUpdated TimeOptional

The timestamp of when the ruleset was last modified.

formatdate-time

Name stringOptional

The human-readable name of the ruleset.

minLength1

Phase PhaseOptional

The phase of the ruleset.

One of the following:

const PhaseDDoSL4 Phase = "ddos_l4"

const PhaseDDoSL7 Phase = "ddos_l7"

const PhaseHTTPConfigSettings Phase = "http_config_settings"

const PhaseHTTPCustomErrors Phase = "http_custom_errors"

const PhaseHTTPLogCustomFields Phase = "http_log_custom_fields"

const PhaseHTTPRatelimit Phase = "http_ratelimit"

const PhaseHTTPRequestCacheSettings Phase = "http_request_cache_settings"

const PhaseHTTPRequestDynamicRedirect Phase = "http_request_dynamic_redirect"

const PhaseHTTPRequestFirewallCustom Phase = "http_request_firewall_custom"

const PhaseHTTPRequestFirewallManaged Phase = "http_request_firewall_managed"

const PhaseHTTPRequestLateTransform Phase = "http_request_late_transform"

const PhaseHTTPRequestOrigin Phase = "http_request_origin"

const PhaseHTTPRequestRedirect Phase = "http_request_redirect"

const PhaseHTTPRequestSanitize Phase = "http_request_sanitize"

const PhaseHTTPRequestSBFM Phase = "http_request_sbfm"

const PhaseHTTPRequestTransform Phase = "http_request_transform"

const PhaseHTTPResponseCacheSettings Phase = "http_response_cache_settings"

const PhaseHTTPResponseCompression Phase = "http_response_compression"

const PhaseHTTPResponseFirewallCustom Phase = "http_response_firewall_custom"

const PhaseHTTPResponseFirewallManaged Phase = "http_response_firewall_managed"

const PhaseHTTPResponseHeadersTransform Phase = "http_response_headers_transform"

const PhaseMagicTransit Phase = "magic_transit"

const PhaseMagicTransitIDsManaged Phase = "magic_transit_ids_managed"

const PhaseMagicTransitManaged Phase = "magic_transit_managed"

const PhaseMagicTransitRatelimit Phase = "magic_transit_ratelimit"

Rules []PhaseGetResponseObjectRuleOptional

The list of rules in the ruleset.

One of the following:

type PhaseGetResponseObjectRulesBlockRule struct{…}

ID string

Action string

Enabled bool

Expression string

Ref string

type PhaseGetResponseObjectRulesChallengeRule struct{…}

ID string

The unique ID of the rule.

Action PhaseGetResponseObjectRulesChallengeRuleAction

The action to perform when the rule matches.

Enabled bool

Whether the rule should be executed.

Expression string

The expression defining which traffic will match the rule.

minLength1

LastUpdated Time

The timestamp of when the rule was last modified.

formatdate-time

Ref string

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

minLength1

Version string

The version of the rule.

ActionParameters unknownOptional

The parameters configuring the rule’s action.

Categories []stringOptional

The categories of the rule.

Description stringOptional

An informative description of the rule.

ExposedCredentialCheck PhaseGetResponseObjectRulesChallengeRuleExposedCredentialCheckOptional

Configuration for exposed credential checking.

PasswordExpression string

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

minLength1

UsernameExpression string

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

minLength1

Logging LoggingOptional

An object configuring the rule’s logging behavior.

Enabled bool

Whether to generate a log when the rule matches.

Ratelimit PhaseGetResponseObjectRulesChallengeRuleRatelimitOptional

An object configuring the rule’s rate limit behavior.

Characteristics []string

Characteristics of the request on which the rate limit counter will be incremented.

Period int64

Period in seconds over which the counter is being incremented.

minimum0

CountingExpression stringOptional

An expression that defines when the rate limit counter should be incremented. It defaults to the same as the rule’s expression.

minLength1

MitigationTimeout int64Optional

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

RequestsPerPeriod int64Optional

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

minimum1

RequestsToOrigin boolOptional

Whether counting is only performed when an origin is reached.

ScorePerPeriod int64Optional

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

ScoreResponseHeaderName stringOptional

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

minLength1

type PhaseGetResponseObjectRulesResponseCompressionRule struct{…}

ID string

Action string

Enabled bool

Expression string

Ref string

type PhaseGetResponseObjectRulesDDoSDynamicRule struct{…}

ID string

Action string

Enabled bool

Expression string

Ref string

type PhaseGetResponseObjectRulesExecuteRule struct{…}

ID string

Action string

Enabled bool

Expression string

Ref string

type PhaseGetResponseObjectRulesForceConnectionCloseRule struct{…}

ID string

Action string

Enabled bool

Expression string

Ref string

type PhaseGetResponseObjectRulesJavaScriptChallengeRule struct{…}

ID string

The unique ID of the rule.

Action PhaseGetResponseObjectRulesJavaScriptChallengeRuleAction

The action to perform when the rule matches.

Enabled bool

Whether the rule should be executed.

Expression string

The expression defining which traffic will match the rule.

minLength1

LastUpdated Time

The timestamp of when the rule was last modified.

formatdate-time

Ref string

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

minLength1

Version string

The version of the rule.

ActionParameters unknownOptional

The parameters configuring the rule’s action.

Categories []stringOptional

The categories of the rule.

Description stringOptional

An informative description of the rule.

ExposedCredentialCheck PhaseGetResponseObjectRulesJavaScriptChallengeRuleExposedCredentialCheckOptional

Configuration for exposed credential checking.

PasswordExpression string

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

minLength1

UsernameExpression string

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

minLength1

Logging LoggingOptional

An object configuring the rule’s logging behavior.

Enabled bool

Whether to generate a log when the rule matches.

Ratelimit PhaseGetResponseObjectRulesJavaScriptChallengeRuleRatelimitOptional

An object configuring the rule’s rate limit behavior.

Characteristics []string

Characteristics of the request on which the rate limit counter will be incremented.

Period int64

Period in seconds over which the counter is being incremented.

minimum0

CountingExpression stringOptional

An expression that defines when the rate limit counter should be incremented. It defaults to the same as the rule’s expression.

minLength1

MitigationTimeout int64Optional

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

RequestsPerPeriod int64Optional

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

minimum1

RequestsToOrigin boolOptional

Whether counting is only performed when an origin is reached.

ScorePerPeriod int64Optional

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

ScoreResponseHeaderName stringOptional

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

minLength1

type PhaseGetResponseObjectRulesLogRule struct{…}

ID string

Action string

Enabled bool

Expression string

Ref string

type PhaseGetResponseObjectRulesLogCustomFieldRule struct{…}

ID string

Action string

Enabled bool

Expression string

Ref string

type PhaseGetResponseObjectRulesManagedChallengeRule struct{…}

ID string

Action string

Enabled bool

Expression string

Ref string

type PhaseGetResponseObjectRulesRedirectRule struct{…}

ID string

Action string

Enabled bool

Expression string

Ref string

type PhaseGetResponseObjectRulesRewriteRule struct{…}

ID string

Action string

Enabled bool

Expression string

Ref string

type PhaseGetResponseObjectRulesRouteRule struct{…}

ID string

Action string

Enabled bool

Expression string

Ref string

type PhaseGetResponseObjectRulesScoreRule struct{…}

ID string

Action string

Enabled bool

Expression string

Ref string

type PhaseGetResponseObjectRulesServeErrorRule struct{…}

ID string

Action string

Enabled bool

Expression string

Ref string

type PhaseGetResponseObjectRulesSetCacheControlRule struct{…}

ID string

The unique ID of the rule.

Action PhaseGetResponseObjectRulesSetCacheControlRuleAction

The action to perform when the rule matches.

Enabled bool

Expression string

The expression defining which traffic will match the rule.

minLength1

LastUpdated Time

The timestamp of when the rule was last modified.

formatdate-time

Ref string

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

minLength1

Version string

The version of the rule.

ActionParameters PhaseGetResponseObjectRulesSetCacheControlRuleActionParametersOptional

The parameters configuring the rule’s action.

Immutable PhaseGetResponseObjectRulesSetCacheControlRuleActionParametersImmutableOptional

A cache-control directive configuration.

One of the following:

type PhaseGetResponseObjectRulesSetCacheControlRuleActionParametersImmutableSetDirective struct{…}

Set the directive.

Operation PhaseGetResponseObjectRulesSetCacheControlRuleActionParametersImmutableSetDirectiveOperation

The operation to perform on the cache-control directive.

One of the following:

const PhaseGetResponseObjectRulesSetCacheControlRuleActionParametersImmutableSetDirectiveOperationSet PhaseGetResponseObjectRulesSetCacheControlRuleActionParametersImmutableSetDirectiveOperation = "set"

const PhaseGetResponseObjectRulesSetCacheControlRuleActionParametersImmutableSetDirectiveOperationRemove PhaseGetResponseObjectRulesSetCacheControlRuleActionParametersImmutableSetDirectiveOperation = "remove"

CloudflareOnly boolOptional

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

type PhaseGetResponseObjectRulesSetCacheControlRuleActionParametersImmutableRemoveDirective struct{…}

Remove the directive.

Operation PhaseGetResponseObjectRulesSetCacheControlRuleActionParametersImmutableRemoveDirectiveOperation

The operation to perform on the cache-control directive.

One of the following:

const PhaseGetResponseObjectRulesSetCacheControlRuleActionParametersImmutableRemoveDirectiveOperationSet PhaseGetResponseObjectRulesSetCacheControlRuleActionParametersImmutableRemoveDirectiveOperation = "set"

const PhaseGetResponseObjectRulesSetCacheControlRuleActionParametersImmutableRemoveDirectiveOperationRemove PhaseGetResponseObjectRulesSetCacheControlRuleActionParametersImmutableRemoveDirectiveOperation = "remove"

CloudflareOnly boolOptional

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

MaxAge PhaseGetResponseObjectRulesSetCacheControlRuleActionParametersMaxAgeOptional

A cache-control directive configuration that accepts a duration value in seconds.

One of the following:

type PhaseGetResponseObjectRulesSetCacheControlRuleActionParametersMaxAgeSetDirective struct{…}

Set the directive with a duration value in seconds.

Operation PhaseGetResponseObjectRulesSetCacheControlRuleActionParametersMaxAgeSetDirectiveOperation

The operation to perform on the cache-control directive.

One of the following:

const PhaseGetResponseObjectRulesSetCacheControlRuleActionParametersMaxAgeSetDirectiveOperationSet PhaseGetResponseObjectRulesSetCacheControlRuleActionParametersMaxAgeSetDirectiveOperation = "set"

const PhaseGetResponseObjectRulesSetCacheControlRuleActionParametersMaxAgeSetDirectiveOperationRemove PhaseGetResponseObjectRulesSetCacheControlRuleActionParametersMaxAgeSetDirectiveOperation = "remove"

Value int64

The duration value in seconds for the directive.

minimum0

CloudflareOnly boolOptional

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

type PhaseGetResponseObjectRulesSetCacheControlRuleActionParametersMaxAgeRemoveDirective struct{…}

Remove the directive.

Operation PhaseGetResponseObjectRulesSetCacheControlRuleActionParametersMaxAgeRemoveDirectiveOperation

The operation to perform on the cache-control directive.

One of the following:

const PhaseGetResponseObjectRulesSetCacheControlRuleActionParametersMaxAgeRemoveDirectiveOperationSet PhaseGetResponseObjectRulesSetCacheControlRuleActionParametersMaxAgeRemoveDirectiveOperation = "set"

const PhaseGetResponseObjectRulesSetCacheControlRuleActionParametersMaxAgeRemoveDirectiveOperationRemove PhaseGetResponseObjectRulesSetCacheControlRuleActionParametersMaxAgeRemoveDirectiveOperation = "remove"

CloudflareOnly boolOptional

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

MustRevalidate PhaseGetResponseObjectRulesSetCacheControlRuleActionParametersMustRevalidateOptional

A cache-control directive configuration.

One of the following:

type PhaseGetResponseObjectRulesSetCacheControlRuleActionParametersMustRevalidateSetDirective struct{…}

Set the directive.

Operation PhaseGetResponseObjectRulesSetCacheControlRuleActionParametersMustRevalidateSetDirectiveOperation

The operation to perform on the cache-control directive.

One of the following:

const PhaseGetResponseObjectRulesSetCacheControlRuleActionParametersMustRevalidateSetDirectiveOperationSet PhaseGetResponseObjectRulesSetCacheControlRuleActionParametersMustRevalidateSetDirectiveOperation = "set"

const PhaseGetResponseObjectRulesSetCacheControlRuleActionParametersMustRevalidateSetDirectiveOperationRemove PhaseGetResponseObjectRulesSetCacheControlRuleActionParametersMustRevalidateSetDirectiveOperation = "remove"

CloudflareOnly boolOptional

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

type PhaseGetResponseObjectRulesSetCacheControlRuleActionParametersMustRevalidateRemoveDirective struct{…}

Remove the directive.

Operation PhaseGetResponseObjectRulesSetCacheControlRuleActionParametersMustRevalidateRemoveDirectiveOperation

The operation to perform on the cache-control directive.

One of the following:

const PhaseGetResponseObjectRulesSetCacheControlRuleActionParametersMustRevalidateRemoveDirectiveOperationSet PhaseGetResponseObjectRulesSetCacheControlRuleActionParametersMustRevalidateRemoveDirectiveOperation = "set"

const PhaseGetResponseObjectRulesSetCacheControlRuleActionParametersMustRevalidateRemoveDirectiveOperationRemove PhaseGetResponseObjectRulesSetCacheControlRuleActionParametersMustRevalidateRemoveDirectiveOperation = "remove"

CloudflareOnly boolOptional

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

MustUnderstand PhaseGetResponseObjectRulesSetCacheControlRuleActionParametersMustUnderstandOptional

A cache-control directive configuration.

One of the following:

type PhaseGetResponseObjectRulesSetCacheControlRuleActionParametersMustUnderstandSetDirective struct{…}

Set the directive.

Operation PhaseGetResponseObjectRulesSetCacheControlRuleActionParametersMustUnderstandSetDirectiveOperation

The operation to perform on the cache-control directive.

One of the following:

const PhaseGetResponseObjectRulesSetCacheControlRuleActionParametersMustUnderstandSetDirectiveOperationSet PhaseGetResponseObjectRulesSetCacheControlRuleActionParametersMustUnderstandSetDirectiveOperation = "set"

const PhaseGetResponseObjectRulesSetCacheControlRuleActionParametersMustUnderstandSetDirectiveOperationRemove PhaseGetResponseObjectRulesSetCacheControlRuleActionParametersMustUnderstandSetDirectiveOperation = "remove"

CloudflareOnly boolOptional

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

type PhaseGetResponseObjectRulesSetCacheControlRuleActionParametersMustUnderstandRemoveDirective struct{…}

Remove the directive.

Operation PhaseGetResponseObjectRulesSetCacheControlRuleActionParametersMustUnderstandRemoveDirectiveOperation

The operation to perform on the cache-control directive.

One of the following:

const PhaseGetResponseObjectRulesSetCacheControlRuleActionParametersMustUnderstandRemoveDirectiveOperationSet PhaseGetResponseObjectRulesSetCacheControlRuleActionParametersMustUnderstandRemoveDirectiveOperation = "set"

const PhaseGetResponseObjectRulesSetCacheControlRuleActionParametersMustUnderstandRemoveDirectiveOperationRemove PhaseGetResponseObjectRulesSetCacheControlRuleActionParametersMustUnderstandRemoveDirectiveOperation = "remove"

CloudflareOnly boolOptional

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

NoCache PhaseGetResponseObjectRulesSetCacheControlRuleActionParametersNoCacheOptional

A cache-control directive configuration that accepts optional qualifiers (header names).

One of the following:

type PhaseGetResponseObjectRulesSetCacheControlRuleActionParametersNoCacheSetDirective struct{…}

Set the directive with optional qualifiers.

Operation PhaseGetResponseObjectRulesSetCacheControlRuleActionParametersNoCacheSetDirectiveOperation

The operation to perform on the cache-control directive.

One of the following:

const PhaseGetResponseObjectRulesSetCacheControlRuleActionParametersNoCacheSetDirectiveOperationSet PhaseGetResponseObjectRulesSetCacheControlRuleActionParametersNoCacheSetDirectiveOperation = "set"

const PhaseGetResponseObjectRulesSetCacheControlRuleActionParametersNoCacheSetDirectiveOperationRemove PhaseGetResponseObjectRulesSetCacheControlRuleActionParametersNoCacheSetDirectiveOperation = "remove"

CloudflareOnly boolOptional

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

Qualifiers []stringOptional

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

type PhaseGetResponseObjectRulesSetCacheControlRuleActionParametersNoCacheRemoveDirective struct{…}

Remove the directive.

Operation PhaseGetResponseObjectRulesSetCacheControlRuleActionParametersNoCacheRemoveDirectiveOperation

The operation to perform on the cache-control directive.

One of the following:

const PhaseGetResponseObjectRulesSetCacheControlRuleActionParametersNoCacheRemoveDirectiveOperationSet PhaseGetResponseObjectRulesSetCacheControlRuleActionParametersNoCacheRemoveDirectiveOperation = "set"

const PhaseGetResponseObjectRulesSetCacheControlRuleActionParametersNoCacheRemoveDirectiveOperationRemove PhaseGetResponseObjectRulesSetCacheControlRuleActionParametersNoCacheRemoveDirectiveOperation = "remove"

CloudflareOnly boolOptional

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

NoStore PhaseGetResponseObjectRulesSetCacheControlRuleActionParametersNoStoreOptional

A cache-control directive configuration.

One of the following:

type PhaseGetResponseObjectRulesSetCacheControlRuleActionParametersNoStoreSetDirective struct{…}

Set the directive.

Operation PhaseGetResponseObjectRulesSetCacheControlRuleActionParametersNoStoreSetDirectiveOperation

The operation to perform on the cache-control directive.

One of the following:

const PhaseGetResponseObjectRulesSetCacheControlRuleActionParametersNoStoreSetDirectiveOperationSet PhaseGetResponseObjectRulesSetCacheControlRuleActionParametersNoStoreSetDirectiveOperation = "set"

const PhaseGetResponseObjectRulesSetCacheControlRuleActionParametersNoStoreSetDirectiveOperationRemove PhaseGetResponseObjectRulesSetCacheControlRuleActionParametersNoStoreSetDirectiveOperation = "remove"

CloudflareOnly boolOptional

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

type PhaseGetResponseObjectRulesSetCacheControlRuleActionParametersNoStoreRemoveDirective struct{…}

Remove the directive.

Operation PhaseGetResponseObjectRulesSetCacheControlRuleActionParametersNoStoreRemoveDirectiveOperation

The operation to perform on the cache-control directive.

One of the following:

const PhaseGetResponseObjectRulesSetCacheControlRuleActionParametersNoStoreRemoveDirectiveOperationSet PhaseGetResponseObjectRulesSetCacheControlRuleActionParametersNoStoreRemoveDirectiveOperation = "set"

const PhaseGetResponseObjectRulesSetCacheControlRuleActionParametersNoStoreRemoveDirectiveOperationRemove PhaseGetResponseObjectRulesSetCacheControlRuleActionParametersNoStoreRemoveDirectiveOperation = "remove"

CloudflareOnly boolOptional

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

NoTransform PhaseGetResponseObjectRulesSetCacheControlRuleActionParametersNoTransformOptional

A cache-control directive configuration.

One of the following:

type PhaseGetResponseObjectRulesSetCacheControlRuleActionParametersNoTransformSetDirective struct{…}

Set the directive.

Operation PhaseGetResponseObjectRulesSetCacheControlRuleActionParametersNoTransformSetDirectiveOperation

The operation to perform on the cache-control directive.

One of the following:

const PhaseGetResponseObjectRulesSetCacheControlRuleActionParametersNoTransformSetDirectiveOperationSet PhaseGetResponseObjectRulesSetCacheControlRuleActionParametersNoTransformSetDirectiveOperation = "set"

const PhaseGetResponseObjectRulesSetCacheControlRuleActionParametersNoTransformSetDirectiveOperationRemove PhaseGetResponseObjectRulesSetCacheControlRuleActionParametersNoTransformSetDirectiveOperation = "remove"

CloudflareOnly boolOptional

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

type PhaseGetResponseObjectRulesSetCacheControlRuleActionParametersNoTransformRemoveDirective struct{…}

Remove the directive.

Operation PhaseGetResponseObjectRulesSetCacheControlRuleActionParametersNoTransformRemoveDirectiveOperation

The operation to perform on the cache-control directive.

One of the following:

const PhaseGetResponseObjectRulesSetCacheControlRuleActionParametersNoTransformRemoveDirectiveOperationSet PhaseGetResponseObjectRulesSetCacheControlRuleActionParametersNoTransformRemoveDirectiveOperation = "set"

const PhaseGetResponseObjectRulesSetCacheControlRuleActionParametersNoTransformRemoveDirectiveOperationRemove PhaseGetResponseObjectRulesSetCacheControlRuleActionParametersNoTransformRemoveDirectiveOperation = "remove"

CloudflareOnly boolOptional

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

Private PhaseGetResponseObjectRulesSetCacheControlRuleActionParametersPrivateOptional

A cache-control directive configuration that accepts optional qualifiers (header names).

One of the following:

type PhaseGetResponseObjectRulesSetCacheControlRuleActionParametersPrivateSetDirective struct{…}

Set the directive with optional qualifiers.

Operation PhaseGetResponseObjectRulesSetCacheControlRuleActionParametersPrivateSetDirectiveOperation

The operation to perform on the cache-control directive.

One of the following:

const PhaseGetResponseObjectRulesSetCacheControlRuleActionParametersPrivateSetDirectiveOperationSet PhaseGetResponseObjectRulesSetCacheControlRuleActionParametersPrivateSetDirectiveOperation = "set"

const PhaseGetResponseObjectRulesSetCacheControlRuleActionParametersPrivateSetDirectiveOperationRemove PhaseGetResponseObjectRulesSetCacheControlRuleActionParametersPrivateSetDirectiveOperation = "remove"

CloudflareOnly boolOptional

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

Qualifiers []stringOptional

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

type PhaseGetResponseObjectRulesSetCacheControlRuleActionParametersPrivateRemoveDirective struct{…}

Remove the directive.

Operation PhaseGetResponseObjectRulesSetCacheControlRuleActionParametersPrivateRemoveDirectiveOperation

The operation to perform on the cache-control directive.

One of the following:

const PhaseGetResponseObjectRulesSetCacheControlRuleActionParametersPrivateRemoveDirectiveOperationSet PhaseGetResponseObjectRulesSetCacheControlRuleActionParametersPrivateRemoveDirectiveOperation = "set"

const PhaseGetResponseObjectRulesSetCacheControlRuleActionParametersPrivateRemoveDirectiveOperationRemove PhaseGetResponseObjectRulesSetCacheControlRuleActionParametersPrivateRemoveDirectiveOperation = "remove"

CloudflareOnly boolOptional

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

ProxyRevalidate PhaseGetResponseObjectRulesSetCacheControlRuleActionParametersProxyRevalidateOptional

A cache-control directive configuration.

One of the following:

type PhaseGetResponseObjectRulesSetCacheControlRuleActionParametersProxyRevalidateSetDirective struct{…}

Set the directive.

Operation PhaseGetResponseObjectRulesSetCacheControlRuleActionParametersProxyRevalidateSetDirectiveOperation

The operation to perform on the cache-control directive.

One of the following:

const PhaseGetResponseObjectRulesSetCacheControlRuleActionParametersProxyRevalidateSetDirectiveOperationSet PhaseGetResponseObjectRulesSetCacheControlRuleActionParametersProxyRevalidateSetDirectiveOperation = "set"

const PhaseGetResponseObjectRulesSetCacheControlRuleActionParametersProxyRevalidateSetDirectiveOperationRemove PhaseGetResponseObjectRulesSetCacheControlRuleActionParametersProxyRevalidateSetDirectiveOperation = "remove"

CloudflareOnly boolOptional

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

type PhaseGetResponseObjectRulesSetCacheControlRuleActionParametersProxyRevalidateRemoveDirective struct{…}

Remove the directive.

Operation PhaseGetResponseObjectRulesSetCacheControlRuleActionParametersProxyRevalidateRemoveDirectiveOperation

The operation to perform on the cache-control directive.

One of the following:

const PhaseGetResponseObjectRulesSetCacheControlRuleActionParametersProxyRevalidateRemoveDirectiveOperationSet PhaseGetResponseObjectRulesSetCacheControlRuleActionParametersProxyRevalidateRemoveDirectiveOperation = "set"

const PhaseGetResponseObjectRulesSetCacheControlRuleActionParametersProxyRevalidateRemoveDirectiveOperationRemove PhaseGetResponseObjectRulesSetCacheControlRuleActionParametersProxyRevalidateRemoveDirectiveOperation = "remove"

CloudflareOnly boolOptional

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

Public PhaseGetResponseObjectRulesSetCacheControlRuleActionParametersPublicOptional

A cache-control directive configuration.

One of the following:

type PhaseGetResponseObjectRulesSetCacheControlRuleActionParametersPublicSetDirective struct{…}

Set the directive.

Operation PhaseGetResponseObjectRulesSetCacheControlRuleActionParametersPublicSetDirectiveOperation

The operation to perform on the cache-control directive.

One of the following:

const PhaseGetResponseObjectRulesSetCacheControlRuleActionParametersPublicSetDirectiveOperationSet PhaseGetResponseObjectRulesSetCacheControlRuleActionParametersPublicSetDirectiveOperation = "set"

const PhaseGetResponseObjectRulesSetCacheControlRuleActionParametersPublicSetDirectiveOperationRemove PhaseGetResponseObjectRulesSetCacheControlRuleActionParametersPublicSetDirectiveOperation = "remove"

CloudflareOnly boolOptional

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

type PhaseGetResponseObjectRulesSetCacheControlRuleActionParametersPublicRemoveDirective struct{…}

Remove the directive.

Operation PhaseGetResponseObjectRulesSetCacheControlRuleActionParametersPublicRemoveDirectiveOperation

The operation to perform on the cache-control directive.

One of the following:

const PhaseGetResponseObjectRulesSetCacheControlRuleActionParametersPublicRemoveDirectiveOperationSet PhaseGetResponseObjectRulesSetCacheControlRuleActionParametersPublicRemoveDirectiveOperation = "set"

const PhaseGetResponseObjectRulesSetCacheControlRuleActionParametersPublicRemoveDirectiveOperationRemove PhaseGetResponseObjectRulesSetCacheControlRuleActionParametersPublicRemoveDirectiveOperation = "remove"

CloudflareOnly boolOptional

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

SMaxage PhaseGetResponseObjectRulesSetCacheControlRuleActionParametersSMaxageOptional

A cache-control directive configuration that accepts a duration value in seconds.

One of the following:

type PhaseGetResponseObjectRulesSetCacheControlRuleActionParametersSMaxageSetDirective struct{…}

Set the directive with a duration value in seconds.

Operation PhaseGetResponseObjectRulesSetCacheControlRuleActionParametersSMaxageSetDirectiveOperation

The operation to perform on the cache-control directive.

One of the following:

const PhaseGetResponseObjectRulesSetCacheControlRuleActionParametersSMaxageSetDirectiveOperationSet PhaseGetResponseObjectRulesSetCacheControlRuleActionParametersSMaxageSetDirectiveOperation = "set"

const PhaseGetResponseObjectRulesSetCacheControlRuleActionParametersSMaxageSetDirectiveOperationRemove PhaseGetResponseObjectRulesSetCacheControlRuleActionParametersSMaxageSetDirectiveOperation = "remove"

Value int64

The duration value in seconds for the directive.

minimum0

CloudflareOnly boolOptional

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

type PhaseGetResponseObjectRulesSetCacheControlRuleActionParametersSMaxageRemoveDirective struct{…}

Remove the directive.

Operation PhaseGetResponseObjectRulesSetCacheControlRuleActionParametersSMaxageRemoveDirectiveOperation

The operation to perform on the cache-control directive.

One of the following:

const PhaseGetResponseObjectRulesSetCacheControlRuleActionParametersSMaxageRemoveDirectiveOperationSet PhaseGetResponseObjectRulesSetCacheControlRuleActionParametersSMaxageRemoveDirectiveOperation = "set"

const PhaseGetResponseObjectRulesSetCacheControlRuleActionParametersSMaxageRemoveDirectiveOperationRemove PhaseGetResponseObjectRulesSetCacheControlRuleActionParametersSMaxageRemoveDirectiveOperation = "remove"

CloudflareOnly boolOptional

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

StaleIfError PhaseGetResponseObjectRulesSetCacheControlRuleActionParametersStaleIfErrorOptional

A cache-control directive configuration that accepts a duration value in seconds.

One of the following:

type PhaseGetResponseObjectRulesSetCacheControlRuleActionParametersStaleIfErrorSetDirective struct{…}

Set the directive with a duration value in seconds.

Operation PhaseGetResponseObjectRulesSetCacheControlRuleActionParametersStaleIfErrorSetDirectiveOperation

The operation to perform on the cache-control directive.

One of the following:

const PhaseGetResponseObjectRulesSetCacheControlRuleActionParametersStaleIfErrorSetDirectiveOperationSet PhaseGetResponseObjectRulesSetCacheControlRuleActionParametersStaleIfErrorSetDirectiveOperation = "set"

const PhaseGetResponseObjectRulesSetCacheControlRuleActionParametersStaleIfErrorSetDirectiveOperationRemove PhaseGetResponseObjectRulesSetCacheControlRuleActionParametersStaleIfErrorSetDirectiveOperation = "remove"

Value int64

The duration value in seconds for the directive.

minimum0

CloudflareOnly boolOptional

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

type PhaseGetResponseObjectRulesSetCacheControlRuleActionParametersStaleIfErrorRemoveDirective struct{…}

Remove the directive.

Operation PhaseGetResponseObjectRulesSetCacheControlRuleActionParametersStaleIfErrorRemoveDirectiveOperation

The operation to perform on the cache-control directive.

One of the following:

const PhaseGetResponseObjectRulesSetCacheControlRuleActionParametersStaleIfErrorRemoveDirectiveOperationSet PhaseGetResponseObjectRulesSetCacheControlRuleActionParametersStaleIfErrorRemoveDirectiveOperation = "set"

const PhaseGetResponseObjectRulesSetCacheControlRuleActionParametersStaleIfErrorRemoveDirectiveOperationRemove PhaseGetResponseObjectRulesSetCacheControlRuleActionParametersStaleIfErrorRemoveDirectiveOperation = "remove"

CloudflareOnly boolOptional

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

StaleWhileRevalidate PhaseGetResponseObjectRulesSetCacheControlRuleActionParametersStaleWhileRevalidateOptional

A cache-control directive configuration that accepts a duration value in seconds.

One of the following:

type PhaseGetResponseObjectRulesSetCacheControlRuleActionParametersStaleWhileRevalidateSetDirective struct{…}

Set the directive with a duration value in seconds.

Operation PhaseGetResponseObjectRulesSetCacheControlRuleActionParametersStaleWhileRevalidateSetDirectiveOperation

The operation to perform on the cache-control directive.

One of the following:

const PhaseGetResponseObjectRulesSetCacheControlRuleActionParametersStaleWhileRevalidateSetDirectiveOperationSet PhaseGetResponseObjectRulesSetCacheControlRuleActionParametersStaleWhileRevalidateSetDirectiveOperation = "set"

const PhaseGetResponseObjectRulesSetCacheControlRuleActionParametersStaleWhileRevalidateSetDirectiveOperationRemove PhaseGetResponseObjectRulesSetCacheControlRuleActionParametersStaleWhileRevalidateSetDirectiveOperation = "remove"

Value int64

The duration value in seconds for the directive.

minimum0

CloudflareOnly boolOptional

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

type PhaseGetResponseObjectRulesSetCacheControlRuleActionParametersStaleWhileRevalidateRemoveDirective struct{…}

Remove the directive.

Operation PhaseGetResponseObjectRulesSetCacheControlRuleActionParametersStaleWhileRevalidateRemoveDirectiveOperation

The operation to perform on the cache-control directive.

One of the following:

const PhaseGetResponseObjectRulesSetCacheControlRuleActionParametersStaleWhileRevalidateRemoveDirectiveOperationSet PhaseGetResponseObjectRulesSetCacheControlRuleActionParametersStaleWhileRevalidateRemoveDirectiveOperation = "set"

const PhaseGetResponseObjectRulesSetCacheControlRuleActionParametersStaleWhileRevalidateRemoveDirectiveOperationRemove PhaseGetResponseObjectRulesSetCacheControlRuleActionParametersStaleWhileRevalidateRemoveDirectiveOperation = "remove"

CloudflareOnly boolOptional

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

Categories []stringOptional

The categories of the rule.

Description stringOptional

An informative description of the rule.

ExposedCredentialCheck PhaseGetResponseObjectRulesSetCacheControlRuleExposedCredentialCheckOptional

Configuration for exposed credential checking.

PasswordExpression string

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

minLength1

UsernameExpression string

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

minLength1

Logging LoggingOptional

An object configuring the rule’s logging behavior.

Enabled bool

Whether to generate a log when the rule matches.

Ratelimit PhaseGetResponseObjectRulesSetCacheControlRuleRatelimitOptional

An object configuring the rule’s rate limit behavior.

Characteristics []string

Characteristics of the request on which the rate limit counter will be incremented.

Period int64

Period in seconds over which the counter is being incremented.

minimum0

CountingExpression stringOptional

An expression that defines when the rate limit counter should be incremented. It defaults to the same as the rule’s expression.

minLength1

MitigationTimeout int64Optional

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

RequestsPerPeriod int64Optional

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

minimum1

RequestsToOrigin boolOptional

Whether counting is only performed when an origin is reached.

ScorePerPeriod int64Optional

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

ScoreResponseHeaderName stringOptional

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

minLength1

type PhaseGetResponseObjectRulesSetCacheSettingsRule struct{…}

ID string

Action string

Enabled bool

Expression string

Ref string

type PhaseGetResponseObjectRulesSetCacheTagsRule struct{…}

ID string

The unique ID of the rule.

Action PhaseGetResponseObjectRulesSetCacheTagsRuleAction

The action to perform when the rule matches.

Enabled bool

Expression string

The expression defining which traffic will match the rule.

minLength1

LastUpdated Time

The timestamp of when the rule was last modified.

formatdate-time

Ref string

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

minLength1

Version string

The version of the rule.

ActionParameters PhaseGetResponseObjectRulesSetCacheTagsRuleActionParametersOptional

The parameters configuring the rule’s action.

One of the following:

type PhaseGetResponseObjectRulesSetCacheTagsRuleActionParametersAddCacheTagsValues struct{…}

Add cache tags using a list of values.

Operation PhaseGetResponseObjectRulesSetCacheTagsRuleActionParametersAddCacheTagsValuesOperation

The operation to perform on the cache tags.

One of the following:

const PhaseGetResponseObjectRulesSetCacheTagsRuleActionParametersAddCacheTagsValuesOperationAdd PhaseGetResponseObjectRulesSetCacheTagsRuleActionParametersAddCacheTagsValuesOperation = "add"

const PhaseGetResponseObjectRulesSetCacheTagsRuleActionParametersAddCacheTagsValuesOperationRemove PhaseGetResponseObjectRulesSetCacheTagsRuleActionParametersAddCacheTagsValuesOperation = "remove"

const PhaseGetResponseObjectRulesSetCacheTagsRuleActionParametersAddCacheTagsValuesOperationSet PhaseGetResponseObjectRulesSetCacheTagsRuleActionParametersAddCacheTagsValuesOperation = "set"

Values []string

A list of cache tag values.

type PhaseGetResponseObjectRulesSetCacheTagsRuleActionParametersAddCacheTagsExpression struct{…}

Add cache tags using an expression.

Expression string

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

minLength1

Operation PhaseGetResponseObjectRulesSetCacheTagsRuleActionParametersAddCacheTagsExpressionOperation

The operation to perform on the cache tags.

One of the following:

const PhaseGetResponseObjectRulesSetCacheTagsRuleActionParametersAddCacheTagsExpressionOperationAdd PhaseGetResponseObjectRulesSetCacheTagsRuleActionParametersAddCacheTagsExpressionOperation = "add"

const PhaseGetResponseObjectRulesSetCacheTagsRuleActionParametersAddCacheTagsExpressionOperationRemove PhaseGetResponseObjectRulesSetCacheTagsRuleActionParametersAddCacheTagsExpressionOperation = "remove"

const PhaseGetResponseObjectRulesSetCacheTagsRuleActionParametersAddCacheTagsExpressionOperationSet PhaseGetResponseObjectRulesSetCacheTagsRuleActionParametersAddCacheTagsExpressionOperation = "set"

type PhaseGetResponseObjectRulesSetCacheTagsRuleActionParametersRemoveCacheTagsValues struct{…}

Remove cache tags using a list of values.

Operation PhaseGetResponseObjectRulesSetCacheTagsRuleActionParametersRemoveCacheTagsValuesOperation

The operation to perform on the cache tags.

One of the following:

const PhaseGetResponseObjectRulesSetCacheTagsRuleActionParametersRemoveCacheTagsValuesOperationAdd PhaseGetResponseObjectRulesSetCacheTagsRuleActionParametersRemoveCacheTagsValuesOperation = "add"

const PhaseGetResponseObjectRulesSetCacheTagsRuleActionParametersRemoveCacheTagsValuesOperationRemove PhaseGetResponseObjectRulesSetCacheTagsRuleActionParametersRemoveCacheTagsValuesOperation = "remove"

const PhaseGetResponseObjectRulesSetCacheTagsRuleActionParametersRemoveCacheTagsValuesOperationSet PhaseGetResponseObjectRulesSetCacheTagsRuleActionParametersRemoveCacheTagsValuesOperation = "set"

Values []string

A list of cache tag values.

type PhaseGetResponseObjectRulesSetCacheTagsRuleActionParametersRemoveCacheTagsExpression struct{…}

Remove cache tags using an expression.

Expression string

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

minLength1

Operation PhaseGetResponseObjectRulesSetCacheTagsRuleActionParametersRemoveCacheTagsExpressionOperation

The operation to perform on the cache tags.

One of the following:

const PhaseGetResponseObjectRulesSetCacheTagsRuleActionParametersRemoveCacheTagsExpressionOperationAdd PhaseGetResponseObjectRulesSetCacheTagsRuleActionParametersRemoveCacheTagsExpressionOperation = "add"

const PhaseGetResponseObjectRulesSetCacheTagsRuleActionParametersRemoveCacheTagsExpressionOperationRemove PhaseGetResponseObjectRulesSetCacheTagsRuleActionParametersRemoveCacheTagsExpressionOperation = "remove"

const PhaseGetResponseObjectRulesSetCacheTagsRuleActionParametersRemoveCacheTagsExpressionOperationSet PhaseGetResponseObjectRulesSetCacheTagsRuleActionParametersRemoveCacheTagsExpressionOperation = "set"

type PhaseGetResponseObjectRulesSetCacheTagsRuleActionParametersSetCacheTagsValues struct{…}

Set cache tags using a list of values.

Operation PhaseGetResponseObjectRulesSetCacheTagsRuleActionParametersSetCacheTagsValuesOperation

The operation to perform on the cache tags.

One of the following:

const PhaseGetResponseObjectRulesSetCacheTagsRuleActionParametersSetCacheTagsValuesOperationAdd PhaseGetResponseObjectRulesSetCacheTagsRuleActionParametersSetCacheTagsValuesOperation = "add"

const PhaseGetResponseObjectRulesSetCacheTagsRuleActionParametersSetCacheTagsValuesOperationRemove PhaseGetResponseObjectRulesSetCacheTagsRuleActionParametersSetCacheTagsValuesOperation = "remove"

const PhaseGetResponseObjectRulesSetCacheTagsRuleActionParametersSetCacheTagsValuesOperationSet PhaseGetResponseObjectRulesSetCacheTagsRuleActionParametersSetCacheTagsValuesOperation = "set"

Values []string

A list of cache tag values.

type PhaseGetResponseObjectRulesSetCacheTagsRuleActionParametersSetCacheTagsExpression struct{…}

Set cache tags using an expression.

Expression string

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

minLength1

Operation PhaseGetResponseObjectRulesSetCacheTagsRuleActionParametersSetCacheTagsExpressionOperation

The operation to perform on the cache tags.

One of the following:

const PhaseGetResponseObjectRulesSetCacheTagsRuleActionParametersSetCacheTagsExpressionOperationAdd PhaseGetResponseObjectRulesSetCacheTagsRuleActionParametersSetCacheTagsExpressionOperation = "add"

const PhaseGetResponseObjectRulesSetCacheTagsRuleActionParametersSetCacheTagsExpressionOperationRemove PhaseGetResponseObjectRulesSetCacheTagsRuleActionParametersSetCacheTagsExpressionOperation = "remove"

const PhaseGetResponseObjectRulesSetCacheTagsRuleActionParametersSetCacheTagsExpressionOperationSet PhaseGetResponseObjectRulesSetCacheTagsRuleActionParametersSetCacheTagsExpressionOperation = "set"

Categories []stringOptional

The categories of the rule.

Description stringOptional

An informative description of the rule.

ExposedCredentialCheck PhaseGetResponseObjectRulesSetCacheTagsRuleExposedCredentialCheckOptional

Configuration for exposed credential checking.

PasswordExpression string

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

minLength1

UsernameExpression string

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

minLength1

Logging LoggingOptional

An object configuring the rule’s logging behavior.

Enabled bool

Whether to generate a log when the rule matches.

Ratelimit PhaseGetResponseObjectRulesSetCacheTagsRuleRatelimitOptional

An object configuring the rule’s rate limit behavior.

Characteristics []string

Characteristics of the request on which the rate limit counter will be incremented.

Period int64

Period in seconds over which the counter is being incremented.

minimum0

CountingExpression stringOptional

An expression that defines when the rate limit counter should be incremented. It defaults to the same as the rule’s expression.

minLength1

MitigationTimeout int64Optional

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

RequestsPerPeriod int64Optional

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

minimum1

RequestsToOrigin boolOptional

Whether counting is only performed when an origin is reached.

ScorePerPeriod int64Optional

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

ScoreResponseHeaderName stringOptional

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

minLength1

type PhaseGetResponseObjectRulesSetConfigurationRule struct{…}

ID string

Action string

Enabled bool

Expression string

Ref string

type PhaseGetResponseObjectRulesSkipRule struct{…}

ID string

Action string

Enabled bool

Expression string

Ref string

type PhaseGetResponseObjectRulesTransformResponseHTMLRule struct{…}

ID string

The unique ID of the rule.

Action PhaseGetResponseObjectRulesTransformResponseHTMLRuleAction

The action to perform when the rule matches.

Enabled bool

Expression string

The expression defining which traffic will match the rule.

minLength1

LastUpdated Time

The timestamp of when the rule was last modified.

formatdate-time

Ref string

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

minLength1

Version string

The version of the rule.

ActionParameters PhaseGetResponseObjectRulesTransformResponseHTMLRuleActionParametersOptional

The parameters configuring the rule’s action.

LinkMaze unknown

Enables the link maze transformation on the response.

Categories []stringOptional

The categories of the rule.

Description stringOptional

An informative description of the rule.

ExposedCredentialCheck PhaseGetResponseObjectRulesTransformResponseHTMLRuleExposedCredentialCheckOptional

Configuration for exposed credential checking.

PasswordExpression string

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

minLength1

UsernameExpression string

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

minLength1

Logging LoggingOptional

An object configuring the rule’s logging behavior.

Enabled bool

Whether to generate a log when the rule matches.

Ratelimit PhaseGetResponseObjectRulesTransformResponseHTMLRuleRatelimitOptional

An object configuring the rule’s rate limit behavior.

Characteristics []string

Characteristics of the request on which the rate limit counter will be incremented.

Period int64

Period in seconds over which the counter is being incremented.

minimum0

CountingExpression stringOptional

An expression that defines when the rate limit counter should be incremented. It defaults to the same as the rule’s expression.

minLength1

MitigationTimeout int64Optional

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

RequestsPerPeriod int64Optional

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

minimum1

RequestsToOrigin boolOptional

Whether counting is only performed when an origin is reached.

ScorePerPeriod int64Optional

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

ScoreResponseHeaderName stringOptional

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

minLength1

Version stringOptional

The version of the ruleset.

Get an account or zone entry point ruleset

Go

HTTP

TypeScript

Python

Go

Terraform

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

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",
    "description": "A description for my ruleset.",
    "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"
  },
  "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",
    "description": "A description for my ruleset.",
    "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"
  },
  "success": true
}