NewPhaseService generates a new service that applies the given options to each request.

NewPhaseVersionService generates a new service that applies the given options to each request.

NewRuleService generates a new service that applies the given options to each request.

NewRulesetService generates a new service that applies the given options to each request.

NewVersionByTagService generates a new service that applies the given options to each request.

NewVersionService generates a new service that applies the given options to each request.

This is an alias to an internal value.

This is an alias to an internal value.

This is an alias to an internal value.

This is an alias to an internal value.

This is an alias to an internal value.

This is an alias to an internal value.

This is an alias to an internal value.

This is an alias to an internal value.

This is an alias to an internal value.

This is an alias to an internal value.

This is an alias to an internal value.

This is an alias to an internal value.

This is an alias to an internal value.

This is an alias to an internal value.

This is an alias to an internal value.

This is an alias to an internal value.

This is an alias to an internal value.

This is an alias to an internal value.

This is an alias to an internal value.

This is an alias to an internal value.

This is an alias to an internal value.

This is an alias to an internal value.

The parameters configuring the rule's action.

The parameters configuring the rule's action.

The response to show when the block is applied.

The response to show when the block is applied.

The parameters configuring the rule's action.

Compression algorithm to enable.

Compression algorithm to enable.

The parameters configuring the rule's action.

The parameters configuring the rule's action.

The configuration to use for matched data logging.

The configuration to use for matched data logging.

A set of overrides to apply to the target ruleset.

A category-level override.

A category-level override.

A set of overrides to apply to the target ruleset.

A rule-level override.

A rule-level override.

The parameters configuring the rule's action.

An object configuring the rule's logging behavior.

An object configuring the rule's logging behavior.

A ruleset object.

A response object.

A message.

The source of this message.

A message.

The source of this message.

The parameters configuring the rule's action.

The cookie field to log.

The request field to log.

The response field to log.

PhaseService contains methods and other services that help with interacting with the cloudflare API.

The parameters configuring the rule's action.

The cookie field to log.

The request field to log.

The response field to log.

A ruleset object.

A response object.

A message.

The source of this message.

A message.

The source of this message.

The parameters configuring the rule's action.

The cookie field to log.

The request field to log.

The response field to log.

A ruleset object.

A response object.

A message.

The source of this message.

A message.

The source of this message.

The parameters configuring the rule's action.

The cookie field to log.

The request field to log.

The response field to log.

A ruleset object.

PhaseVersionService contains methods and other services that help with interacting with the cloudflare API.

The parameters configuring the rule's action.

Serve a redirect based on a bulk list lookup.

Serve a redirect based on a bulk list lookup.

Serve a redirect based on the request properties.

Serve a redirect based on the request properties.

The URL to redirect the request to.

The URL to redirect the request to.

The parameters configuring the rule's action.

The parameters configuring the rule's action.

Remove the header from the request.

Remove the header from the request.

Set a request header with a dynamic value.

Set a request header with a dynamic value.

Remove the header from the request.

Remove the header from the request.

Set a request header with a static value.

Set a request header with a static value.

The parameters configuring the rule's action.

URI to rewrite the request to.

URI to rewrite the request to.

The parameters configuring the rule's action.

Override the IP/TCP destination.

Override the IP/TCP destination.

The parameters configuring the rule's action.

Override the Server Name Indication (SNI).

Override the Server Name Indication (SNI).

A ruleset object.

A response object.

A message.

The source of this message.

A message.

The source of this message.

The parameters configuring the rule's action.

The cookie field to log.

The request field to log.

The response field to log.

An object configuring where the rule will be placed.

An object configuring where the rule will be placed.

An object configuring where the rule will be placed.

An object configuring where the rule will be placed.

A ruleset object.

A response object.

A message.

The source of this message.

A message.

The source of this message.

The parameters configuring the rule's action.

The cookie field to log.

The request field to log.

The response field to log.

An object configuring where the rule will be placed.

An object configuring where the rule will be placed.

An object configuring where the rule will be placed.

An object configuring where the rule will be placed.

A ruleset object.

A response object.

A message.

The source of this message.

A message.

The source of this message.

The parameters configuring the rule's action.

The cookie field to log.

The request field to log.

The response field to log.

RuleService contains methods and other services that help with interacting with the cloudflare API.

A ruleset object.

A response object.

A message.

The source of this message.

A message.

The source of this message.

The parameters configuring the rule's action.

The cookie field to log.

The request field to log.

The response field to log.

A ruleset object.

The parameters configuring the rule's action.

The cookie field to log.

The request field to log.

The response field to log.

A ruleset object.

A response object.

A message.

The source of this message.

A message.

The source of this message.

The parameters configuring the rule's action.

The cookie field to log.

The request field to log.

The response field to log.

RulesetService contains methods and other services that help with interacting with the cloudflare API.

The parameters configuring the rule's action.

The cookie field to log.

The request field to log.

The response field to log.

A ruleset object.

A response object.

A message.

The source of this message.

A message.

The source of this message.

The parameters configuring the rule's action.

The cookie field to log.

The request field to log.

The response field to log.

The parameters configuring the rule's action.

The parameters configuring the rule's action.

The parameters configuring the rule's action.

The parameters configuring the rule's action.

The parameters configuring the rule's action.

Specify how long client browsers should cache the response.

Specify how long client browsers should cache the response.

Define which components of the request are included or excluded from the cache key Cloudflare uses to store the response in cache.

Customize which components of the request are included or excluded from the cache key.

The cookies to include in building the cache key.

The cookies to include in building the cache key.

The header names and values to include in building the cache key.

The header names and values to include in building the cache key.

Whether to use the original host or the resolved host in the cache key.

Whether to use the original host or the resolved host in the cache key.

Customize which components of the request are included or excluded from the cache key.

Use the presence or absence of parameters in the query string to build the cache key.

build the cache key using all query string parameters EXCECPT these excluded parameters.

build the cache key using all query string parameters EXCECPT these excluded parameters.

build the cache key using a list of query string parameters that ARE in the request.

build the cache key using a list of query string parameters that ARE in the request.

Use the presence or absence of parameters in the query string to build the cache key.

Characteristics of the request user agent used in building the cache key.

Characteristics of the request user agent used in building the cache key.

Define which components of the request are included or excluded from the cache key Cloudflare uses to store the response in cache.

Mark whether the request's response from origin is eligible for Cache Reserve (requires a Cache Reserve add-on plan).

Mark whether the request's response from origin is eligible for Cache Reserve (requires a Cache Reserve add-on plan).

TTL (Time to Live) specifies the maximum time to cache a resource in the Cloudflare edge network.

TTL (Time to Live) specifies the maximum time to cache a resource in the Cloudflare edge network.

Specify how long Cloudflare should cache the response based on the status code from the origin.

Specify how long Cloudflare should cache the response based on the status code from the origin.

The range of status codes used to apply the selected mode.

The range of status codes used to apply the selected mode.

The parameters configuring the rule's action.

Define if Cloudflare should serve stale content while getting the latest content from the origin.

Define if Cloudflare should serve stale content while getting the latest content from the origin.

The parameters configuring the rule's action.

Select which file extensions to minify automatically.

Select which file extensions to minify automatically.

The parameters configuring the rule's action.

The parameters configuring the rule's action.

The parameters configuring the rule's action.

A ruleset object.

A response object.

A message.

The source of this message.

A message.

The source of this message.

The parameters configuring the rule's action.

The cookie field to log.

The request field to log.

The response field to log.

VersionByTagService contains methods and other services that help with interacting with the cloudflare API.

A ruleset object.

A response object.

A message.

The source of this message.

A message.

The source of this message.

The parameters configuring the rule's action.

The cookie field to log.

The request field to log.

The response field to log.

A ruleset object.

VersionService contains methods and other services that help with interacting with the cloudflare API.

Union satisfied by [rulesets.BlockRule], [rulesets.ChallengeRule], [rulesets.CompressResponseRule], [rulesets.ExecuteRule], [rulesets.JSChallengeRule], [rulesets.LogRule], [rulesets.ManagedChallengeRule], [rulesets.RedirectRule], [rulesets.RewriteRule], [rulesets.RouteRule], [rulesets.ScoreRule], [rulesets.ServeErrorRule], [rulesets.SetConfigRule], [rulesets.SkipRule], [rulesets.SetCacheSettingsRule], [rulesets.PhaseGetResponseRulesRulesetsLogCustomFieldRule], [rulesets.PhaseGetResponseRulesRulesetsDDoSDynamicRule] or [rulesets.PhaseGetResponseRulesRulesetsForceConnectionCloseRule].

Satisfied by [rulesets.BlockRuleParam], [rulesets.ChallengeRuleParam], [rulesets.CompressResponseRuleParam], [rulesets.ExecuteRuleParam], [rulesets.JSChallengeRuleParam], [rulesets.LogRuleParam], [rulesets.ManagedChallengeRuleParam], [rulesets.RedirectRuleParam], [rulesets.RewriteRuleParam], [rulesets.RouteRuleParam], [rulesets.ScoreRuleParam], [rulesets.ServeErrorRuleParam], [rulesets.SetConfigRuleParam], [rulesets.SkipRuleParam], [rulesets.SetCacheSettingsRuleParam], [rulesets.PhaseUpdateParamsRulesRulesetsLogCustomFieldRule], [rulesets.PhaseUpdateParamsRulesRulesetsDDoSDynamicRule], [rulesets.PhaseUpdateParamsRulesRulesetsForceConnectionCloseRule], [PhaseUpdateParamsRule].

Union satisfied by [rulesets.BlockRule], [rulesets.ChallengeRule], [rulesets.CompressResponseRule], [rulesets.ExecuteRule], [rulesets.JSChallengeRule], [rulesets.LogRule], [rulesets.ManagedChallengeRule], [rulesets.RedirectRule], [rulesets.RewriteRule], [rulesets.RouteRule], [rulesets.ScoreRule], [rulesets.ServeErrorRule], [rulesets.SetConfigRule], [rulesets.SkipRule], [rulesets.SetCacheSettingsRule], [rulesets.PhaseUpdateResponseRulesRulesetsLogCustomFieldRule], [rulesets.PhaseUpdateResponseRulesRulesetsDDoSDynamicRule] or [rulesets.PhaseUpdateResponseRulesRulesetsForceConnectionCloseRule].

Union satisfied by [rulesets.BlockRule], [rulesets.ChallengeRule], [rulesets.CompressResponseRule], [rulesets.ExecuteRule], [rulesets.JSChallengeRule], [rulesets.LogRule], [rulesets.ManagedChallengeRule], [rulesets.RedirectRule], [rulesets.RewriteRule], [rulesets.RouteRule], [rulesets.ScoreRule], [rulesets.ServeErrorRule], [rulesets.SetConfigRule], [rulesets.SkipRule], [rulesets.SetCacheSettingsRule], [rulesets.PhaseVersionGetResponseRulesRulesetsLogCustomFieldRule], [rulesets.PhaseVersionGetResponseRulesRulesetsDDoSDynamicRule] or [rulesets.PhaseVersionGetResponseRulesRulesetsForceConnectionCloseRule].

The URL to redirect the request to.

The URL to redirect the request to.

Remove the header from the request.

Remove the header from the request.

Union satisfied by [rulesets.RewriteURIPartStaticValue] or [rulesets.RewriteURIPartDynamicValue].

Satisfied by [rulesets.RewriteURIPartStaticValueParam], [rulesets.RewriteURIPartDynamicValueParam], [RewriteURIPartParam].

Union satisfied by [rulesets.BlockRule], [rulesets.ChallengeRule], [rulesets.CompressResponseRule], [rulesets.ExecuteRule], [rulesets.JSChallengeRule], [rulesets.LogRule], [rulesets.ManagedChallengeRule], [rulesets.RedirectRule], [rulesets.RewriteRule], [rulesets.RouteRule], [rulesets.ScoreRule], [rulesets.ServeErrorRule], [rulesets.SetConfigRule], [rulesets.SkipRule], [rulesets.SetCacheSettingsRule], [rulesets.RuleDeleteResponseRulesRulesetsLogCustomFieldRule], [rulesets.RuleDeleteResponseRulesRulesetsDDoSDynamicRule] or [rulesets.RuleDeleteResponseRulesRulesetsForceConnectionCloseRule].

An object configuring where the rule will be placed.

Union satisfied by [rulesets.BlockRule], [rulesets.ChallengeRule], [rulesets.CompressResponseRule], [rulesets.ExecuteRule], [rulesets.JSChallengeRule], [rulesets.LogRule], [rulesets.ManagedChallengeRule], [rulesets.RedirectRule], [rulesets.RewriteRule], [rulesets.RouteRule], [rulesets.ScoreRule], [rulesets.ServeErrorRule], [rulesets.SetConfigRule], [rulesets.SkipRule], [rulesets.SetCacheSettingsRule], [rulesets.RuleEditResponseRulesRulesetsLogCustomFieldRule], [rulesets.RuleEditResponseRulesRulesetsDDoSDynamicRule] or [rulesets.RuleEditResponseRulesRulesetsForceConnectionCloseRule].

An object configuring where the rule will be placed.

Union satisfied by [rulesets.BlockRule], [rulesets.ChallengeRule], [rulesets.CompressResponseRule], [rulesets.ExecuteRule], [rulesets.JSChallengeRule], [rulesets.LogRule], [rulesets.ManagedChallengeRule], [rulesets.RedirectRule], [rulesets.RewriteRule], [rulesets.RouteRule], [rulesets.ScoreRule], [rulesets.ServeErrorRule], [rulesets.SetConfigRule], [rulesets.SkipRule], [rulesets.SetCacheSettingsRule], [rulesets.RuleNewResponseRulesRulesetsLogCustomFieldRule], [rulesets.RuleNewResponseRulesRulesetsDDoSDynamicRule] or [rulesets.RuleNewResponseRulesRulesetsForceConnectionCloseRule].

Union satisfied by [rulesets.BlockRule], [rulesets.ChallengeRule], [rulesets.CompressResponseRule], [rulesets.ExecuteRule], [rulesets.JSChallengeRule], [rulesets.LogRule], [rulesets.ManagedChallengeRule], [rulesets.RedirectRule], [rulesets.RewriteRule], [rulesets.RouteRule], [rulesets.ScoreRule], [rulesets.ServeErrorRule], [rulesets.SetConfigRule], [rulesets.SkipRule], [rulesets.SetCacheSettingsRule], [rulesets.RulesetGetResponseRulesRulesetsLogCustomFieldRule], [rulesets.RulesetGetResponseRulesRulesetsDDoSDynamicRule] or [rulesets.RulesetGetResponseRulesRulesetsForceConnectionCloseRule].

Satisfied by [rulesets.BlockRuleParam], [rulesets.ChallengeRuleParam], [rulesets.CompressResponseRuleParam], [rulesets.ExecuteRuleParam], [rulesets.JSChallengeRuleParam], [rulesets.LogRuleParam], [rulesets.ManagedChallengeRuleParam], [rulesets.RedirectRuleParam], [rulesets.RewriteRuleParam], [rulesets.RouteRuleParam], [rulesets.ScoreRuleParam], [rulesets.ServeErrorRuleParam], [rulesets.SetConfigRuleParam], [rulesets.SkipRuleParam], [rulesets.SetCacheSettingsRuleParam], [rulesets.RulesetNewParamsRulesRulesetsLogCustomFieldRule], [rulesets.RulesetNewParamsRulesRulesetsDDoSDynamicRule], [rulesets.RulesetNewParamsRulesRulesetsForceConnectionCloseRule], [RulesetNewParamsRule].

Union satisfied by [rulesets.BlockRule], [rulesets.ChallengeRule], [rulesets.CompressResponseRule], [rulesets.ExecuteRule], [rulesets.JSChallengeRule], [rulesets.LogRule], [rulesets.ManagedChallengeRule], [rulesets.RedirectRule], [rulesets.RewriteRule], [rulesets.RouteRule], [rulesets.ScoreRule], [rulesets.ServeErrorRule], [rulesets.SetConfigRule], [rulesets.SkipRule], [rulesets.SetCacheSettingsRule], [rulesets.RulesetNewResponseRulesRulesetsLogCustomFieldRule], [rulesets.RulesetNewResponseRulesRulesetsDDoSDynamicRule] or [rulesets.RulesetNewResponseRulesRulesetsForceConnectionCloseRule].

Satisfied by [rulesets.BlockRuleParam], [rulesets.ChallengeRuleParam], [rulesets.CompressResponseRuleParam], [rulesets.ExecuteRuleParam], [rulesets.JSChallengeRuleParam], [rulesets.LogRuleParam], [rulesets.ManagedChallengeRuleParam], [rulesets.RedirectRuleParam], [rulesets.RewriteRuleParam], [rulesets.RouteRuleParam], [rulesets.ScoreRuleParam], [rulesets.ServeErrorRuleParam], [rulesets.SetConfigRuleParam], [rulesets.SkipRuleParam], [rulesets.SetCacheSettingsRuleParam], [rulesets.RulesetUpdateParamsRulesRulesetsLogCustomFieldRule], [rulesets.RulesetUpdateParamsRulesRulesetsDDoSDynamicRule], [rulesets.RulesetUpdateParamsRulesRulesetsForceConnectionCloseRule], [RulesetUpdateParamsRule].

Union satisfied by [rulesets.BlockRule], [rulesets.ChallengeRule], [rulesets.CompressResponseRule], [rulesets.ExecuteRule], [rulesets.JSChallengeRule], [rulesets.LogRule], [rulesets.ManagedChallengeRule], [rulesets.RedirectRule], [rulesets.RewriteRule], [rulesets.RouteRule], [rulesets.ScoreRule], [rulesets.ServeErrorRule], [rulesets.SetConfigRule], [rulesets.SkipRule], [rulesets.SetCacheSettingsRule], [rulesets.RulesetUpdateResponseRulesRulesetsLogCustomFieldRule], [rulesets.RulesetUpdateResponseRulesRulesetsDDoSDynamicRule] or [rulesets.RulesetUpdateResponseRulesRulesetsForceConnectionCloseRule].

Union satisfied by [rulesets.BlockRule], [rulesets.ChallengeRule], [rulesets.CompressResponseRule], [rulesets.ExecuteRule], [rulesets.JSChallengeRule], [rulesets.LogRule], [rulesets.ManagedChallengeRule], [rulesets.RedirectRule], [rulesets.RewriteRule], [rulesets.RouteRule], [rulesets.ScoreRule], [rulesets.ServeErrorRule], [rulesets.SetConfigRule], [rulesets.SkipRule], [rulesets.SetCacheSettingsRule], [rulesets.VersionByTagGetResponseRulesRulesetsLogCustomFieldRule], [rulesets.VersionByTagGetResponseRulesRulesetsDDoSDynamicRule] or [rulesets.VersionByTagGetResponseRulesRulesetsForceConnectionCloseRule].

Union satisfied by [rulesets.BlockRule], [rulesets.ChallengeRule], [rulesets.CompressResponseRule], [rulesets.ExecuteRule], [rulesets.JSChallengeRule], [rulesets.LogRule], [rulesets.ManagedChallengeRule], [rulesets.RedirectRule], [rulesets.RewriteRule], [rulesets.RouteRule], [rulesets.ScoreRule], [rulesets.ServeErrorRule], [rulesets.SetConfigRule], [rulesets.SkipRule], [rulesets.SetCacheSettingsRule], [rulesets.VersionGetResponseRulesRulesetsLogCustomFieldRule], [rulesets.VersionGetResponseRulesRulesetsDDoSDynamicRule] or [rulesets.VersionGetResponseRulesRulesetsForceConnectionCloseRule].

This is an alias to an internal type.

This is an alias to an internal type.

This is an alias to an internal type.

This is an alias to an internal type.

This is an alias to an internal type.

The type of actor, whether a User, Cloudflare Admin, or an Automated System.

This is an alias to an internal type.

This is an alias to an internal type.

The action to perform when the rule matches.

The Certificate Authority that will issue the certificate This is an alias to an internal type.

Signature type desired on certificate ("origin-rsa" (rsa), "origin-ecc" (ecdsa), or "keyless-certificate" (for Keyless SSL servers).

The action to perform when the rule matches.

A Cloudflare Tunnel that connects your origin to Cloudflare's edge.

This is an alias to an internal type.

The status of the tunnel.

The type of tunnel.

The action to perform when the rule matches.

Name of compression algorithm to enable.

This is an alias to an internal type.

The action to perform when the rule matches.

The sensitivity level to use for rules in the category.

The sensitivity level to use for the rule.

A sensitivity level to set for all rules.

The action to perform when the rule matches.

The kind of the ruleset.

The action to perform when the rule matches.

The action to perform when the rule matches.

This is an alias to an internal type.

This is an alias to an internal type.

This is an alias to an internal type.

A member's status in the account.

Details of the user associated to the membership.

This is an alias to an internal type.

This is an alias to an internal type.

This is an alias to an internal type.

The phase of the ruleset.

Whether the API call was successful.

The action to perform when the rule matches.

The action to perform when the rule matches.

The action to perform when the rule matches.

The action to perform when the rule matches.

The action to perform when the rule matches.

The action to perform when the rule matches.

The action to perform when the rule matches.

The action to perform when the rule matches.

Whether the API call was successful.

The action to perform when the rule matches.

The action to perform when the rule matches.

The action to perform when the rule matches.

The action to perform when the rule matches.

Whether the API call was successful.

The action to perform when the rule matches.

The action to perform when the rule matches.

The action to perform when the rule matches.

The action to perform when the rule matches.

The action to perform when the rule matches.

The status code to be used for the redirect.

This is an alias to an internal type.

The action to perform when the rule matches.

This is an alias to an internal type.

The action to perform when the rule matches.

Whether the API call was successful.

The action to perform when the rule matches.

The action to perform when the rule matches.

The action to perform when the rule matches.

The action to perform when the rule matches.

Whether the API call was successful.

The action to perform when the rule matches.

The action to perform when the rule matches.

The action to perform when the rule matches.

The action to perform when the rule matches.

Whether the API call was successful.

The action to perform when the rule matches.

The action to perform when the rule matches.

The action to perform when the rule matches.

The action to perform when the rule matches.

Whether the API call was successful.

The action to perform when the rule matches.

The action to perform when the rule matches.

The action to perform when the rule matches.

The action to perform when the rule matches.

The action to perform when the rule matches.

The action to perform when the rule matches.

The action to perform when the rule matches.

The action to perform when the rule matches.

Whether the API call was successful.

The action to perform when the rule matches.

The action to perform when the rule matches.

The action to perform when the rule matches.

The action to perform when the rule matches.

The action to perform when the rule matches.

The action to perform when the rule matches.

The action to perform when the rule matches.

The action to perform when the rule matches.

Whether the API call was successful.

The action to perform when the rule matches.

The action to perform when the rule matches.

The action to perform when the rule matches.

The action to perform when the rule matches.

The action to perform when the rule matches.

The action to perform when the rule matches.

Content-type header to set with the response.

The action to perform when the rule matches.

Determines which browser ttl mode to use.

edge ttl options.

The action to perform when the rule matches.

Turn off all active Cloudflare Apps.

Turn off Real User Monitoring (RUM).

Turn off Zaraz.

Configure the Polish level.

Configure the Security Level.

Configure the SSL level.

The action to perform when the rule matches.

The name of a legacy security product to skip the execution of.

A ruleset to skip the execution of.

Direction to order DNS records in.

Whether the API call was successful.

The action to perform when the rule matches.

The action to perform when the rule matches.

The action to perform when the rule matches.

The action to perform when the rule matches.

Whether the API call was successful.

The action to perform when the rule matches.

The action to perform when the rule matches.

The action to perform when the rule matches.

The action to perform when the rule matches.