GetRulesetRuleActionParameters

data class GetRulesetRuleActionParameters(val additionalCacheablePorts: List<Int>, val algorithms: List<GetRulesetRuleActionParametersAlgorithm>, val automaticHttpsRewrites: Boolean, val autominify: GetRulesetRuleActionParametersAutominify, val bic: Boolean, val browserTtl: GetRulesetRuleActionParametersBrowserTtl, val cache: Boolean, val cacheKey: GetRulesetRuleActionParametersCacheKey, val cacheReserve: GetRulesetRuleActionParametersCacheReserve, val content: String, val contentType: String, val cookieFields: List<GetRulesetRuleActionParametersCookieField>, val disableApps: Boolean, val disableRum: Boolean, val disableZaraz: Boolean, val edgeTtl: GetRulesetRuleActionParametersEdgeTtl, val emailObfuscation: Boolean, val fonts: Boolean, val fromList: GetRulesetRuleActionParametersFromList, val fromValue: GetRulesetRuleActionParametersFromValue, val headers: Map<String, GetRulesetRuleActionParametersHeaders>, val hostHeader: String, val hotlinkProtection: Boolean, val id: String, val increment: Int, val matchedData: GetRulesetRuleActionParametersMatchedData, val mirage: Boolean, val opportunisticEncryption: Boolean, val origin: GetRulesetRuleActionParametersOrigin, val originCacheControl: Boolean, val originErrorPagePassthru: Boolean, val overrides: GetRulesetRuleActionParametersOverrides, val phases: List<String>, val polish: String, val products: List<String>, val rawResponseFields: List<GetRulesetRuleActionParametersRawResponseField>, val readTimeout: Int, val requestFields: List<GetRulesetRuleActionParametersRequestField>, val respectStrongEtags: Boolean, val response: GetRulesetRuleActionParametersResponse, val responseFields: List<GetRulesetRuleActionParametersResponseField>, val rocketLoader: Boolean, val rules: Map<String, List<String>>, val ruleset: String, val rulesets: List<String>, val securityLevel: String, val serveStale: GetRulesetRuleActionParametersServeStale, val serverSideExcludes: Boolean, val sni: GetRulesetRuleActionParametersSni, val ssl: String, val statusCode: Double, val sxg: Boolean, val transformedRequestFields: List<GetRulesetRuleActionParametersTransformedRequestField>, val uri: GetRulesetRuleActionParametersUri)

Constructors

Link copied to clipboard
constructor(additionalCacheablePorts: List<Int>, algorithms: List<GetRulesetRuleActionParametersAlgorithm>, automaticHttpsRewrites: Boolean, autominify: GetRulesetRuleActionParametersAutominify, bic: Boolean, browserTtl: GetRulesetRuleActionParametersBrowserTtl, cache: Boolean, cacheKey: GetRulesetRuleActionParametersCacheKey, cacheReserve: GetRulesetRuleActionParametersCacheReserve, content: String, contentType: String, cookieFields: List<GetRulesetRuleActionParametersCookieField>, disableApps: Boolean, disableRum: Boolean, disableZaraz: Boolean, edgeTtl: GetRulesetRuleActionParametersEdgeTtl, emailObfuscation: Boolean, fonts: Boolean, fromList: GetRulesetRuleActionParametersFromList, fromValue: GetRulesetRuleActionParametersFromValue, headers: Map<String, GetRulesetRuleActionParametersHeaders>, hostHeader: String, hotlinkProtection: Boolean, id: String, increment: Int, matchedData: GetRulesetRuleActionParametersMatchedData, mirage: Boolean, opportunisticEncryption: Boolean, origin: GetRulesetRuleActionParametersOrigin, originCacheControl: Boolean, originErrorPagePassthru: Boolean, overrides: GetRulesetRuleActionParametersOverrides, phases: List<String>, polish: String, products: List<String>, rawResponseFields: List<GetRulesetRuleActionParametersRawResponseField>, readTimeout: Int, requestFields: List<GetRulesetRuleActionParametersRequestField>, respectStrongEtags: Boolean, response: GetRulesetRuleActionParametersResponse, responseFields: List<GetRulesetRuleActionParametersResponseField>, rocketLoader: Boolean, rules: Map<String, List<String>>, ruleset: String, rulesets: List<String>, securityLevel: String, serveStale: GetRulesetRuleActionParametersServeStale, serverSideExcludes: Boolean, sni: GetRulesetRuleActionParametersSni, ssl: String, statusCode: Double, sxg: Boolean, transformedRequestFields: List<GetRulesetRuleActionParametersTransformedRequestField>, uri: GetRulesetRuleActionParametersUri)

Types

Link copied to clipboard
object Companion

Properties

Link copied to clipboard

List of additional ports that caching can be enabled on.

Link copied to clipboard

Custom order for compression algorithms.

Link copied to clipboard

Turn on or off Automatic HTTPS Rewrites.

Link copied to clipboard

Select which file extensions to minify automatically.

Link copied to clipboard

Turn on or off Browser Integrity Check.

Link copied to clipboard

Specify how long client browsers should cache the response. Cloudflare cache purge will not purge content cached on client browsers, so high browser TTLs may lead to stale content.

Link copied to clipboard

Mark whether the request’s response from origin is eligible for caching. Caching itself will still depend on the cache-control header and your other caching configurations.

Link copied to clipboard

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

Link copied to clipboard

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

Link copied to clipboard

Error response content.

Link copied to clipboard

Content-type header to set with the response. Available values: "application/json", "text/xml", "text/plain", "text/html".

Link copied to clipboard
Link copied to clipboard

Turn off all active Cloudflare Apps.

Link copied to clipboard

Turn off Real User Monitoring (RUM).

Link copied to clipboard

Turn off Zaraz.

Link copied to clipboard

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

Link copied to clipboard

Turn on or off Email Obfuscation.

Link copied to clipboard

Turn on or off Cloudflare Fonts.

Link copied to clipboard

Serve a redirect based on a bulk list lookup.

Link copied to clipboard

Serve a redirect based on the request properties.

Link copied to clipboard

Map of request headers to modify.

Link copied to clipboard

Rewrite the HTTP Host header.

Link copied to clipboard

Turn on or off the Hotlink Protection.

Link copied to clipboard
val id: String

The ID of the ruleset to execute.

Link copied to clipboard

Increment contains the delta to change the score and can be either positive or negative.

Link copied to clipboard

The configuration to use for matched data logging.

Link copied to clipboard

Turn on or off Mirage.

Link copied to clipboard

Turn on or off Opportunistic Encryption.

Link copied to clipboard

Override the IP/TCP destination.

Link copied to clipboard

When enabled, Cloudflare will aim to strictly adhere to RFC 7234.

Link copied to clipboard

Generate Cloudflare error pages from issues sent from the origin server. When on, error pages will trigger for issues from the origin

Link copied to clipboard

A set of overrides to apply to the target ruleset.

Link copied to clipboard

A list of phases to skip the execution of. This option is incompatible with the ruleset and rulesets options.

Link copied to clipboard

Configure the Polish level. Available values: "off", "lossless", "lossy".

Link copied to clipboard

A list of legacy security products to skip the execution of.

Link copied to clipboard
Link copied to clipboard

Define a timeout value between two successive read operations to your origin server. Historically, the timeout value between two read options from Cloudflare to an origin server is 100 seconds. If you are attempting to reduce HTTP 524 errors because of timeouts from an origin server, try increasing this timeout value.

Link copied to clipboard
Link copied to clipboard

Specify whether or not Cloudflare should respect strong ETag (entity tag) headers. When off, Cloudflare converts strong ETag headers to weak ETag headers.

Link copied to clipboard

The response to show when the block is applied.

Link copied to clipboard

The transformed response fields to log.

Link copied to clipboard

Turn on or off Rocket Loader

Link copied to clipboard

A mapping of ruleset IDs to a list of rule IDs in that ruleset to skip the execution of. This option is incompatible with the ruleset option.

Link copied to clipboard

A ruleset to skip the execution of. This option is incompatible with the rulesets, rules and phases options. Available values: "current".

Link copied to clipboard

A list of ruleset IDs to skip the execution of. This option is incompatible with the ruleset and phases options.

Link copied to clipboard

Configure the Security Level. Available values: "off", "essentiallyoff", "low", "medium", "high", "underattack".

Link copied to clipboard

Turn on or off Server Side Excludes.

Link copied to clipboard

Define if Cloudflare should serve stale content while getting the latest content from the origin. If on, Cloudflare will not serve stale content while getting the latest content from the origin.

Link copied to clipboard

Override the Server Name Indication (SNI).

Link copied to clipboard
val ssl: String

Configure the SSL level. Available values: "off", "flexible", "full", "strict", "origin_pull".

Link copied to clipboard

The status code to use for the error.

Link copied to clipboard

Turn on or off Signed Exchanges (SXG).

Link copied to clipboard
Link copied to clipboard

URI to rewrite the request to.