Cloudflare v6.1.2, Apr 28 25

Cloudflare v6.1.2 published on Monday, Apr 28, 2025 by Pulumi

cloudflare.getRuleset

Explore with Pulumi AI

Cloudflare v6.1.2 published on Monday, Apr 28, 2025 by Pulumi

Example Usage

import * as pulumi from "@pulumi/pulumi";
import * as cloudflare from "@pulumi/cloudflare";

const exampleRuleset = cloudflare.getRuleset({
    rulesetId: "2f2feab2026849078ba485f918791bdc",
    accountId: "account_id",
    zoneId: "zone_id",
});

import pulumi
import pulumi_cloudflare as cloudflare

example_ruleset = cloudflare.get_ruleset(ruleset_id="2f2feab2026849078ba485f918791bdc",
    account_id="account_id",
    zone_id="zone_id")

package main

import (
	"github.com/pulumi/pulumi-cloudflare/sdk/v6/go/cloudflare"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := cloudflare.LookupRuleset(ctx, &cloudflare.LookupRulesetArgs{
			RulesetId: pulumi.StringRef("2f2feab2026849078ba485f918791bdc"),
			AccountId: pulumi.StringRef("account_id"),
			ZoneId:    pulumi.StringRef("zone_id"),
		}, nil)
		if err != nil {
			return err
		}
		return nil
	})
}

using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Cloudflare = Pulumi.Cloudflare;

return await Deployment.RunAsync(() => 
{
    var exampleRuleset = Cloudflare.GetRuleset.Invoke(new()
    {
        RulesetId = "2f2feab2026849078ba485f918791bdc",
        AccountId = "account_id",
        ZoneId = "zone_id",
    });

});

package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.cloudflare.CloudflareFunctions;
import com.pulumi.cloudflare.inputs.GetRulesetArgs;
import java.util.List;
import java.util.ArrayList;
import java.util.Map;
import java.io.File;
import java.nio.file.Files;
import java.nio.file.Paths;

public class App {
    public static void main(String[] args) {
        Pulumi.run(App::stack);
    }

    public static void stack(Context ctx) {
        final var exampleRuleset = CloudflareFunctions.getRuleset(GetRulesetArgs.builder()
            .rulesetId("2f2feab2026849078ba485f918791bdc")
            .accountId("account_id")
            .zoneId("zone_id")
            .build());

    }
}

variables:
  exampleRuleset:
    fn::invoke:
      function: cloudflare:getRuleset
      arguments:
        rulesetId: 2f2feab2026849078ba485f918791bdc
        accountId: account_id
        zoneId: zone_id

Using getRuleset

Two invocation forms are available. The direct form accepts plain arguments and either blocks until the result value is available, or returns a Promise-wrapped result. The output form accepts Input-wrapped arguments and returns an Output-wrapped result.

function getRuleset(args: GetRulesetArgs, opts?: InvokeOptions): Promise<GetRulesetResult>
function getRulesetOutput(args: GetRulesetOutputArgs, opts?: InvokeOptions): Output<GetRulesetResult>

def get_ruleset(account_id: Optional[str] = None,
                ruleset_id: Optional[str] = None,
                zone_id: Optional[str] = None,
                opts: Optional[InvokeOptions] = None) -> GetRulesetResult
def get_ruleset_output(account_id: Optional[pulumi.Input[str]] = None,
                ruleset_id: Optional[pulumi.Input[str]] = None,
                zone_id: Optional[pulumi.Input[str]] = None,
                opts: Optional[InvokeOptions] = None) -> Output[GetRulesetResult]

func LookupRuleset(ctx *Context, args *LookupRulesetArgs, opts ...InvokeOption) (*LookupRulesetResult, error)
func LookupRulesetOutput(ctx *Context, args *LookupRulesetOutputArgs, opts ...InvokeOption) LookupRulesetResultOutput

> Note: This function is named LookupRuleset in the Go SDK.

public static class GetRuleset 
{
    public static Task<GetRulesetResult> InvokeAsync(GetRulesetArgs args, InvokeOptions? opts = null)
    public static Output<GetRulesetResult> Invoke(GetRulesetInvokeArgs args, InvokeOptions? opts = null)
}

public static CompletableFuture<GetRulesetResult> getRuleset(GetRulesetArgs args, InvokeOptions options)
public static Output<GetRulesetResult> getRuleset(GetRulesetArgs args, InvokeOptions options)

fn::invoke:
  function: cloudflare:index/getRuleset:getRuleset
  arguments:
    # arguments dictionary

The following arguments are supported:

AccountId string: The Account ID to use for this endpoint. Mutually exclusive with the Zone ID.
RulesetId string: The unique ID of the ruleset.
ZoneId string: The Zone ID to use for this endpoint. Mutually exclusive with the Account ID.

AccountId string: The Account ID to use for this endpoint. Mutually exclusive with the Zone ID.
RulesetId string: The unique ID of the ruleset.
ZoneId string: The Zone ID to use for this endpoint. Mutually exclusive with the Account ID.

accountId String: The Account ID to use for this endpoint. Mutually exclusive with the Zone ID.
rulesetId String: The unique ID of the ruleset.
zoneId String: The Zone ID to use for this endpoint. Mutually exclusive with the Account ID.

accountId string: The Account ID to use for this endpoint. Mutually exclusive with the Zone ID.
rulesetId string: The unique ID of the ruleset.
zoneId string: The Zone ID to use for this endpoint. Mutually exclusive with the Account ID.

account_id str: The Account ID to use for this endpoint. Mutually exclusive with the Zone ID.
ruleset_id str: The unique ID of the ruleset.
zone_id str: The Zone ID to use for this endpoint. Mutually exclusive with the Account ID.

accountId String: The Account ID to use for this endpoint. Mutually exclusive with the Zone ID.
rulesetId String: The unique ID of the ruleset.
zoneId String: The Zone ID to use for this endpoint. Mutually exclusive with the Account ID.

getRuleset Result

The following output properties are available:

Description string: An informative description of the ruleset.
Id string: The unique ID of the ruleset.
Kind string: The kind of the ruleset. Available values: "managed", "custom", "root", "zone".
Name string: The human-readable name of the ruleset.
Phase string: The phase of the ruleset. Available values: "ddosl4", "ddosl7", "httpconfigsettings", "httpcustomerrors", "httplogcustomfields", "httpratelimit", "httprequestcachesettings", "httprequestdynamicredirect", "httprequestfirewallcustom", "httprequestfirewallmanaged", "httprequestlatetransform", "httprequestorigin", "httprequestredirect", "httprequestsanitize", "httprequestsbfm", "httprequesttransform", "httpresponsecompression", "httpresponsefirewallmanaged", "httpresponseheaderstransform", "magictransit", "magictransitidsmanaged", "magictransitmanaged", "magictransit_ratelimit".
Rules List<GetRulesetRule>: The list of rules in the ruleset.
AccountId string: The Account ID to use for this endpoint. Mutually exclusive with the Zone ID.
RulesetId string: The unique ID of the ruleset.
ZoneId string: The Zone ID to use for this endpoint. Mutually exclusive with the Account ID.

Description string: An informative description of the ruleset.
Id string: The unique ID of the ruleset.
Kind string: The kind of the ruleset. Available values: "managed", "custom", "root", "zone".
Name string: The human-readable name of the ruleset.
Phase string: The phase of the ruleset. Available values: "ddosl4", "ddosl7", "httpconfigsettings", "httpcustomerrors", "httplogcustomfields", "httpratelimit", "httprequestcachesettings", "httprequestdynamicredirect", "httprequestfirewallcustom", "httprequestfirewallmanaged", "httprequestlatetransform", "httprequestorigin", "httprequestredirect", "httprequestsanitize", "httprequestsbfm", "httprequesttransform", "httpresponsecompression", "httpresponsefirewallmanaged", "httpresponseheaderstransform", "magictransit", "magictransitidsmanaged", "magictransitmanaged", "magictransit_ratelimit".
Rules []GetRulesetRule: The list of rules in the ruleset.
AccountId string: The Account ID to use for this endpoint. Mutually exclusive with the Zone ID.
RulesetId string: The unique ID of the ruleset.
ZoneId string: The Zone ID to use for this endpoint. Mutually exclusive with the Account ID.

description String: An informative description of the ruleset.
id String: The unique ID of the ruleset.
kind String: The kind of the ruleset. Available values: "managed", "custom", "root", "zone".
name String: The human-readable name of the ruleset.
phase String: The phase of the ruleset. Available values: "ddosl4", "ddosl7", "httpconfigsettings", "httpcustomerrors", "httplogcustomfields", "httpratelimit", "httprequestcachesettings", "httprequestdynamicredirect", "httprequestfirewallcustom", "httprequestfirewallmanaged", "httprequestlatetransform", "httprequestorigin", "httprequestredirect", "httprequestsanitize", "httprequestsbfm", "httprequesttransform", "httpresponsecompression", "httpresponsefirewallmanaged", "httpresponseheaderstransform", "magictransit", "magictransitidsmanaged", "magictransitmanaged", "magictransit_ratelimit".
rules List<GetRulesetRule>: The list of rules in the ruleset.
accountId String: The Account ID to use for this endpoint. Mutually exclusive with the Zone ID.
rulesetId String: The unique ID of the ruleset.
zoneId String: The Zone ID to use for this endpoint. Mutually exclusive with the Account ID.

description string: An informative description of the ruleset.
id string: The unique ID of the ruleset.
kind string: The kind of the ruleset. Available values: "managed", "custom", "root", "zone".
name string: The human-readable name of the ruleset.
phase string: The phase of the ruleset. Available values: "ddosl4", "ddosl7", "httpconfigsettings", "httpcustomerrors", "httplogcustomfields", "httpratelimit", "httprequestcachesettings", "httprequestdynamicredirect", "httprequestfirewallcustom", "httprequestfirewallmanaged", "httprequestlatetransform", "httprequestorigin", "httprequestredirect", "httprequestsanitize", "httprequestsbfm", "httprequesttransform", "httpresponsecompression", "httpresponsefirewallmanaged", "httpresponseheaderstransform", "magictransit", "magictransitidsmanaged", "magictransitmanaged", "magictransit_ratelimit".
rules GetRulesetRule[]: The list of rules in the ruleset.
accountId string: The Account ID to use for this endpoint. Mutually exclusive with the Zone ID.
rulesetId string: The unique ID of the ruleset.
zoneId string: The Zone ID to use for this endpoint. Mutually exclusive with the Account ID.

description str: An informative description of the ruleset.
id str: The unique ID of the ruleset.
kind str: The kind of the ruleset. Available values: "managed", "custom", "root", "zone".
name str: The human-readable name of the ruleset.
phase str: The phase of the ruleset. Available values: "ddosl4", "ddosl7", "httpconfigsettings", "httpcustomerrors", "httplogcustomfields", "httpratelimit", "httprequestcachesettings", "httprequestdynamicredirect", "httprequestfirewallcustom", "httprequestfirewallmanaged", "httprequestlatetransform", "httprequestorigin", "httprequestredirect", "httprequestsanitize", "httprequestsbfm", "httprequesttransform", "httpresponsecompression", "httpresponsefirewallmanaged", "httpresponseheaderstransform", "magictransit", "magictransitidsmanaged", "magictransitmanaged", "magictransit_ratelimit".
rules Sequence[GetRulesetRule]: The list of rules in the ruleset.
account_id str: The Account ID to use for this endpoint. Mutually exclusive with the Zone ID.
ruleset_id str: The unique ID of the ruleset.
zone_id str: The Zone ID to use for this endpoint. Mutually exclusive with the Account ID.

description String: An informative description of the ruleset.
id String: The unique ID of the ruleset.
kind String: The kind of the ruleset. Available values: "managed", "custom", "root", "zone".
name String: The human-readable name of the ruleset.
phase String: The phase of the ruleset. Available values: "ddosl4", "ddosl7", "httpconfigsettings", "httpcustomerrors", "httplogcustomfields", "httpratelimit", "httprequestcachesettings", "httprequestdynamicredirect", "httprequestfirewallcustom", "httprequestfirewallmanaged", "httprequestlatetransform", "httprequestorigin", "httprequestredirect", "httprequestsanitize", "httprequestsbfm", "httprequesttransform", "httpresponsecompression", "httpresponsefirewallmanaged", "httpresponseheaderstransform", "magictransit", "magictransitidsmanaged", "magictransitmanaged", "magictransit_ratelimit".
rules List<Property Map>: The list of rules in the ruleset.
accountId String: The Account ID to use for this endpoint. Mutually exclusive with the Zone ID.
rulesetId String: The unique ID of the ruleset.
zoneId String: The Zone ID to use for this endpoint. Mutually exclusive with the Account ID.

Supporting Types

GetRulesetRule

Action string: The action to perform when the rule matches. Available values: "block".
ActionParameters GetRulesetRuleActionParameters: The parameters configuring the rule's action.
Categories List<string>: The categories of the rule.
Description string: An informative description of the rule.
Enabled bool: Whether the rule should be executed.
ExposedCredentialCheck GetRulesetRuleExposedCredentialCheck: Configure checks for exposed credentials.
Expression string: The expression defining which traffic will match the rule.
Id string: The unique ID of the rule.
Logging GetRulesetRuleLogging: An object configuring the rule's logging behavior.
Ratelimit GetRulesetRuleRatelimit: An object configuring the rule's ratelimit behavior.
Ref string: The reference of the rule (the rule ID by default).

Action string: The action to perform when the rule matches. Available values: "block".
ActionParameters GetRulesetRuleActionParameters: The parameters configuring the rule's action.
Categories []string: The categories of the rule.
Description string: An informative description of the rule.
Enabled bool: Whether the rule should be executed.
ExposedCredentialCheck GetRulesetRuleExposedCredentialCheck: Configure checks for exposed credentials.
Expression string: The expression defining which traffic will match the rule.
Id string: The unique ID of the rule.
Logging GetRulesetRuleLogging: An object configuring the rule's logging behavior.
Ratelimit GetRulesetRuleRatelimit: An object configuring the rule's ratelimit behavior.
Ref string: The reference of the rule (the rule ID by default).

action String: The action to perform when the rule matches. Available values: "block".
actionParameters GetRulesetRuleActionParameters: The parameters configuring the rule's action.
categories List<String>: The categories of the rule.
description String: An informative description of the rule.
enabled Boolean: Whether the rule should be executed.
exposedCredentialCheck GetRulesetRuleExposedCredentialCheck: Configure checks for exposed credentials.
expression String: The expression defining which traffic will match the rule.
id String: The unique ID of the rule.
logging GetRulesetRuleLogging: An object configuring the rule's logging behavior.
ratelimit GetRulesetRuleRatelimit: An object configuring the rule's ratelimit behavior.
ref String: The reference of the rule (the rule ID by default).

action string: The action to perform when the rule matches. Available values: "block".
actionParameters GetRulesetRuleActionParameters: The parameters configuring the rule's action.
categories string[]: The categories of the rule.
description string: An informative description of the rule.
enabled boolean: Whether the rule should be executed.
exposedCredentialCheck GetRulesetRuleExposedCredentialCheck: Configure checks for exposed credentials.
expression string: The expression defining which traffic will match the rule.
id string: The unique ID of the rule.
logging GetRulesetRuleLogging: An object configuring the rule's logging behavior.
ratelimit GetRulesetRuleRatelimit: An object configuring the rule's ratelimit behavior.
ref string: The reference of the rule (the rule ID by default).

action str: The action to perform when the rule matches. Available values: "block".
action_parameters GetRulesetRuleActionParameters: The parameters configuring the rule's action.
categories Sequence[str]: The categories of the rule.
description str: An informative description of the rule.
enabled bool: Whether the rule should be executed.
exposed_credential_check GetRulesetRuleExposedCredentialCheck: Configure checks for exposed credentials.
expression str: The expression defining which traffic will match the rule.
id str: The unique ID of the rule.
logging GetRulesetRuleLogging: An object configuring the rule's logging behavior.
ratelimit GetRulesetRuleRatelimit: An object configuring the rule's ratelimit behavior.
ref str: The reference of the rule (the rule ID by default).

action String: The action to perform when the rule matches. Available values: "block".
actionParameters Property Map: The parameters configuring the rule's action.
categories List<String>: The categories of the rule.
description String: An informative description of the rule.
enabled Boolean: Whether the rule should be executed.
exposedCredentialCheck Property Map: Configure checks for exposed credentials.
expression String: The expression defining which traffic will match the rule.
id String: The unique ID of the rule.
logging Property Map: An object configuring the rule's logging behavior.
ratelimit Property Map: An object configuring the rule's ratelimit behavior.
ref String: The reference of the rule (the rule ID by default).

GetRulesetRuleActionParameters

AdditionalCacheablePorts List<int>: List of additional ports that caching can be enabled on.
Algorithms List<GetRulesetRuleActionParametersAlgorithm>: Custom order for compression algorithms.
AutomaticHttpsRewrites bool: Turn on or off Automatic HTTPS Rewrites.
Autominify GetRulesetRuleActionParametersAutominify: Select which file extensions to minify automatically.
Bic bool: Turn on or off Browser Integrity Check.
BrowserTtl GetRulesetRuleActionParametersBrowserTtl: 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.
Cache bool: 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.
CacheKey GetRulesetRuleActionParametersCacheKey: Define which components of the request are included or excluded from the cache key Cloudflare uses to store the response in cache.
CacheReserve GetRulesetRuleActionParametersCacheReserve: Mark whether the request's response from origin is eligible for Cache Reserve (requires a Cache Reserve add-on plan).
Content string: Error response content.
ContentType string: Content-type header to set with the response. Available values: "application/json", "text/xml", "text/plain", "text/html".
CookieFields List<GetRulesetRuleActionParametersCookieField>: The cookie fields to log.
DisableApps bool: Turn off all active Cloudflare Apps.
DisableRum bool: Turn off Real User Monitoring (RUM).
DisableZaraz bool: Turn off Zaraz.
EdgeTtl GetRulesetRuleActionParametersEdgeTtl: TTL (Time to Live) specifies the maximum time to cache a resource in the Cloudflare edge network.
EmailObfuscation bool: Turn on or off Email Obfuscation.
Fonts bool: Turn on or off Cloudflare Fonts.
FromList GetRulesetRuleActionParametersFromList: Serve a redirect based on a bulk list lookup.
FromValue GetRulesetRuleActionParametersFromValue: Serve a redirect based on the request properties.
Headers Dictionary<string, GetRulesetRuleActionParametersHeaders>: Map of request headers to modify.
HostHeader string: Rewrite the HTTP Host header.
HotlinkProtection bool: Turn on or off the Hotlink Protection.
Id string: The ID of the ruleset to execute.
Increment int: Increment contains the delta to change the score and can be either positive or negative.
MatchedData GetRulesetRuleActionParametersMatchedData: The configuration to use for matched data logging.
Mirage bool: Turn on or off Mirage.
OpportunisticEncryption bool: Turn on or off Opportunistic Encryption.
Origin GetRulesetRuleActionParametersOrigin: Override the IP/TCP destination.
OriginCacheControl bool: When enabled, Cloudflare will aim to strictly adhere to RFC 7234.
OriginErrorPagePassthru bool: Generate Cloudflare error pages from issues sent from the origin server. When on, error pages will trigger for issues from the origin
Overrides GetRulesetRuleActionParametersOverrides: A set of overrides to apply to the target ruleset.
Phases List<string>: A list of phases to skip the execution of. This option is incompatible with the ruleset and rulesets options.
Polish string: Configure the Polish level. Available values: "off", "lossless", "lossy".
Products List<string>: A list of legacy security products to skip the execution of.
RawResponseFields List<GetRulesetRuleActionParametersRawResponseField>: The raw response fields to log.
ReadTimeout int: 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.
RequestFields List<GetRulesetRuleActionParametersRequestField>: The raw request fields to log.
RespectStrongEtags bool: Specify whether or not Cloudflare should respect strong ETag (entity tag) headers. When off, Cloudflare converts strong ETag headers to weak ETag headers.
Response GetRulesetRuleActionParametersResponse: The response to show when the block is applied.
ResponseFields List<GetRulesetRuleActionParametersResponseField>: The transformed response fields to log.
RocketLoader bool: Turn on or off Rocket Loader
Rules Dictionary<string, ImmutableArray<string>>: 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.
Ruleset string: A ruleset to skip the execution of. This option is incompatible with the rulesets, rules and phases options. Available values: "current".
Rulesets List<string>: A list of ruleset IDs to skip the execution of. This option is incompatible with the ruleset and phases options.
SecurityLevel string: Configure the Security Level. Available values: "off", "essentiallyoff", "low", "medium", "high", "underattack".
ServeStale GetRulesetRuleActionParametersServeStale: 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.
ServerSideExcludes bool: Turn on or off Server Side Excludes.
Sni GetRulesetRuleActionParametersSni: Override the Server Name Indication (SNI).
Ssl string: Configure the SSL level. Available values: "off", "flexible", "full", "strict", "origin_pull".
StatusCode double: The status code to use for the error.
Sxg bool: Turn on or off Signed Exchanges (SXG).
TransformedRequestFields List<GetRulesetRuleActionParametersTransformedRequestField>: The transformed request fields to log.
Uri GetRulesetRuleActionParametersUri: URI to rewrite the request to.

AdditionalCacheablePorts []int: List of additional ports that caching can be enabled on.
Algorithms []GetRulesetRuleActionParametersAlgorithm: Custom order for compression algorithms.
AutomaticHttpsRewrites bool: Turn on or off Automatic HTTPS Rewrites.
Autominify GetRulesetRuleActionParametersAutominify: Select which file extensions to minify automatically.
Bic bool: Turn on or off Browser Integrity Check.
BrowserTtl GetRulesetRuleActionParametersBrowserTtl: 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.
Cache bool: 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.
CacheKey GetRulesetRuleActionParametersCacheKey: Define which components of the request are included or excluded from the cache key Cloudflare uses to store the response in cache.
CacheReserve GetRulesetRuleActionParametersCacheReserve: Mark whether the request's response from origin is eligible for Cache Reserve (requires a Cache Reserve add-on plan).
Content string: Error response content.
ContentType string: Content-type header to set with the response. Available values: "application/json", "text/xml", "text/plain", "text/html".
CookieFields []GetRulesetRuleActionParametersCookieField: The cookie fields to log.
DisableApps bool: Turn off all active Cloudflare Apps.
DisableRum bool: Turn off Real User Monitoring (RUM).
DisableZaraz bool: Turn off Zaraz.
EdgeTtl GetRulesetRuleActionParametersEdgeTtl: TTL (Time to Live) specifies the maximum time to cache a resource in the Cloudflare edge network.
EmailObfuscation bool: Turn on or off Email Obfuscation.
Fonts bool: Turn on or off Cloudflare Fonts.
FromList GetRulesetRuleActionParametersFromList: Serve a redirect based on a bulk list lookup.
FromValue GetRulesetRuleActionParametersFromValue: Serve a redirect based on the request properties.
Headers map[string]GetRulesetRuleActionParametersHeaders: Map of request headers to modify.
HostHeader string: Rewrite the HTTP Host header.
HotlinkProtection bool: Turn on or off the Hotlink Protection.
Id string: The ID of the ruleset to execute.
Increment int: Increment contains the delta to change the score and can be either positive or negative.
MatchedData GetRulesetRuleActionParametersMatchedData: The configuration to use for matched data logging.
Mirage bool: Turn on or off Mirage.
OpportunisticEncryption bool: Turn on or off Opportunistic Encryption.
Origin GetRulesetRuleActionParametersOrigin: Override the IP/TCP destination.
OriginCacheControl bool: When enabled, Cloudflare will aim to strictly adhere to RFC 7234.
OriginErrorPagePassthru bool: Generate Cloudflare error pages from issues sent from the origin server. When on, error pages will trigger for issues from the origin
Overrides GetRulesetRuleActionParametersOverrides: A set of overrides to apply to the target ruleset.
Phases []string: A list of phases to skip the execution of. This option is incompatible with the ruleset and rulesets options.
Polish string: Configure the Polish level. Available values: "off", "lossless", "lossy".
Products []string: A list of legacy security products to skip the execution of.
RawResponseFields []GetRulesetRuleActionParametersRawResponseField: The raw response fields to log.
ReadTimeout int: 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.
RequestFields []GetRulesetRuleActionParametersRequestField: The raw request fields to log.
RespectStrongEtags bool: Specify whether or not Cloudflare should respect strong ETag (entity tag) headers. When off, Cloudflare converts strong ETag headers to weak ETag headers.
Response GetRulesetRuleActionParametersResponse: The response to show when the block is applied.
ResponseFields []GetRulesetRuleActionParametersResponseField: The transformed response fields to log.
RocketLoader bool: Turn on or off Rocket Loader
Rules map[string][]string: 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.
Ruleset string: A ruleset to skip the execution of. This option is incompatible with the rulesets, rules and phases options. Available values: "current".
Rulesets []string: A list of ruleset IDs to skip the execution of. This option is incompatible with the ruleset and phases options.
SecurityLevel string: Configure the Security Level. Available values: "off", "essentiallyoff", "low", "medium", "high", "underattack".
ServeStale GetRulesetRuleActionParametersServeStale: 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.
ServerSideExcludes bool: Turn on or off Server Side Excludes.
Sni GetRulesetRuleActionParametersSni: Override the Server Name Indication (SNI).
Ssl string: Configure the SSL level. Available values: "off", "flexible", "full", "strict", "origin_pull".
StatusCode float64: The status code to use for the error.
Sxg bool: Turn on or off Signed Exchanges (SXG).
TransformedRequestFields []GetRulesetRuleActionParametersTransformedRequestField: The transformed request fields to log.
Uri GetRulesetRuleActionParametersUri: URI to rewrite the request to.

additionalCacheablePorts List<Integer>: List of additional ports that caching can be enabled on.
algorithms List<GetRulesetRuleActionParametersAlgorithm>: Custom order for compression algorithms.
automaticHttpsRewrites Boolean: Turn on or off Automatic HTTPS Rewrites.
autominify GetRulesetRuleActionParametersAutominify: Select which file extensions to minify automatically.
bic Boolean: Turn on or off Browser Integrity Check.
browserTtl GetRulesetRuleActionParametersBrowserTtl: 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.
cache Boolean: 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.
cacheKey GetRulesetRuleActionParametersCacheKey: Define which components of the request are included or excluded from the cache key Cloudflare uses to store the response in cache.
cacheReserve GetRulesetRuleActionParametersCacheReserve: Mark whether the request's response from origin is eligible for Cache Reserve (requires a Cache Reserve add-on plan).
content String: Error response content.
contentType String: Content-type header to set with the response. Available values: "application/json", "text/xml", "text/plain", "text/html".
cookieFields List<GetRulesetRuleActionParametersCookieField>: The cookie fields to log.
disableApps Boolean: Turn off all active Cloudflare Apps.
disableRum Boolean: Turn off Real User Monitoring (RUM).
disableZaraz Boolean: Turn off Zaraz.
edgeTtl GetRulesetRuleActionParametersEdgeTtl: TTL (Time to Live) specifies the maximum time to cache a resource in the Cloudflare edge network.
emailObfuscation Boolean: Turn on or off Email Obfuscation.
fonts Boolean: Turn on or off Cloudflare Fonts.
fromList GetRulesetRuleActionParametersFromList: Serve a redirect based on a bulk list lookup.
fromValue GetRulesetRuleActionParametersFromValue: Serve a redirect based on the request properties.
headers Map<String,GetRulesetRuleActionParametersHeaders>: Map of request headers to modify.
hostHeader String: Rewrite the HTTP Host header.
hotlinkProtection Boolean: Turn on or off the Hotlink Protection.
id String: The ID of the ruleset to execute.
increment Integer: Increment contains the delta to change the score and can be either positive or negative.
matchedData GetRulesetRuleActionParametersMatchedData: The configuration to use for matched data logging.
mirage Boolean: Turn on or off Mirage.
opportunisticEncryption Boolean: Turn on or off Opportunistic Encryption.
origin GetRulesetRuleActionParametersOrigin: Override the IP/TCP destination.
originCacheControl Boolean: When enabled, Cloudflare will aim to strictly adhere to RFC 7234.
originErrorPagePassthru Boolean: Generate Cloudflare error pages from issues sent from the origin server. When on, error pages will trigger for issues from the origin
overrides GetRulesetRuleActionParametersOverrides: A set of overrides to apply to the target ruleset.
phases List<String>: A list of phases to skip the execution of. This option is incompatible with the ruleset and rulesets options.
polish String: Configure the Polish level. Available values: "off", "lossless", "lossy".
products List<String>: A list of legacy security products to skip the execution of.
rawResponseFields List<GetRulesetRuleActionParametersRawResponseField>: The raw response fields to log.
readTimeout Integer: 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.
requestFields List<GetRulesetRuleActionParametersRequestField>: The raw request fields to log.
respectStrongEtags Boolean: Specify whether or not Cloudflare should respect strong ETag (entity tag) headers. When off, Cloudflare converts strong ETag headers to weak ETag headers.
response GetRulesetRuleActionParametersResponse: The response to show when the block is applied.
responseFields List<GetRulesetRuleActionParametersResponseField>: The transformed response fields to log.
rocketLoader Boolean: Turn on or off Rocket Loader
rules Map<String,List<String>>: 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.
ruleset String: A ruleset to skip the execution of. This option is incompatible with the rulesets, rules and phases options. Available values: "current".
rulesets List<String>: A list of ruleset IDs to skip the execution of. This option is incompatible with the ruleset and phases options.
securityLevel String: Configure the Security Level. Available values: "off", "essentiallyoff", "low", "medium", "high", "underattack".
serveStale GetRulesetRuleActionParametersServeStale: 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.
serverSideExcludes Boolean: Turn on or off Server Side Excludes.
sni GetRulesetRuleActionParametersSni: Override the Server Name Indication (SNI).
ssl String: Configure the SSL level. Available values: "off", "flexible", "full", "strict", "origin_pull".
statusCode Double: The status code to use for the error.
sxg Boolean: Turn on or off Signed Exchanges (SXG).
transformedRequestFields List<GetRulesetRuleActionParametersTransformedRequestField>: The transformed request fields to log.
uri GetRulesetRuleActionParametersUri: URI to rewrite the request to.

additionalCacheablePorts number[]: List of additional ports that caching can be enabled on.
algorithms GetRulesetRuleActionParametersAlgorithm[]: Custom order for compression algorithms.
automaticHttpsRewrites boolean: Turn on or off Automatic HTTPS Rewrites.
autominify GetRulesetRuleActionParametersAutominify: Select which file extensions to minify automatically.
bic boolean: Turn on or off Browser Integrity Check.
browserTtl GetRulesetRuleActionParametersBrowserTtl: 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.
cache boolean: 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.
cacheKey GetRulesetRuleActionParametersCacheKey: Define which components of the request are included or excluded from the cache key Cloudflare uses to store the response in cache.
cacheReserve GetRulesetRuleActionParametersCacheReserve: Mark whether the request's response from origin is eligible for Cache Reserve (requires a Cache Reserve add-on plan).
content string: Error response content.
contentType string: Content-type header to set with the response. Available values: "application/json", "text/xml", "text/plain", "text/html".
cookieFields GetRulesetRuleActionParametersCookieField[]: The cookie fields to log.
disableApps boolean: Turn off all active Cloudflare Apps.
disableRum boolean: Turn off Real User Monitoring (RUM).
disableZaraz boolean: Turn off Zaraz.
edgeTtl GetRulesetRuleActionParametersEdgeTtl: TTL (Time to Live) specifies the maximum time to cache a resource in the Cloudflare edge network.
emailObfuscation boolean: Turn on or off Email Obfuscation.
fonts boolean: Turn on or off Cloudflare Fonts.
fromList GetRulesetRuleActionParametersFromList: Serve a redirect based on a bulk list lookup.
fromValue GetRulesetRuleActionParametersFromValue: Serve a redirect based on the request properties.
headers {[key: string]: GetRulesetRuleActionParametersHeaders}: Map of request headers to modify.
hostHeader string: Rewrite the HTTP Host header.
hotlinkProtection boolean: Turn on or off the Hotlink Protection.
id string: The ID of the ruleset to execute.
increment number: Increment contains the delta to change the score and can be either positive or negative.
matchedData GetRulesetRuleActionParametersMatchedData: The configuration to use for matched data logging.
mirage boolean: Turn on or off Mirage.
opportunisticEncryption boolean: Turn on or off Opportunistic Encryption.
origin GetRulesetRuleActionParametersOrigin: Override the IP/TCP destination.
originCacheControl boolean: When enabled, Cloudflare will aim to strictly adhere to RFC 7234.
originErrorPagePassthru boolean: Generate Cloudflare error pages from issues sent from the origin server. When on, error pages will trigger for issues from the origin
overrides GetRulesetRuleActionParametersOverrides: A set of overrides to apply to the target ruleset.
phases string[]: A list of phases to skip the execution of. This option is incompatible with the ruleset and rulesets options.
polish string: Configure the Polish level. Available values: "off", "lossless", "lossy".
products string[]: A list of legacy security products to skip the execution of.
rawResponseFields GetRulesetRuleActionParametersRawResponseField[]: The raw response fields to log.
readTimeout number: 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.
requestFields GetRulesetRuleActionParametersRequestField[]: The raw request fields to log.
respectStrongEtags boolean: Specify whether or not Cloudflare should respect strong ETag (entity tag) headers. When off, Cloudflare converts strong ETag headers to weak ETag headers.
response GetRulesetRuleActionParametersResponse: The response to show when the block is applied.
responseFields GetRulesetRuleActionParametersResponseField[]: The transformed response fields to log.
rocketLoader boolean: Turn on or off Rocket Loader
rules {[key: string]: string[]}: 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.
ruleset string: A ruleset to skip the execution of. This option is incompatible with the rulesets, rules and phases options. Available values: "current".
rulesets string[]: A list of ruleset IDs to skip the execution of. This option is incompatible with the ruleset and phases options.
securityLevel string: Configure the Security Level. Available values: "off", "essentiallyoff", "low", "medium", "high", "underattack".
serveStale GetRulesetRuleActionParametersServeStale: 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.
serverSideExcludes boolean: Turn on or off Server Side Excludes.
sni GetRulesetRuleActionParametersSni: Override the Server Name Indication (SNI).
ssl string: Configure the SSL level. Available values: "off", "flexible", "full", "strict", "origin_pull".
statusCode number: The status code to use for the error.
sxg boolean: Turn on or off Signed Exchanges (SXG).
transformedRequestFields GetRulesetRuleActionParametersTransformedRequestField[]: The transformed request fields to log.
uri GetRulesetRuleActionParametersUri: URI to rewrite the request to.

additional_cacheable_ports Sequence[int]: List of additional ports that caching can be enabled on.
algorithms Sequence[GetRulesetRuleActionParametersAlgorithm]: Custom order for compression algorithms.
automatic_https_rewrites bool: Turn on or off Automatic HTTPS Rewrites.
autominify GetRulesetRuleActionParametersAutominify: Select which file extensions to minify automatically.
bic bool: Turn on or off Browser Integrity Check.
browser_ttl GetRulesetRuleActionParametersBrowserTtl: 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.
cache bool: 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.
cache_key GetRulesetRuleActionParametersCacheKey: Define which components of the request are included or excluded from the cache key Cloudflare uses to store the response in cache.
cache_reserve GetRulesetRuleActionParametersCacheReserve: Mark whether the request's response from origin is eligible for Cache Reserve (requires a Cache Reserve add-on plan).
content str: Error response content.
content_type str: Content-type header to set with the response. Available values: "application/json", "text/xml", "text/plain", "text/html".
cookie_fields Sequence[GetRulesetRuleActionParametersCookieField]: The cookie fields to log.
disable_apps bool: Turn off all active Cloudflare Apps.
disable_rum bool: Turn off Real User Monitoring (RUM).
disable_zaraz bool: Turn off Zaraz.
edge_ttl GetRulesetRuleActionParametersEdgeTtl: TTL (Time to Live) specifies the maximum time to cache a resource in the Cloudflare edge network.
email_obfuscation bool: Turn on or off Email Obfuscation.
fonts bool: Turn on or off Cloudflare Fonts.
from_list GetRulesetRuleActionParametersFromList: Serve a redirect based on a bulk list lookup.
from_value GetRulesetRuleActionParametersFromValue: Serve a redirect based on the request properties.
headers Mapping[str, GetRulesetRuleActionParametersHeaders]: Map of request headers to modify.
host_header str: Rewrite the HTTP Host header.
hotlink_protection bool: Turn on or off the Hotlink Protection.
id str: The ID of the ruleset to execute.
increment int: Increment contains the delta to change the score and can be either positive or negative.
matched_data GetRulesetRuleActionParametersMatchedData: The configuration to use for matched data logging.
mirage bool: Turn on or off Mirage.
opportunistic_encryption bool: Turn on or off Opportunistic Encryption.
origin GetRulesetRuleActionParametersOrigin: Override the IP/TCP destination.
origin_cache_control bool: When enabled, Cloudflare will aim to strictly adhere to RFC 7234.
origin_error_page_passthru bool: Generate Cloudflare error pages from issues sent from the origin server. When on, error pages will trigger for issues from the origin
overrides GetRulesetRuleActionParametersOverrides: A set of overrides to apply to the target ruleset.
phases Sequence[str]: A list of phases to skip the execution of. This option is incompatible with the ruleset and rulesets options.
polish str: Configure the Polish level. Available values: "off", "lossless", "lossy".
products Sequence[str]: A list of legacy security products to skip the execution of.
raw_response_fields Sequence[GetRulesetRuleActionParametersRawResponseField]: The raw response fields to log.
read_timeout int: 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.
request_fields Sequence[GetRulesetRuleActionParametersRequestField]: The raw request fields to log.
respect_strong_etags bool: Specify whether or not Cloudflare should respect strong ETag (entity tag) headers. When off, Cloudflare converts strong ETag headers to weak ETag headers.
response GetRulesetRuleActionParametersResponse: The response to show when the block is applied.
response_fields Sequence[GetRulesetRuleActionParametersResponseField]: The transformed response fields to log.
rocket_loader bool: Turn on or off Rocket Loader
rules Mapping[str, Sequence[str]]: 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.
ruleset str: A ruleset to skip the execution of. This option is incompatible with the rulesets, rules and phases options. Available values: "current".
rulesets Sequence[str]: A list of ruleset IDs to skip the execution of. This option is incompatible with the ruleset and phases options.
security_level str: Configure the Security Level. Available values: "off", "essentiallyoff", "low", "medium", "high", "underattack".
serve_stale GetRulesetRuleActionParametersServeStale: 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.
server_side_excludes bool: Turn on or off Server Side Excludes.
sni GetRulesetRuleActionParametersSni: Override the Server Name Indication (SNI).
ssl str: Configure the SSL level. Available values: "off", "flexible", "full", "strict", "origin_pull".
status_code float: The status code to use for the error.
sxg bool: Turn on or off Signed Exchanges (SXG).
transformed_request_fields Sequence[GetRulesetRuleActionParametersTransformedRequestField]: The transformed request fields to log.
uri GetRulesetRuleActionParametersUri: URI to rewrite the request to.

additionalCacheablePorts List<Number>: List of additional ports that caching can be enabled on.
algorithms List<Property Map>: Custom order for compression algorithms.
automaticHttpsRewrites Boolean: Turn on or off Automatic HTTPS Rewrites.
autominify Property Map: Select which file extensions to minify automatically.
bic Boolean: Turn on or off Browser Integrity Check.
browserTtl Property Map: 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.
cache Boolean: 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.
cacheKey Property Map: Define which components of the request are included or excluded from the cache key Cloudflare uses to store the response in cache.
cacheReserve Property Map: Mark whether the request's response from origin is eligible for Cache Reserve (requires a Cache Reserve add-on plan).
content String: Error response content.
contentType String: Content-type header to set with the response. Available values: "application/json", "text/xml", "text/plain", "text/html".
cookieFields List<Property Map>: The cookie fields to log.
disableApps Boolean: Turn off all active Cloudflare Apps.
disableRum Boolean: Turn off Real User Monitoring (RUM).
disableZaraz Boolean: Turn off Zaraz.
edgeTtl Property Map: TTL (Time to Live) specifies the maximum time to cache a resource in the Cloudflare edge network.
emailObfuscation Boolean: Turn on or off Email Obfuscation.
fonts Boolean: Turn on or off Cloudflare Fonts.
fromList Property Map: Serve a redirect based on a bulk list lookup.
fromValue Property Map: Serve a redirect based on the request properties.
headers Map<Property Map>: Map of request headers to modify.
hostHeader String: Rewrite the HTTP Host header.
hotlinkProtection Boolean: Turn on or off the Hotlink Protection.
id String: The ID of the ruleset to execute.
increment Number: Increment contains the delta to change the score and can be either positive or negative.
matchedData Property Map: The configuration to use for matched data logging.
mirage Boolean: Turn on or off Mirage.
opportunisticEncryption Boolean: Turn on or off Opportunistic Encryption.
origin Property Map: Override the IP/TCP destination.
originCacheControl Boolean: When enabled, Cloudflare will aim to strictly adhere to RFC 7234.
originErrorPagePassthru Boolean: Generate Cloudflare error pages from issues sent from the origin server. When on, error pages will trigger for issues from the origin
overrides Property Map: A set of overrides to apply to the target ruleset.
phases List<String>: A list of phases to skip the execution of. This option is incompatible with the ruleset and rulesets options.
polish String: Configure the Polish level. Available values: "off", "lossless", "lossy".
products List<String>: A list of legacy security products to skip the execution of.
rawResponseFields List<Property Map>: The raw response fields to log.
readTimeout Number: 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.
requestFields List<Property Map>: The raw request fields to log.
respectStrongEtags Boolean: Specify whether or not Cloudflare should respect strong ETag (entity tag) headers. When off, Cloudflare converts strong ETag headers to weak ETag headers.
response Property Map: The response to show when the block is applied.
responseFields List<Property Map>: The transformed response fields to log.
rocketLoader Boolean: Turn on or off Rocket Loader
rules Map<List<String>>: 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.
ruleset String: A ruleset to skip the execution of. This option is incompatible with the rulesets, rules and phases options. Available values: "current".
rulesets List<String>: A list of ruleset IDs to skip the execution of. This option is incompatible with the ruleset and phases options.
securityLevel String: Configure the Security Level. Available values: "off", "essentiallyoff", "low", "medium", "high", "underattack".
serveStale Property Map: 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.
serverSideExcludes Boolean: Turn on or off Server Side Excludes.
sni Property Map: Override the Server Name Indication (SNI).
ssl String: Configure the SSL level. Available values: "off", "flexible", "full", "strict", "origin_pull".
statusCode Number: The status code to use for the error.
sxg Boolean: Turn on or off Signed Exchanges (SXG).
transformedRequestFields List<Property Map>: The transformed request fields to log.
uri Property Map: URI to rewrite the request to.

GetRulesetRuleActionParametersAlgorithm

Name string: Name of compression algorithm to enable. Available values: "none", "auto", "default", "gzip", "brotli".

Name string: Name of compression algorithm to enable. Available values: "none", "auto", "default", "gzip", "brotli".

name String: Name of compression algorithm to enable. Available values: "none", "auto", "default", "gzip", "brotli".

name string: Name of compression algorithm to enable. Available values: "none", "auto", "default", "gzip", "brotli".

name str: Name of compression algorithm to enable. Available values: "none", "auto", "default", "gzip", "brotli".

name String: Name of compression algorithm to enable. Available values: "none", "auto", "default", "gzip", "brotli".

GetRulesetRuleActionParametersAutominify

Css bool: Minify CSS files.
Html bool: Minify HTML files.
Js bool: Minify JS files.

Css bool: Minify CSS files.
Html bool: Minify HTML files.
Js bool: Minify JS files.

css Boolean: Minify CSS files.
html Boolean: Minify HTML files.
js Boolean: Minify JS files.

css boolean: Minify CSS files.
html boolean: Minify HTML files.
js boolean: Minify JS files.

css bool: Minify CSS files.
html bool: Minify HTML files.
js bool: Minify JS files.

css Boolean: Minify CSS files.
html Boolean: Minify HTML files.
js Boolean: Minify JS files.

GetRulesetRuleActionParametersBrowserTtl

Default int: The TTL (in seconds) if you choose override_origin mode.
Mode string: Determines which browser ttl mode to use. Available values: "respectorigin", "bypassbydefault", "overrideorigin".

Default int: The TTL (in seconds) if you choose override_origin mode.
Mode string: Determines which browser ttl mode to use. Available values: "respectorigin", "bypassbydefault", "overrideorigin".

default_ Integer: The TTL (in seconds) if you choose override_origin mode.
mode String: Determines which browser ttl mode to use. Available values: "respectorigin", "bypassbydefault", "overrideorigin".

default number: The TTL (in seconds) if you choose override_origin mode.
mode string: Determines which browser ttl mode to use. Available values: "respectorigin", "bypassbydefault", "overrideorigin".

default int: The TTL (in seconds) if you choose override_origin mode.
mode str: Determines which browser ttl mode to use. Available values: "respectorigin", "bypassbydefault", "overrideorigin".

default Number: The TTL (in seconds) if you choose override_origin mode.
mode String: Determines which browser ttl mode to use. Available values: "respectorigin", "bypassbydefault", "overrideorigin".

GetRulesetRuleActionParametersCacheKey

CacheByDeviceType bool: Separate cached content based on the visitor’s device type
CacheDeceptionArmor bool: Protect from web cache deception attacks while allowing static assets to be cached
CustomKey GetRulesetRuleActionParametersCacheKeyCustomKey: Customize which components of the request are included or excluded from the cache key.
IgnoreQueryStringsOrder bool: Treat requests with the same query parameters the same, regardless of the order those query parameters are in. A value of true ignores the query strings' order.

CacheByDeviceType bool: Separate cached content based on the visitor’s device type
CacheDeceptionArmor bool: Protect from web cache deception attacks while allowing static assets to be cached
CustomKey GetRulesetRuleActionParametersCacheKeyCustomKey: Customize which components of the request are included or excluded from the cache key.
IgnoreQueryStringsOrder bool: Treat requests with the same query parameters the same, regardless of the order those query parameters are in. A value of true ignores the query strings' order.

cacheByDeviceType Boolean: Separate cached content based on the visitor’s device type
cacheDeceptionArmor Boolean: Protect from web cache deception attacks while allowing static assets to be cached
customKey GetRulesetRuleActionParametersCacheKeyCustomKey: Customize which components of the request are included or excluded from the cache key.
ignoreQueryStringsOrder Boolean: Treat requests with the same query parameters the same, regardless of the order those query parameters are in. A value of true ignores the query strings' order.

cacheByDeviceType boolean: Separate cached content based on the visitor’s device type
cacheDeceptionArmor boolean: Protect from web cache deception attacks while allowing static assets to be cached
customKey GetRulesetRuleActionParametersCacheKeyCustomKey: Customize which components of the request are included or excluded from the cache key.
ignoreQueryStringsOrder boolean: Treat requests with the same query parameters the same, regardless of the order those query parameters are in. A value of true ignores the query strings' order.

cache_by_device_type bool: Separate cached content based on the visitor’s device type
cache_deception_armor bool: Protect from web cache deception attacks while allowing static assets to be cached
custom_key GetRulesetRuleActionParametersCacheKeyCustomKey: Customize which components of the request are included or excluded from the cache key.
ignore_query_strings_order bool: Treat requests with the same query parameters the same, regardless of the order those query parameters are in. A value of true ignores the query strings' order.

cacheByDeviceType Boolean: Separate cached content based on the visitor’s device type
cacheDeceptionArmor Boolean: Protect from web cache deception attacks while allowing static assets to be cached
customKey Property Map: Customize which components of the request are included or excluded from the cache key.
ignoreQueryStringsOrder Boolean: Treat requests with the same query parameters the same, regardless of the order those query parameters are in. A value of true ignores the query strings' order.

GetRulesetRuleActionParametersCacheKeyCustomKey

Cookie GetRulesetRuleActionParametersCacheKeyCustomKeyCookie: The cookies to include in building the cache key.
Header GetRulesetRuleActionParametersCacheKeyCustomKeyHeader: The header names and values to include in building the cache key.
Host GetRulesetRuleActionParametersCacheKeyCustomKeyHost: Whether to use the original host or the resolved host in the cache key.
QueryString GetRulesetRuleActionParametersCacheKeyCustomKeyQueryString: Use the presence of parameters in the query string to build the cache key.
User GetRulesetRuleActionParametersCacheKeyCustomKeyUser: Characteristics of the request user agent used in building the cache key.

Cookie GetRulesetRuleActionParametersCacheKeyCustomKeyCookie: The cookies to include in building the cache key.
Header GetRulesetRuleActionParametersCacheKeyCustomKeyHeader: The header names and values to include in building the cache key.
Host GetRulesetRuleActionParametersCacheKeyCustomKeyHost: Whether to use the original host or the resolved host in the cache key.
QueryString GetRulesetRuleActionParametersCacheKeyCustomKeyQueryString: Use the presence of parameters in the query string to build the cache key.
User GetRulesetRuleActionParametersCacheKeyCustomKeyUser: Characteristics of the request user agent used in building the cache key.

cookie GetRulesetRuleActionParametersCacheKeyCustomKeyCookie: The cookies to include in building the cache key.
header GetRulesetRuleActionParametersCacheKeyCustomKeyHeader: The header names and values to include in building the cache key.
host GetRulesetRuleActionParametersCacheKeyCustomKeyHost: Whether to use the original host or the resolved host in the cache key.
queryString GetRulesetRuleActionParametersCacheKeyCustomKeyQueryString: Use the presence of parameters in the query string to build the cache key.
user GetRulesetRuleActionParametersCacheKeyCustomKeyUser: Characteristics of the request user agent used in building the cache key.

cookie GetRulesetRuleActionParametersCacheKeyCustomKeyCookie: The cookies to include in building the cache key.
header GetRulesetRuleActionParametersCacheKeyCustomKeyHeader: The header names and values to include in building the cache key.
host GetRulesetRuleActionParametersCacheKeyCustomKeyHost: Whether to use the original host or the resolved host in the cache key.
queryString GetRulesetRuleActionParametersCacheKeyCustomKeyQueryString: Use the presence of parameters in the query string to build the cache key.
user GetRulesetRuleActionParametersCacheKeyCustomKeyUser: Characteristics of the request user agent used in building the cache key.

cookie GetRulesetRuleActionParametersCacheKeyCustomKeyCookie: The cookies to include in building the cache key.
header GetRulesetRuleActionParametersCacheKeyCustomKeyHeader: The header names and values to include in building the cache key.
host GetRulesetRuleActionParametersCacheKeyCustomKeyHost: Whether to use the original host or the resolved host in the cache key.
query_string GetRulesetRuleActionParametersCacheKeyCustomKeyQueryString: Use the presence of parameters in the query string to build the cache key.
user GetRulesetRuleActionParametersCacheKeyCustomKeyUser: Characteristics of the request user agent used in building the cache key.

cookie Property Map: The cookies to include in building the cache key.
header Property Map: The header names and values to include in building the cache key.
host Property Map: Whether to use the original host or the resolved host in the cache key.
queryString Property Map: Use the presence of parameters in the query string to build the cache key.
user Property Map: Characteristics of the request user agent used in building the cache key.

GetRulesetRuleActionParametersCacheKeyCustomKeyCookie

CheckPresences List<string>: Checks for the presence of these cookie names. The presence of these cookies is used in building the cache key.
Includes List<string>: Include these cookies' names and their values.

CheckPresences []string: Checks for the presence of these cookie names. The presence of these cookies is used in building the cache key.
Includes []string: Include these cookies' names and their values.

checkPresences List<String>: Checks for the presence of these cookie names. The presence of these cookies is used in building the cache key.
includes List<String>: Include these cookies' names and their values.

checkPresences string[]: Checks for the presence of these cookie names. The presence of these cookies is used in building the cache key.
includes string[]: Include these cookies' names and their values.

check_presences Sequence[str]: Checks for the presence of these cookie names. The presence of these cookies is used in building the cache key.
includes Sequence[str]: Include these cookies' names and their values.

checkPresences List<String>: Checks for the presence of these cookie names. The presence of these cookies is used in building the cache key.
includes List<String>: Include these cookies' names and their values.

GetRulesetRuleActionParametersCacheKeyCustomKeyHeader

CheckPresences List<string>: Checks for the presence of these header names. The presence of these headers is used in building the cache key.
Contains Dictionary<string, ImmutableArray<string>>: For each header name and list of values combination, check if the request header contains any of the values provided. The presence of the request header and whether any of the values provided are contained in the request header value is used in building the cache key.
ExcludeOrigin bool: Whether or not to include the origin header. A value of true will exclude the origin header in the cache key.
Includes List<string>: Include these headers' names and their values.

CheckPresences []string: Checks for the presence of these header names. The presence of these headers is used in building the cache key.
Contains map[string][]string: For each header name and list of values combination, check if the request header contains any of the values provided. The presence of the request header and whether any of the values provided are contained in the request header value is used in building the cache key.
ExcludeOrigin bool: Whether or not to include the origin header. A value of true will exclude the origin header in the cache key.
Includes []string: Include these headers' names and their values.

checkPresences List<String>: Checks for the presence of these header names. The presence of these headers is used in building the cache key.
contains Map<String,List<String>>: For each header name and list of values combination, check if the request header contains any of the values provided. The presence of the request header and whether any of the values provided are contained in the request header value is used in building the cache key.
excludeOrigin Boolean: Whether or not to include the origin header. A value of true will exclude the origin header in the cache key.
includes List<String>: Include these headers' names and their values.

checkPresences string[]: Checks for the presence of these header names. The presence of these headers is used in building the cache key.
contains {[key: string]: string[]}: For each header name and list of values combination, check if the request header contains any of the values provided. The presence of the request header and whether any of the values provided are contained in the request header value is used in building the cache key.
excludeOrigin boolean: Whether or not to include the origin header. A value of true will exclude the origin header in the cache key.
includes string[]: Include these headers' names and their values.

check_presences Sequence[str]: Checks for the presence of these header names. The presence of these headers is used in building the cache key.
contains Mapping[str, Sequence[str]]: For each header name and list of values combination, check if the request header contains any of the values provided. The presence of the request header and whether any of the values provided are contained in the request header value is used in building the cache key.
exclude_origin bool: Whether or not to include the origin header. A value of true will exclude the origin header in the cache key.
includes Sequence[str]: Include these headers' names and their values.

checkPresences List<String>: Checks for the presence of these header names. The presence of these headers is used in building the cache key.
contains Map<List<String>>: For each header name and list of values combination, check if the request header contains any of the values provided. The presence of the request header and whether any of the values provided are contained in the request header value is used in building the cache key.
excludeOrigin Boolean: Whether or not to include the origin header. A value of true will exclude the origin header in the cache key.
includes List<String>: Include these headers' names and their values.

GetRulesetRuleActionParametersCacheKeyCustomKeyHost

Resolved bool: Use the resolved host in the cache key. A value of true will use the resolved host, while a value or false will use the original host.

Resolved bool: Use the resolved host in the cache key. A value of true will use the resolved host, while a value or false will use the original host.

resolved Boolean: Use the resolved host in the cache key. A value of true will use the resolved host, while a value or false will use the original host.

resolved boolean: Use the resolved host in the cache key. A value of true will use the resolved host, while a value or false will use the original host.

resolved bool: Use the resolved host in the cache key. A value of true will use the resolved host, while a value or false will use the original host.

resolved Boolean: Use the resolved host in the cache key. A value of true will use the resolved host, while a value or false will use the original host.

GetRulesetRuleActionParametersCacheKeyCustomKeyQueryString

Exclude GetRulesetRuleActionParametersCacheKeyCustomKeyQueryStringExclude: A list of query string parameters NOT used to build the cache key. All parameters present in the request but missing in this list will be used to build the cache key.
Include GetRulesetRuleActionParametersCacheKeyCustomKeyQueryStringInclude: A list of query string parameters used to build the cache key.

Exclude GetRulesetRuleActionParametersCacheKeyCustomKeyQueryStringExclude: A list of query string parameters NOT used to build the cache key. All parameters present in the request but missing in this list will be used to build the cache key.
Include GetRulesetRuleActionParametersCacheKeyCustomKeyQueryStringInclude: A list of query string parameters used to build the cache key.

exclude GetRulesetRuleActionParametersCacheKeyCustomKeyQueryStringExclude: A list of query string parameters NOT used to build the cache key. All parameters present in the request but missing in this list will be used to build the cache key.
include GetRulesetRuleActionParametersCacheKeyCustomKeyQueryStringInclude: A list of query string parameters used to build the cache key.

exclude GetRulesetRuleActionParametersCacheKeyCustomKeyQueryStringExclude: A list of query string parameters NOT used to build the cache key. All parameters present in the request but missing in this list will be used to build the cache key.
include GetRulesetRuleActionParametersCacheKeyCustomKeyQueryStringInclude: A list of query string parameters used to build the cache key.

exclude GetRulesetRuleActionParametersCacheKeyCustomKeyQueryStringExclude: A list of query string parameters NOT used to build the cache key. All parameters present in the request but missing in this list will be used to build the cache key.
include GetRulesetRuleActionParametersCacheKeyCustomKeyQueryStringInclude: A list of query string parameters used to build the cache key.

exclude Property Map: A list of query string parameters NOT used to build the cache key. All parameters present in the request but missing in this list will be used to build the cache key.
include Property Map: A list of query string parameters used to build the cache key.

GetRulesetRuleActionParametersCacheKeyCustomKeyQueryStringExclude

All bool: Determines whether to exclude all query string parameters from the cache key.
Lists List<string>

All bool: Determines whether to exclude all query string parameters from the cache key.
Lists []string

all Boolean: Determines whether to exclude all query string parameters from the cache key.
lists List<String>

all boolean: Determines whether to exclude all query string parameters from the cache key.
lists string[]

all bool: Determines whether to exclude all query string parameters from the cache key.
lists Sequence[str]

all Boolean: Determines whether to exclude all query string parameters from the cache key.
lists List<String>

GetRulesetRuleActionParametersCacheKeyCustomKeyQueryStringInclude

All bool: Determines whether to include all query string parameters in the cache key.
Lists List<string>

All bool: Determines whether to include all query string parameters in the cache key.
Lists []string

all Boolean: Determines whether to include all query string parameters in the cache key.
lists List<String>

all boolean: Determines whether to include all query string parameters in the cache key.
lists string[]

all bool: Determines whether to include all query string parameters in the cache key.
lists Sequence[str]

all Boolean: Determines whether to include all query string parameters in the cache key.
lists List<String>

GetRulesetRuleActionParametersCacheKeyCustomKeyUser

DeviceType bool: Use the user agent's device type in the cache key.
Geo bool: Use the user agents's country in the cache key.
Lang bool: Use the user agent's language in the cache key.

DeviceType bool: Use the user agent's device type in the cache key.
Geo bool: Use the user agents's country in the cache key.
Lang bool: Use the user agent's language in the cache key.

deviceType Boolean: Use the user agent's device type in the cache key.
geo Boolean: Use the user agents's country in the cache key.
lang Boolean: Use the user agent's language in the cache key.

deviceType boolean: Use the user agent's device type in the cache key.
geo boolean: Use the user agents's country in the cache key.
lang boolean: Use the user agent's language in the cache key.

device_type bool: Use the user agent's device type in the cache key.
geo bool: Use the user agents's country in the cache key.
lang bool: Use the user agent's language in the cache key.

deviceType Boolean: Use the user agent's device type in the cache key.
geo Boolean: Use the user agents's country in the cache key.
lang Boolean: Use the user agent's language in the cache key.

GetRulesetRuleActionParametersCacheReserve

Eligible bool: Determines whether cache reserve is enabled. If this is true and a request meets eligibility criteria, Cloudflare will write the resource to cache reserve.
MinimumFileSize int: The minimum file size eligible for store in cache reserve.

Eligible bool: Determines whether cache reserve is enabled. If this is true and a request meets eligibility criteria, Cloudflare will write the resource to cache reserve.
MinimumFileSize int: The minimum file size eligible for store in cache reserve.

eligible Boolean: Determines whether cache reserve is enabled. If this is true and a request meets eligibility criteria, Cloudflare will write the resource to cache reserve.
minimumFileSize Integer: The minimum file size eligible for store in cache reserve.

eligible boolean: Determines whether cache reserve is enabled. If this is true and a request meets eligibility criteria, Cloudflare will write the resource to cache reserve.
minimumFileSize number: The minimum file size eligible for store in cache reserve.

eligible bool: Determines whether cache reserve is enabled. If this is true and a request meets eligibility criteria, Cloudflare will write the resource to cache reserve.
minimum_file_size int: The minimum file size eligible for store in cache reserve.

eligible Boolean: Determines whether cache reserve is enabled. If this is true and a request meets eligibility criteria, Cloudflare will write the resource to cache reserve.
minimumFileSize Number: The minimum file size eligible for store in cache reserve.

GetRulesetRuleActionParametersCookieField

Name string: The name of the field.

Name string: The name of the field.

name String: The name of the field.

name string: The name of the field.

name str: The name of the field.

name String: The name of the field.

GetRulesetRuleActionParametersEdgeTtl

Default int: The TTL (in seconds) if you choose override_origin mode.
Mode string: edge ttl options Available values: "respectorigin", "bypassbydefault", "overrideorigin".
StatusCodeTtls List<GetRulesetRuleActionParametersEdgeTtlStatusCodeTtl>: List of single status codes, or status code ranges to apply the selected mode

Default int: The TTL (in seconds) if you choose override_origin mode.
Mode string: edge ttl options Available values: "respectorigin", "bypassbydefault", "overrideorigin".
StatusCodeTtls []GetRulesetRuleActionParametersEdgeTtlStatusCodeTtl: List of single status codes, or status code ranges to apply the selected mode

default_ Integer: The TTL (in seconds) if you choose override_origin mode.
mode String: edge ttl options Available values: "respectorigin", "bypassbydefault", "overrideorigin".
statusCodeTtls List<GetRulesetRuleActionParametersEdgeTtlStatusCodeTtl>: List of single status codes, or status code ranges to apply the selected mode

default number: The TTL (in seconds) if you choose override_origin mode.
mode string: edge ttl options Available values: "respectorigin", "bypassbydefault", "overrideorigin".
statusCodeTtls GetRulesetRuleActionParametersEdgeTtlStatusCodeTtl[]: List of single status codes, or status code ranges to apply the selected mode

default int: The TTL (in seconds) if you choose override_origin mode.
mode str: edge ttl options Available values: "respectorigin", "bypassbydefault", "overrideorigin".
status_code_ttls Sequence[GetRulesetRuleActionParametersEdgeTtlStatusCodeTtl]: List of single status codes, or status code ranges to apply the selected mode

default Number: The TTL (in seconds) if you choose override_origin mode.
mode String: edge ttl options Available values: "respectorigin", "bypassbydefault", "overrideorigin".
statusCodeTtls List<Property Map>: List of single status codes, or status code ranges to apply the selected mode

GetRulesetRuleActionParametersEdgeTtlStatusCodeTtl

StatusCodeRange GetRulesetRuleActionParametersEdgeTtlStatusCodeTtlStatusCodeRange: The range of status codes used to apply the selected mode.
StatusCodeValue int: Set the ttl for responses with this specific status code
Value int: Time to cache a response (in seconds). A value of 0 is equivalent to setting the Cache-Control header with the value "no-cache". A value of -1 is equivalent to setting Cache-Control header with the value of "no-store".

StatusCodeRange GetRulesetRuleActionParametersEdgeTtlStatusCodeTtlStatusCodeRange: The range of status codes used to apply the selected mode.
StatusCodeValue int: Set the ttl for responses with this specific status code
Value int: Time to cache a response (in seconds). A value of 0 is equivalent to setting the Cache-Control header with the value "no-cache". A value of -1 is equivalent to setting Cache-Control header with the value of "no-store".

statusCodeRange GetRulesetRuleActionParametersEdgeTtlStatusCodeTtlStatusCodeRange: The range of status codes used to apply the selected mode.
statusCodeValue Integer: Set the ttl for responses with this specific status code
value Integer: Time to cache a response (in seconds). A value of 0 is equivalent to setting the Cache-Control header with the value "no-cache". A value of -1 is equivalent to setting Cache-Control header with the value of "no-store".

statusCodeRange GetRulesetRuleActionParametersEdgeTtlStatusCodeTtlStatusCodeRange: The range of status codes used to apply the selected mode.
statusCodeValue number: Set the ttl for responses with this specific status code
value number: Time to cache a response (in seconds). A value of 0 is equivalent to setting the Cache-Control header with the value "no-cache". A value of -1 is equivalent to setting Cache-Control header with the value of "no-store".

status_code_range GetRulesetRuleActionParametersEdgeTtlStatusCodeTtlStatusCodeRange: The range of status codes used to apply the selected mode.
status_code_value int: Set the ttl for responses with this specific status code
value int: Time to cache a response (in seconds). A value of 0 is equivalent to setting the Cache-Control header with the value "no-cache". A value of -1 is equivalent to setting Cache-Control header with the value of "no-store".

statusCodeRange Property Map: The range of status codes used to apply the selected mode.
statusCodeValue Number: Set the ttl for responses with this specific status code
value Number: Time to cache a response (in seconds). A value of 0 is equivalent to setting the Cache-Control header with the value "no-cache". A value of -1 is equivalent to setting Cache-Control header with the value of "no-store".

GetRulesetRuleActionParametersEdgeTtlStatusCodeTtlStatusCodeRange

From int: response status code lower bound
To int: response status code upper bound

From int: response status code lower bound
To int: response status code upper bound

from Integer: response status code lower bound
to Integer: response status code upper bound

from number: response status code lower bound
to number: response status code upper bound

from_ int: response status code lower bound
to int: response status code upper bound

from Number: response status code lower bound
to Number: response status code upper bound

GetRulesetRuleActionParametersFromList

Key string: Expression that evaluates to the list lookup key.
Name string: The name of the list to match against.

Key string: Expression that evaluates to the list lookup key.
Name string: The name of the list to match against.

key String: Expression that evaluates to the list lookup key.
name String: The name of the list to match against.

key string: Expression that evaluates to the list lookup key.
name string: The name of the list to match against.

key str: Expression that evaluates to the list lookup key.
name str: The name of the list to match against.

key String: Expression that evaluates to the list lookup key.
name String: The name of the list to match against.

GetRulesetRuleActionParametersFromValue

PreserveQueryString bool: Keep the query string of the original request.
StatusCode double: The status code to be used for the redirect. Available values: 301, 302, 303, 307, 308.
TargetUrl GetRulesetRuleActionParametersFromValueTargetUrl: The URL to redirect the request to.

PreserveQueryString bool: Keep the query string of the original request.
StatusCode float64: The status code to be used for the redirect. Available values: 301, 302, 303, 307, 308.
TargetUrl GetRulesetRuleActionParametersFromValueTargetUrl: The URL to redirect the request to.

preserveQueryString Boolean: Keep the query string of the original request.
statusCode Double: The status code to be used for the redirect. Available values: 301, 302, 303, 307, 308.
targetUrl GetRulesetRuleActionParametersFromValueTargetUrl: The URL to redirect the request to.

preserveQueryString boolean: Keep the query string of the original request.
statusCode number: The status code to be used for the redirect. Available values: 301, 302, 303, 307, 308.
targetUrl GetRulesetRuleActionParametersFromValueTargetUrl: The URL to redirect the request to.

preserve_query_string bool: Keep the query string of the original request.
status_code float: The status code to be used for the redirect. Available values: 301, 302, 303, 307, 308.
target_url GetRulesetRuleActionParametersFromValueTargetUrl: The URL to redirect the request to.

preserveQueryString Boolean: Keep the query string of the original request.
statusCode Number: The status code to be used for the redirect. Available values: 301, 302, 303, 307, 308.
targetUrl Property Map: The URL to redirect the request to.

GetRulesetRuleActionParametersFromValueTargetUrl

Expression string: An expression to evaluate to get the URL to redirect the request to.
Value string: The URL to redirect the request to.

Expression string: An expression to evaluate to get the URL to redirect the request to.
Value string: The URL to redirect the request to.

expression String: An expression to evaluate to get the URL to redirect the request to.
value String: The URL to redirect the request to.

expression string: An expression to evaluate to get the URL to redirect the request to.
value string: The URL to redirect the request to.

expression str: An expression to evaluate to get the URL to redirect the request to.
value str: The URL to redirect the request to.

expression String: An expression to evaluate to get the URL to redirect the request to.
value String: The URL to redirect the request to.

GetRulesetRuleActionParametersHeaders

Expression string: Expression for the header value.
Operation string: Available values: "remove".
Value string: Static value for the header.

Expression string: Expression for the header value.
Operation string: Available values: "remove".
Value string: Static value for the header.

expression String: Expression for the header value.
operation String: Available values: "remove".
value String: Static value for the header.

expression string: Expression for the header value.
operation string: Available values: "remove".
value string: Static value for the header.

expression str: Expression for the header value.
operation str: Available values: "remove".
value str: Static value for the header.

expression String: Expression for the header value.
operation String: Available values: "remove".
value String: Static value for the header.

GetRulesetRuleActionParametersMatchedData

PublicKey string: The public key to encrypt matched data logs with.

PublicKey string: The public key to encrypt matched data logs with.

publicKey String: The public key to encrypt matched data logs with.

publicKey string: The public key to encrypt matched data logs with.

public_key str: The public key to encrypt matched data logs with.

publicKey String: The public key to encrypt matched data logs with.

GetRulesetRuleActionParametersOrigin

Host string: Override the resolved hostname.
Port double: Override the destination port.

Host string: Override the resolved hostname.
Port float64: Override the destination port.

host String: Override the resolved hostname.
port Double: Override the destination port.

host string: Override the resolved hostname.
port number: Override the destination port.

host str: Override the resolved hostname.
port float: Override the destination port.

host String: Override the resolved hostname.
port Number: Override the destination port.

GetRulesetRuleActionParametersOverrides

Action string: An action to override all rules with. This option has lower precedence than rule and category overrides.
Categories List<GetRulesetRuleActionParametersOverridesCategory>: A list of category-level overrides. This option has the second-highest precedence after rule-level overrides.
Enabled bool: Whether to enable execution of all rules. This option has lower precedence than rule and category overrides.
Rules List<GetRulesetRuleActionParametersOverridesRule>: A list of rule-level overrides. This option has the highest precedence.
SensitivityLevel string: A sensitivity level to set for all rules. This option has lower precedence than rule and category overrides and is only applicable for DDoS phases. Available values: "default", "medium", "low", "eoff".

Action string: An action to override all rules with. This option has lower precedence than rule and category overrides.
Categories []GetRulesetRuleActionParametersOverridesCategory: A list of category-level overrides. This option has the second-highest precedence after rule-level overrides.
Enabled bool: Whether to enable execution of all rules. This option has lower precedence than rule and category overrides.
Rules []GetRulesetRuleActionParametersOverridesRule: A list of rule-level overrides. This option has the highest precedence.
SensitivityLevel string: A sensitivity level to set for all rules. This option has lower precedence than rule and category overrides and is only applicable for DDoS phases. Available values: "default", "medium", "low", "eoff".

action String: An action to override all rules with. This option has lower precedence than rule and category overrides.
categories List<GetRulesetRuleActionParametersOverridesCategory>: A list of category-level overrides. This option has the second-highest precedence after rule-level overrides.
enabled Boolean: Whether to enable execution of all rules. This option has lower precedence than rule and category overrides.
rules List<GetRulesetRuleActionParametersOverridesRule>: A list of rule-level overrides. This option has the highest precedence.
sensitivityLevel String: A sensitivity level to set for all rules. This option has lower precedence than rule and category overrides and is only applicable for DDoS phases. Available values: "default", "medium", "low", "eoff".

action string: An action to override all rules with. This option has lower precedence than rule and category overrides.
categories GetRulesetRuleActionParametersOverridesCategory[]: A list of category-level overrides. This option has the second-highest precedence after rule-level overrides.
enabled boolean: Whether to enable execution of all rules. This option has lower precedence than rule and category overrides.
rules GetRulesetRuleActionParametersOverridesRule[]: A list of rule-level overrides. This option has the highest precedence.
sensitivityLevel string: A sensitivity level to set for all rules. This option has lower precedence than rule and category overrides and is only applicable for DDoS phases. Available values: "default", "medium", "low", "eoff".

action str: An action to override all rules with. This option has lower precedence than rule and category overrides.
categories Sequence[GetRulesetRuleActionParametersOverridesCategory]: A list of category-level overrides. This option has the second-highest precedence after rule-level overrides.
enabled bool: Whether to enable execution of all rules. This option has lower precedence than rule and category overrides.
rules Sequence[GetRulesetRuleActionParametersOverridesRule]: A list of rule-level overrides. This option has the highest precedence.
sensitivity_level str: A sensitivity level to set for all rules. This option has lower precedence than rule and category overrides and is only applicable for DDoS phases. Available values: "default", "medium", "low", "eoff".

action String: An action to override all rules with. This option has lower precedence than rule and category overrides.
categories List<Property Map>: A list of category-level overrides. This option has the second-highest precedence after rule-level overrides.
enabled Boolean: Whether to enable execution of all rules. This option has lower precedence than rule and category overrides.
rules List<Property Map>: A list of rule-level overrides. This option has the highest precedence.
sensitivityLevel String: A sensitivity level to set for all rules. This option has lower precedence than rule and category overrides and is only applicable for DDoS phases. Available values: "default", "medium", "low", "eoff".

GetRulesetRuleActionParametersOverridesCategory

Action string: The action to override rules in the category with.
Category string: The name of the category to override.
Enabled bool: Whether to enable execution of rules in the category.
SensitivityLevel string: The sensitivity level to use for rules in the category. Available values: "default", "medium", "low", "eoff".

Action string: The action to override rules in the category with.
Category string: The name of the category to override.
Enabled bool: Whether to enable execution of rules in the category.
SensitivityLevel string: The sensitivity level to use for rules in the category. Available values: "default", "medium", "low", "eoff".

action String: The action to override rules in the category with.
category String: The name of the category to override.
enabled Boolean: Whether to enable execution of rules in the category.
sensitivityLevel String: The sensitivity level to use for rules in the category. Available values: "default", "medium", "low", "eoff".

action string: The action to override rules in the category with.
category string: The name of the category to override.
enabled boolean: Whether to enable execution of rules in the category.
sensitivityLevel string: The sensitivity level to use for rules in the category. Available values: "default", "medium", "low", "eoff".

action str: The action to override rules in the category with.
category str: The name of the category to override.
enabled bool: Whether to enable execution of rules in the category.
sensitivity_level str: The sensitivity level to use for rules in the category. Available values: "default", "medium", "low", "eoff".

action String: The action to override rules in the category with.
category String: The name of the category to override.
enabled Boolean: Whether to enable execution of rules in the category.
sensitivityLevel String: The sensitivity level to use for rules in the category. Available values: "default", "medium", "low", "eoff".

GetRulesetRuleActionParametersOverridesRule

Action string: The action to override the rule with.
Enabled bool: Whether to enable execution of the rule.
Id string: The ID of the rule to override.
ScoreThreshold int: The score threshold to use for the rule.
SensitivityLevel string: The sensitivity level to use for the rule. Available values: "default", "medium", "low", "eoff".

Action string: The action to override the rule with.
Enabled bool: Whether to enable execution of the rule.
Id string: The ID of the rule to override.
ScoreThreshold int: The score threshold to use for the rule.
SensitivityLevel string: The sensitivity level to use for the rule. Available values: "default", "medium", "low", "eoff".

action String: The action to override the rule with.
enabled Boolean: Whether to enable execution of the rule.
id String: The ID of the rule to override.
scoreThreshold Integer: The score threshold to use for the rule.
sensitivityLevel String: The sensitivity level to use for the rule. Available values: "default", "medium", "low", "eoff".

action string: The action to override the rule with.
enabled boolean: Whether to enable execution of the rule.
id string: The ID of the rule to override.
scoreThreshold number: The score threshold to use for the rule.
sensitivityLevel string: The sensitivity level to use for the rule. Available values: "default", "medium", "low", "eoff".

action str: The action to override the rule with.
enabled bool: Whether to enable execution of the rule.
id str: The ID of the rule to override.
score_threshold int: The score threshold to use for the rule.
sensitivity_level str: The sensitivity level to use for the rule. Available values: "default", "medium", "low", "eoff".

action String: The action to override the rule with.
enabled Boolean: Whether to enable execution of the rule.
id String: The ID of the rule to override.
scoreThreshold Number: The score threshold to use for the rule.
sensitivityLevel String: The sensitivity level to use for the rule. Available values: "default", "medium", "low", "eoff".

GetRulesetRuleActionParametersRawResponseField

Name string: The name of the field.
PreserveDuplicates bool: Whether to log duplicate values of the same header.

Name string: The name of the field.
PreserveDuplicates bool: Whether to log duplicate values of the same header.

name String: The name of the field.
preserveDuplicates Boolean: Whether to log duplicate values of the same header.

name string: The name of the field.
preserveDuplicates boolean: Whether to log duplicate values of the same header.

name str: The name of the field.
preserve_duplicates bool: Whether to log duplicate values of the same header.

name String: The name of the field.
preserveDuplicates Boolean: Whether to log duplicate values of the same header.

GetRulesetRuleActionParametersRequestField

Name string: The name of the field.

Name string: The name of the field.

name String: The name of the field.

name string: The name of the field.

name str: The name of the field.

name String: The name of the field.

GetRulesetRuleActionParametersResponse

Content string: The content to return.
ContentType string: The type of the content to return.
StatusCode int: The status code to return.

Content string: The content to return.
ContentType string: The type of the content to return.
StatusCode int: The status code to return.

content String: The content to return.
contentType String: The type of the content to return.
statusCode Integer: The status code to return.

content string: The content to return.
contentType string: The type of the content to return.
statusCode number: The status code to return.

content str: The content to return.
content_type str: The type of the content to return.
status_code int: The status code to return.

content String: The content to return.
contentType String: The type of the content to return.
statusCode Number: The status code to return.

GetRulesetRuleActionParametersResponseField

Name string: The name of the field.
PreserveDuplicates bool: Whether to log duplicate values of the same header.

Name string: The name of the field.
PreserveDuplicates bool: Whether to log duplicate values of the same header.

name String: The name of the field.
preserveDuplicates Boolean: Whether to log duplicate values of the same header.

name string: The name of the field.
preserveDuplicates boolean: Whether to log duplicate values of the same header.

name str: The name of the field.
preserve_duplicates bool: Whether to log duplicate values of the same header.

name String: The name of the field.
preserveDuplicates Boolean: Whether to log duplicate values of the same header.

GetRulesetRuleActionParametersServeStale

DisableStaleWhileUpdating bool: Defines whether Cloudflare should serve stale content while updating. If true, Cloudflare will not serve stale content while getting the latest content from the origin.

DisableStaleWhileUpdating bool: Defines whether Cloudflare should serve stale content while updating. If true, Cloudflare will not serve stale content while getting the latest content from the origin.

disableStaleWhileUpdating Boolean: Defines whether Cloudflare should serve stale content while updating. If true, Cloudflare will not serve stale content while getting the latest content from the origin.

disableStaleWhileUpdating boolean: Defines whether Cloudflare should serve stale content while updating. If true, Cloudflare will not serve stale content while getting the latest content from the origin.

disable_stale_while_updating bool: Defines whether Cloudflare should serve stale content while updating. If true, Cloudflare will not serve stale content while getting the latest content from the origin.

disableStaleWhileUpdating Boolean: Defines whether Cloudflare should serve stale content while updating. If true, Cloudflare will not serve stale content while getting the latest content from the origin.

GetRulesetRuleActionParametersSni

Value string: The SNI override.

Value string: The SNI override.

value String: The SNI override.

value string: The SNI override.

value str: The SNI override.

value String: The SNI override.

GetRulesetRuleActionParametersTransformedRequestField

Name string: The name of the field.

Name string: The name of the field.

name String: The name of the field.

name string: The name of the field.

name str: The name of the field.

name String: The name of the field.

GetRulesetRuleActionParametersUri

Path GetRulesetRuleActionParametersUriPath: Path portion rewrite.
Query GetRulesetRuleActionParametersUriQuery: Query portion rewrite.

Path GetRulesetRuleActionParametersUriPath: Path portion rewrite.
Query GetRulesetRuleActionParametersUriQuery: Query portion rewrite.

path GetRulesetRuleActionParametersUriPath: Path portion rewrite.
query GetRulesetRuleActionParametersUriQuery: Query portion rewrite.

path GetRulesetRuleActionParametersUriPath: Path portion rewrite.
query GetRulesetRuleActionParametersUriQuery: Query portion rewrite.

path GetRulesetRuleActionParametersUriPath: Path portion rewrite.
query GetRulesetRuleActionParametersUriQuery: Query portion rewrite.

path Property Map: Path portion rewrite.
query Property Map: Query portion rewrite.

GetRulesetRuleActionParametersUriPath

Expression string: Expression to evaluate for the replacement value.
Value string: Predefined replacement value.

Expression string: Expression to evaluate for the replacement value.
Value string: Predefined replacement value.

expression String: Expression to evaluate for the replacement value.
value String: Predefined replacement value.

expression string: Expression to evaluate for the replacement value.
value string: Predefined replacement value.

expression str: Expression to evaluate for the replacement value.
value str: Predefined replacement value.

expression String: Expression to evaluate for the replacement value.
value String: Predefined replacement value.

GetRulesetRuleActionParametersUriQuery

Expression string: Expression to evaluate for the replacement value.
Value string: Predefined replacement value.

Expression string: Expression to evaluate for the replacement value.
Value string: Predefined replacement value.

expression String: Expression to evaluate for the replacement value.
value String: Predefined replacement value.

expression string: Expression to evaluate for the replacement value.
value string: Predefined replacement value.

expression str: Expression to evaluate for the replacement value.
value str: Predefined replacement value.

expression String: Expression to evaluate for the replacement value.
value String: Predefined replacement value.

GetRulesetRuleExposedCredentialCheck

PasswordExpression string: Expression that selects the password used in the credentials check.
UsernameExpression string: Expression that selects the user ID used in the credentials check.

PasswordExpression string: Expression that selects the password used in the credentials check.
UsernameExpression string: Expression that selects the user ID used in the credentials check.

passwordExpression String: Expression that selects the password used in the credentials check.
usernameExpression String: Expression that selects the user ID used in the credentials check.

passwordExpression string: Expression that selects the password used in the credentials check.
usernameExpression string: Expression that selects the user ID used in the credentials check.

password_expression str: Expression that selects the password used in the credentials check.
username_expression str: Expression that selects the user ID used in the credentials check.

passwordExpression String: Expression that selects the password used in the credentials check.
usernameExpression String: Expression that selects the user ID used in the credentials check.

GetRulesetRuleLogging

Enabled bool: Whether to generate a log when the rule matches.

Enabled bool: Whether to generate a log when the rule matches.

enabled Boolean: Whether to generate a log when the rule matches.

enabled boolean: Whether to generate a log when the rule matches.

enabled bool: Whether to generate a log when the rule matches.

enabled Boolean: Whether to generate a log when the rule matches.

GetRulesetRuleRatelimit

Characteristics List<string>: Characteristics of the request on which the ratelimiter counter will be incremented.
CountingExpression string: Defines when the ratelimit counter should be incremented. It is optional and defaults to the same as the rule's expression.
MitigationTimeout int: Period of time in seconds after which the action will be disabled following its first execution.
Period int: Period in seconds over which the counter is being incremented. Available values: 10, 60, 600, 3600.
RequestsPerPeriod int: The threshold of requests per period after which the action will be executed for the first time.
RequestsToOrigin bool: Defines if ratelimit counting is only done when an origin is reached.
ScorePerPeriod int: The score threshold per period for which the action will be executed the first time.
ScoreResponseHeaderName string: The response header name provided by the origin which should contain the score to increment ratelimit counter on.

Characteristics []string: Characteristics of the request on which the ratelimiter counter will be incremented.
CountingExpression string: Defines when the ratelimit counter should be incremented. It is optional and defaults to the same as the rule's expression.
MitigationTimeout int: Period of time in seconds after which the action will be disabled following its first execution.
Period int: Period in seconds over which the counter is being incremented. Available values: 10, 60, 600, 3600.
RequestsPerPeriod int: The threshold of requests per period after which the action will be executed for the first time.
RequestsToOrigin bool: Defines if ratelimit counting is only done when an origin is reached.
ScorePerPeriod int: The score threshold per period for which the action will be executed the first time.
ScoreResponseHeaderName string: The response header name provided by the origin which should contain the score to increment ratelimit counter on.

characteristics List<String>: Characteristics of the request on which the ratelimiter counter will be incremented.
countingExpression String: Defines when the ratelimit counter should be incremented. It is optional and defaults to the same as the rule's expression.
mitigationTimeout Integer: Period of time in seconds after which the action will be disabled following its first execution.
period Integer: Period in seconds over which the counter is being incremented. Available values: 10, 60, 600, 3600.
requestsPerPeriod Integer: The threshold of requests per period after which the action will be executed for the first time.
requestsToOrigin Boolean: Defines if ratelimit counting is only done when an origin is reached.
scorePerPeriod Integer: The score threshold per period for which the action will be executed the first time.
scoreResponseHeaderName String: The response header name provided by the origin which should contain the score to increment ratelimit counter on.

characteristics string[]: Characteristics of the request on which the ratelimiter counter will be incremented.
countingExpression string: Defines when the ratelimit counter should be incremented. It is optional and defaults to the same as the rule's expression.
mitigationTimeout number: Period of time in seconds after which the action will be disabled following its first execution.
period number: Period in seconds over which the counter is being incremented. Available values: 10, 60, 600, 3600.
requestsPerPeriod number: The threshold of requests per period after which the action will be executed for the first time.
requestsToOrigin boolean: Defines if ratelimit counting is only done when an origin is reached.
scorePerPeriod number: The score threshold per period for which the action will be executed the first time.
scoreResponseHeaderName string: The response header name provided by the origin which should contain the score to increment ratelimit counter on.

characteristics Sequence[str]: Characteristics of the request on which the ratelimiter counter will be incremented.
counting_expression str: Defines when the ratelimit counter should be incremented. It is optional and defaults to the same as the rule's expression.
mitigation_timeout int: Period of time in seconds after which the action will be disabled following its first execution.
period int: Period in seconds over which the counter is being incremented. Available values: 10, 60, 600, 3600.
requests_per_period int: The threshold of requests per period after which the action will be executed for the first time.
requests_to_origin bool: Defines if ratelimit counting is only done when an origin is reached.
score_per_period int: The score threshold per period for which the action will be executed the first time.
score_response_header_name str: The response header name provided by the origin which should contain the score to increment ratelimit counter on.

characteristics List<String>: Characteristics of the request on which the ratelimiter counter will be incremented.
countingExpression String: Defines when the ratelimit counter should be incremented. It is optional and defaults to the same as the rule's expression.
mitigationTimeout Number: Period of time in seconds after which the action will be disabled following its first execution.
period Number: Period in seconds over which the counter is being incremented. Available values: 10, 60, 600, 3600.
requestsPerPeriod Number: The threshold of requests per period after which the action will be executed for the first time.
requestsToOrigin Boolean: Defines if ratelimit counting is only done when an origin is reached.
scorePerPeriod Number: The score threshold per period for which the action will be executed the first time.
scoreResponseHeaderName String: The response header name provided by the origin which should contain the score to increment ratelimit counter on.

Package Details

Repository: Cloudflare pulumi/pulumi-cloudflare
License: Apache-2.0
Notes: This Pulumi package is based on the cloudflare Terraform Provider.

Cloudflare v6.1.2 published on Monday, Apr 28, 2025 by Pulumi

pulumi/pulumi-cloudflare

cloudflare.getRuleset

On this page

On this page

Example Usage

Using getRuleset

getRuleset Result

Supporting Types

GetRulesetRule

GetRulesetRuleActionParameters

GetRulesetRuleActionParametersAlgorithm

GetRulesetRuleActionParametersAutominify

GetRulesetRuleActionParametersBrowserTtl

GetRulesetRuleActionParametersCacheKey

GetRulesetRuleActionParametersCacheKeyCustomKey

GetRulesetRuleActionParametersCacheKeyCustomKeyCookie

GetRulesetRuleActionParametersCacheKeyCustomKeyHeader

GetRulesetRuleActionParametersCacheKeyCustomKeyHost

GetRulesetRuleActionParametersCacheKeyCustomKeyQueryString

GetRulesetRuleActionParametersCacheKeyCustomKeyQueryStringExclude

GetRulesetRuleActionParametersCacheKeyCustomKeyQueryStringInclude

GetRulesetRuleActionParametersCacheKeyCustomKeyUser

GetRulesetRuleActionParametersCacheReserve

GetRulesetRuleActionParametersCookieField

GetRulesetRuleActionParametersEdgeTtl

GetRulesetRuleActionParametersEdgeTtlStatusCodeTtl

GetRulesetRuleActionParametersEdgeTtlStatusCodeTtlStatusCodeRange

GetRulesetRuleActionParametersFromList

GetRulesetRuleActionParametersFromValue

GetRulesetRuleActionParametersFromValueTargetUrl

GetRulesetRuleActionParametersHeaders

GetRulesetRuleActionParametersMatchedData

GetRulesetRuleActionParametersOrigin

GetRulesetRuleActionParametersOverrides

GetRulesetRuleActionParametersOverridesCategory

GetRulesetRuleActionParametersOverridesRule

GetRulesetRuleActionParametersRawResponseField

GetRulesetRuleActionParametersRequestField

GetRulesetRuleActionParametersResponse

GetRulesetRuleActionParametersResponseField

GetRulesetRuleActionParametersServeStale

GetRulesetRuleActionParametersSni

GetRulesetRuleActionParametersTransformedRequestField

GetRulesetRuleActionParametersUri

GetRulesetRuleActionParametersUriPath

GetRulesetRuleActionParametersUriQuery

GetRulesetRuleExposedCredentialCheck

GetRulesetRuleLogging

GetRulesetRuleRatelimit

Package Details

On this page

On this page