1. Packages
  2. Cloudflare Provider
  3. API Docs
  4. getRuleset
Cloudflare v6.9.1 published on Thursday, Sep 18, 2025 by Pulumi

cloudflare.getRuleset

Explore with Pulumi AI

cloudflare logo
Cloudflare v6.9.1 published on Thursday, Sep 18, 2025 by Pulumi

    Example Usage

    import * as pulumi from "@pulumi/pulumi";
    import * as cloudflare from "@pulumi/cloudflare";
    
    const exampleRuleset = cloudflare.getRuleset({
        zoneId: "9f1839b6152d298aca64c4e906b6d074",
        id: "2f2feab2026849078ba485f918791bdc",
    });
    
    import pulumi
    import pulumi_cloudflare as cloudflare
    
    example_ruleset = cloudflare.get_ruleset(zone_id="9f1839b6152d298aca64c4e906b6d074",
        id="2f2feab2026849078ba485f918791bdc")
    
    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{
    			ZoneId: pulumi.StringRef("9f1839b6152d298aca64c4e906b6d074"),
    			Id:     pulumi.StringRef("2f2feab2026849078ba485f918791bdc"),
    		}, 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()
        {
            ZoneId = "9f1839b6152d298aca64c4e906b6d074",
            Id = "2f2feab2026849078ba485f918791bdc",
        });
    
    });
    
    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()
                .zoneId("9f1839b6152d298aca64c4e906b6d074")
                .id("2f2feab2026849078ba485f918791bdc")
                .build());
    
        }
    }
    
    variables:
      exampleRuleset:
        fn::invoke:
          function: cloudflare:getRuleset
          arguments:
            zoneId: 9f1839b6152d298aca64c4e906b6d074
            id: 2f2feab2026849078ba485f918791bdc
    

    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,
                    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,
                    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 unique ID of the account.
    Id string
    The unique ID of the ruleset.
    RulesetId string
    The unique ID of the ruleset.

    Deprecated: Configure id instead. This attribute will be removed in the next major version of the provider.

    ZoneId string
    The unique ID of the zone.
    AccountId string
    The unique ID of the account.
    Id string
    The unique ID of the ruleset.
    RulesetId string
    The unique ID of the ruleset.

    Deprecated: Configure id instead. This attribute will be removed in the next major version of the provider.

    ZoneId string
    The unique ID of the zone.
    accountId String
    The unique ID of the account.
    id String
    The unique ID of the ruleset.
    rulesetId String
    The unique ID of the ruleset.

    Deprecated: Configure id instead. This attribute will be removed in the next major version of the provider.

    zoneId String
    The unique ID of the zone.
    accountId string
    The unique ID of the account.
    id string
    The unique ID of the ruleset.
    rulesetId string
    The unique ID of the ruleset.

    Deprecated: Configure id instead. This attribute will be removed in the next major version of the provider.

    zoneId string
    The unique ID of the zone.
    account_id str
    The unique ID of the account.
    id str
    The unique ID of the ruleset.
    ruleset_id str
    The unique ID of the ruleset.

    Deprecated: Configure id instead. This attribute will be removed in the next major version of the provider.

    zone_id str
    The unique ID of the zone.
    accountId String
    The unique ID of the account.
    id String
    The unique ID of the ruleset.
    rulesetId String
    The unique ID of the ruleset.

    Deprecated: Configure id instead. This attribute will be removed in the next major version of the provider.

    zoneId String
    The unique ID of the zone.

    getRuleset Result

    The following output properties are available:

    Description string
    An informative description of the ruleset.
    Kind string
    The kind of the ruleset. Available values: "managed", "custom", "root", "zone".
    LastUpdated string
    The timestamp of when the ruleset was last modified.
    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.
    Version string
    The version of the ruleset.
    AccountId string
    The unique ID of the account.
    Id string
    The unique ID of the ruleset.
    RulesetId string
    The unique ID of the ruleset.

    Deprecated: Configure id instead. This attribute will be removed in the next major version of the provider.

    ZoneId string
    The unique ID of the zone.
    Description string
    An informative description of the ruleset.
    Kind string
    The kind of the ruleset. Available values: "managed", "custom", "root", "zone".
    LastUpdated string
    The timestamp of when the ruleset was last modified.
    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.
    Version string
    The version of the ruleset.
    AccountId string
    The unique ID of the account.
    Id string
    The unique ID of the ruleset.
    RulesetId string
    The unique ID of the ruleset.

    Deprecated: Configure id instead. This attribute will be removed in the next major version of the provider.

    ZoneId string
    The unique ID of the zone.
    description String
    An informative description of the ruleset.
    kind String
    The kind of the ruleset. Available values: "managed", "custom", "root", "zone".
    lastUpdated String
    The timestamp of when the ruleset was last modified.
    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.
    version String
    The version of the ruleset.
    accountId String
    The unique ID of the account.
    id String
    The unique ID of the ruleset.
    rulesetId String
    The unique ID of the ruleset.

    Deprecated: Configure id instead. This attribute will be removed in the next major version of the provider.

    zoneId String
    The unique ID of the zone.
    description string
    An informative description of the ruleset.
    kind string
    The kind of the ruleset. Available values: "managed", "custom", "root", "zone".
    lastUpdated string
    The timestamp of when the ruleset was last modified.
    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.
    version string
    The version of the ruleset.
    accountId string
    The unique ID of the account.
    id string
    The unique ID of the ruleset.
    rulesetId string
    The unique ID of the ruleset.

    Deprecated: Configure id instead. This attribute will be removed in the next major version of the provider.

    zoneId string
    The unique ID of the zone.
    description str
    An informative description of the ruleset.
    kind str
    The kind of the ruleset. Available values: "managed", "custom", "root", "zone".
    last_updated str
    The timestamp of when the ruleset was last modified.
    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.
    version str
    The version of the ruleset.
    account_id str
    The unique ID of the account.
    id str
    The unique ID of the ruleset.
    ruleset_id str
    The unique ID of the ruleset.

    Deprecated: Configure id instead. This attribute will be removed in the next major version of the provider.

    zone_id str
    The unique ID of the zone.
    description String
    An informative description of the ruleset.
    kind String
    The kind of the ruleset. Available values: "managed", "custom", "root", "zone".
    lastUpdated String
    The timestamp of when the ruleset was last modified.
    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.
    version String
    The version of the ruleset.
    accountId String
    The unique ID of the account.
    id String
    The unique ID of the ruleset.
    rulesetId String
    The unique ID of the ruleset.

    Deprecated: Configure id instead. This attribute will be removed in the next major version of the provider.

    zoneId String
    The unique ID of the zone.

    Supporting Types

    GetRulesetRule

    Action string
    The action to perform when the rule matches. Available values: "block", "challenge", "compressresponse", "ddosdynamic", "execute", "forceconnectionclose", "jschallenge", "log", "logcustomfield", "managedchallenge", "redirect", "rewrite", "route", "score", "serveerror", "setcachesettings", "setconfig", "skip".
    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
    Configuration for exposed credential checking.
    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 rate limit behavior.
    Ref string
    The reference of the rule (the rule's ID by default).
    Action string
    The action to perform when the rule matches. Available values: "block", "challenge", "compressresponse", "ddosdynamic", "execute", "forceconnectionclose", "jschallenge", "log", "logcustomfield", "managedchallenge", "redirect", "rewrite", "route", "score", "serveerror", "setcachesettings", "setconfig", "skip".
    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
    Configuration for exposed credential checking.
    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 rate limit behavior.
    Ref string
    The reference of the rule (the rule's ID by default).
    action String
    The action to perform when the rule matches. Available values: "block", "challenge", "compressresponse", "ddosdynamic", "execute", "forceconnectionclose", "jschallenge", "log", "logcustomfield", "managedchallenge", "redirect", "rewrite", "route", "score", "serveerror", "setcachesettings", "setconfig", "skip".
    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
    Configuration for exposed credential checking.
    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 rate limit behavior.
    ref String
    The reference of the rule (the rule's ID by default).
    action string
    The action to perform when the rule matches. Available values: "block", "challenge", "compressresponse", "ddosdynamic", "execute", "forceconnectionclose", "jschallenge", "log", "logcustomfield", "managedchallenge", "redirect", "rewrite", "route", "score", "serveerror", "setcachesettings", "setconfig", "skip".
    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
    Configuration for exposed credential checking.
    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 rate limit behavior.
    ref string
    The reference of the rule (the rule's ID by default).
    action str
    The action to perform when the rule matches. Available values: "block", "challenge", "compressresponse", "ddosdynamic", "execute", "forceconnectionclose", "jschallenge", "log", "logcustomfield", "managedchallenge", "redirect", "rewrite", "route", "score", "serveerror", "setcachesettings", "setconfig", "skip".
    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
    Configuration for exposed credential checking.
    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 rate limit behavior.
    ref str
    The reference of the rule (the rule's ID by default).
    action String
    The action to perform when the rule matches. Available values: "block", "challenge", "compressresponse", "ddosdynamic", "execute", "forceconnectionclose", "jschallenge", "log", "logcustomfield", "managedchallenge", "redirect", "rewrite", "route", "score", "serveerror", "setcachesettings", "setconfig", "skip".
    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
    Configuration for exposed credential checking.
    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 rate limit behavior.
    ref String
    The reference of the rule (the rule's ID by default).

    GetRulesetRuleActionParameters

    AdditionalCacheablePorts List<int>
    A list of additional ports that caching should be enabled on.
    Algorithms List<GetRulesetRuleActionParametersAlgorithm>
    Custom order for compression algorithms.
    AssetName string
    The name of a custom asset to serve as the response.
    AutomaticHttpsRewrites bool
    Whether to enable Automatic HTTPS Rewrites.
    Autominify GetRulesetRuleActionParametersAutominify
    Which file extensions to minify automatically.
    Bic bool
    Whether to enable Browser Integrity Check (BIC).
    BrowserTtl GetRulesetRuleActionParametersBrowserTtl
    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
    Whether the request's response from the origin is eligible for caching. Caching itself will still depend on the cache control header and your other caching configurations.
    CacheKey GetRulesetRuleActionParametersCacheKey
    Which components of the request are included in or excluded from the cache key Cloudflare uses to store the response in cache.
    CacheReserve GetRulesetRuleActionParametersCacheReserve
    Settings to determine whether the request's response from origin is eligible for Cache Reserve (requires a Cache Reserve add-on plan).
    Content string
    The response content.
    ContentType string
    The content type header to set with the error response. Available values: "application/json", "text/html", "text/plain", "text/xml".
    CookieFields List<GetRulesetRuleActionParametersCookieField>
    The cookie fields to log.
    DisableApps bool
    Whether to disable Cloudflare Apps.
    DisableRum bool
    Whether to disable Real User Monitoring (RUM).
    DisableZaraz bool
    Whether to disable Zaraz.
    EdgeTtl GetRulesetRuleActionParametersEdgeTtl
    How long the Cloudflare edge network should cache the response.
    EmailObfuscation bool
    Whether to enable Email Obfuscation.
    Fonts bool
    Whether to enable Cloudflare Fonts.
    FromList GetRulesetRuleActionParametersFromList
    A redirect based on a bulk list lookup.
    FromValue GetRulesetRuleActionParametersFromValue
    A redirect based on the request properties.
    Headers Dictionary<string, GetRulesetRuleActionParametersHeaders>
    A map of headers to rewrite.
    HostHeader string
    A value to rewrite the HTTP host header to.
    HotlinkProtection bool
    Whether to enable Hotlink Protection.
    Id string
    The ID of the ruleset to execute.
    Increment int
    A delta to change the score by, which can be either positive or negative.
    MatchedData GetRulesetRuleActionParametersMatchedData
    The configuration to use for matched data logging.
    Mirage bool
    Whether to enable Mirage.
    OpportunisticEncryption bool
    Whether to enable Opportunistic Encryption.
    Origin GetRulesetRuleActionParametersOrigin
    An origin to route to.
    OriginCacheControl bool
    Whether Cloudflare will aim to strictly adhere to RFC 7234.
    OriginErrorPagePassthru bool
    Whether to generate Cloudflare error pages for issues from the origin server.
    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 rulesets option. 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".
    Polish string
    The Polish level to configure. Available values: "off", "lossless", "lossy", "webp".
    Products List<string>
    A list of legacy security products to skip the execution of. Available values: "bic", "hot", "rateLimit", "securityLevel", "uaBlock", "waf", "zoneLockdown".
    RawResponseFields List<GetRulesetRuleActionParametersRawResponseField>
    The raw response fields to log.
    ReadTimeout int
    A timeout value between two successive read operations to use for 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
    Whether Cloudflare should respect strong ETag (entity tag) headers. If false, 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
    Whether to enable 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 option. 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
    The Security Level to configure. Available values: "off", "essentiallyoff", "low", "medium", "high", "underattack".
    ServeStale GetRulesetRuleActionParametersServeStale
    When to serve stale content from cache.
    ServerSideExcludes bool
    Whether to enable Server-Side Excludes.
    Sni GetRulesetRuleActionParametersSni
    A Server Name Indication (SNI) override.
    Ssl string
    The SSL level to configure. Available values: "off", "flexible", "full", "strict", "origin_pull".
    StatusCode int
    The status code to use for the error.
    Sxg bool
    Whether to enable Signed Exchanges (SXG).
    TransformedRequestFields List<GetRulesetRuleActionParametersTransformedRequestField>
    The transformed request fields to log.
    Uri GetRulesetRuleActionParametersUri
    A URI rewrite.
    AdditionalCacheablePorts []int
    A list of additional ports that caching should be enabled on.
    Algorithms []GetRulesetRuleActionParametersAlgorithm
    Custom order for compression algorithms.
    AssetName string
    The name of a custom asset to serve as the response.
    AutomaticHttpsRewrites bool
    Whether to enable Automatic HTTPS Rewrites.
    Autominify GetRulesetRuleActionParametersAutominify
    Which file extensions to minify automatically.
    Bic bool
    Whether to enable Browser Integrity Check (BIC).
    BrowserTtl GetRulesetRuleActionParametersBrowserTtl
    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
    Whether the request's response from the origin is eligible for caching. Caching itself will still depend on the cache control header and your other caching configurations.
    CacheKey GetRulesetRuleActionParametersCacheKey
    Which components of the request are included in or excluded from the cache key Cloudflare uses to store the response in cache.
    CacheReserve GetRulesetRuleActionParametersCacheReserve
    Settings to determine whether the request's response from origin is eligible for Cache Reserve (requires a Cache Reserve add-on plan).
    Content string
    The response content.
    ContentType string
    The content type header to set with the error response. Available values: "application/json", "text/html", "text/plain", "text/xml".
    CookieFields []GetRulesetRuleActionParametersCookieField
    The cookie fields to log.
    DisableApps bool
    Whether to disable Cloudflare Apps.
    DisableRum bool
    Whether to disable Real User Monitoring (RUM).
    DisableZaraz bool
    Whether to disable Zaraz.
    EdgeTtl GetRulesetRuleActionParametersEdgeTtl
    How long the Cloudflare edge network should cache the response.
    EmailObfuscation bool
    Whether to enable Email Obfuscation.
    Fonts bool
    Whether to enable Cloudflare Fonts.
    FromList GetRulesetRuleActionParametersFromList
    A redirect based on a bulk list lookup.
    FromValue GetRulesetRuleActionParametersFromValue
    A redirect based on the request properties.
    Headers map[string]GetRulesetRuleActionParametersHeaders
    A map of headers to rewrite.
    HostHeader string
    A value to rewrite the HTTP host header to.
    HotlinkProtection bool
    Whether to enable Hotlink Protection.
    Id string
    The ID of the ruleset to execute.
    Increment int
    A delta to change the score by, which can be either positive or negative.
    MatchedData GetRulesetRuleActionParametersMatchedData
    The configuration to use for matched data logging.
    Mirage bool
    Whether to enable Mirage.
    OpportunisticEncryption bool
    Whether to enable Opportunistic Encryption.
    Origin GetRulesetRuleActionParametersOrigin
    An origin to route to.
    OriginCacheControl bool
    Whether Cloudflare will aim to strictly adhere to RFC 7234.
    OriginErrorPagePassthru bool
    Whether to generate Cloudflare error pages for issues from the origin server.
    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 rulesets option. 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".
    Polish string
    The Polish level to configure. Available values: "off", "lossless", "lossy", "webp".
    Products []string
    A list of legacy security products to skip the execution of. Available values: "bic", "hot", "rateLimit", "securityLevel", "uaBlock", "waf", "zoneLockdown".
    RawResponseFields []GetRulesetRuleActionParametersRawResponseField
    The raw response fields to log.
    ReadTimeout int
    A timeout value between two successive read operations to use for 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
    Whether Cloudflare should respect strong ETag (entity tag) headers. If false, 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
    Whether to enable 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 option. 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
    The Security Level to configure. Available values: "off", "essentiallyoff", "low", "medium", "high", "underattack".
    ServeStale GetRulesetRuleActionParametersServeStale
    When to serve stale content from cache.
    ServerSideExcludes bool
    Whether to enable Server-Side Excludes.
    Sni GetRulesetRuleActionParametersSni
    A Server Name Indication (SNI) override.
    Ssl string
    The SSL level to configure. Available values: "off", "flexible", "full", "strict", "origin_pull".
    StatusCode int
    The status code to use for the error.
    Sxg bool
    Whether to enable Signed Exchanges (SXG).
    TransformedRequestFields []GetRulesetRuleActionParametersTransformedRequestField
    The transformed request fields to log.
    Uri GetRulesetRuleActionParametersUri
    A URI rewrite.
    additionalCacheablePorts List<Integer>
    A list of additional ports that caching should be enabled on.
    algorithms List<GetRulesetRuleActionParametersAlgorithm>
    Custom order for compression algorithms.
    assetName String
    The name of a custom asset to serve as the response.
    automaticHttpsRewrites Boolean
    Whether to enable Automatic HTTPS Rewrites.
    autominify GetRulesetRuleActionParametersAutominify
    Which file extensions to minify automatically.
    bic Boolean
    Whether to enable Browser Integrity Check (BIC).
    browserTtl GetRulesetRuleActionParametersBrowserTtl
    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
    Whether the request's response from the origin is eligible for caching. Caching itself will still depend on the cache control header and your other caching configurations.
    cacheKey GetRulesetRuleActionParametersCacheKey
    Which components of the request are included in or excluded from the cache key Cloudflare uses to store the response in cache.
    cacheReserve GetRulesetRuleActionParametersCacheReserve
    Settings to determine whether the request's response from origin is eligible for Cache Reserve (requires a Cache Reserve add-on plan).
    content String
    The response content.
    contentType String
    The content type header to set with the error response. Available values: "application/json", "text/html", "text/plain", "text/xml".
    cookieFields List<GetRulesetRuleActionParametersCookieField>
    The cookie fields to log.
    disableApps Boolean
    Whether to disable Cloudflare Apps.
    disableRum Boolean
    Whether to disable Real User Monitoring (RUM).
    disableZaraz Boolean
    Whether to disable Zaraz.
    edgeTtl GetRulesetRuleActionParametersEdgeTtl
    How long the Cloudflare edge network should cache the response.
    emailObfuscation Boolean
    Whether to enable Email Obfuscation.
    fonts Boolean
    Whether to enable Cloudflare Fonts.
    fromList GetRulesetRuleActionParametersFromList
    A redirect based on a bulk list lookup.
    fromValue GetRulesetRuleActionParametersFromValue
    A redirect based on the request properties.
    headers Map<String,GetRulesetRuleActionParametersHeaders>
    A map of headers to rewrite.
    hostHeader String
    A value to rewrite the HTTP host header to.
    hotlinkProtection Boolean
    Whether to enable Hotlink Protection.
    id String
    The ID of the ruleset to execute.
    increment Integer
    A delta to change the score by, which can be either positive or negative.
    matchedData GetRulesetRuleActionParametersMatchedData
    The configuration to use for matched data logging.
    mirage Boolean
    Whether to enable Mirage.
    opportunisticEncryption Boolean
    Whether to enable Opportunistic Encryption.
    origin GetRulesetRuleActionParametersOrigin
    An origin to route to.
    originCacheControl Boolean
    Whether Cloudflare will aim to strictly adhere to RFC 7234.
    originErrorPagePassthru Boolean
    Whether to generate Cloudflare error pages for issues from the origin server.
    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 rulesets option. 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".
    polish String
    The Polish level to configure. Available values: "off", "lossless", "lossy", "webp".
    products List<String>
    A list of legacy security products to skip the execution of. Available values: "bic", "hot", "rateLimit", "securityLevel", "uaBlock", "waf", "zoneLockdown".
    rawResponseFields List<GetRulesetRuleActionParametersRawResponseField>
    The raw response fields to log.
    readTimeout Integer
    A timeout value between two successive read operations to use for 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
    Whether Cloudflare should respect strong ETag (entity tag) headers. If false, 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
    Whether to enable 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 option. 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
    The Security Level to configure. Available values: "off", "essentiallyoff", "low", "medium", "high", "underattack".
    serveStale GetRulesetRuleActionParametersServeStale
    When to serve stale content from cache.
    serverSideExcludes Boolean
    Whether to enable Server-Side Excludes.
    sni GetRulesetRuleActionParametersSni
    A Server Name Indication (SNI) override.
    ssl String
    The SSL level to configure. Available values: "off", "flexible", "full", "strict", "origin_pull".
    statusCode Integer
    The status code to use for the error.
    sxg Boolean
    Whether to enable Signed Exchanges (SXG).
    transformedRequestFields List<GetRulesetRuleActionParametersTransformedRequestField>
    The transformed request fields to log.
    uri GetRulesetRuleActionParametersUri
    A URI rewrite.
    additionalCacheablePorts number[]
    A list of additional ports that caching should be enabled on.
    algorithms GetRulesetRuleActionParametersAlgorithm[]
    Custom order for compression algorithms.
    assetName string
    The name of a custom asset to serve as the response.
    automaticHttpsRewrites boolean
    Whether to enable Automatic HTTPS Rewrites.
    autominify GetRulesetRuleActionParametersAutominify
    Which file extensions to minify automatically.
    bic boolean
    Whether to enable Browser Integrity Check (BIC).
    browserTtl GetRulesetRuleActionParametersBrowserTtl
    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
    Whether the request's response from the origin is eligible for caching. Caching itself will still depend on the cache control header and your other caching configurations.
    cacheKey GetRulesetRuleActionParametersCacheKey
    Which components of the request are included in or excluded from the cache key Cloudflare uses to store the response in cache.
    cacheReserve GetRulesetRuleActionParametersCacheReserve
    Settings to determine whether the request's response from origin is eligible for Cache Reserve (requires a Cache Reserve add-on plan).
    content string
    The response content.
    contentType string
    The content type header to set with the error response. Available values: "application/json", "text/html", "text/plain", "text/xml".
    cookieFields GetRulesetRuleActionParametersCookieField[]
    The cookie fields to log.
    disableApps boolean
    Whether to disable Cloudflare Apps.
    disableRum boolean
    Whether to disable Real User Monitoring (RUM).
    disableZaraz boolean
    Whether to disable Zaraz.
    edgeTtl GetRulesetRuleActionParametersEdgeTtl
    How long the Cloudflare edge network should cache the response.
    emailObfuscation boolean
    Whether to enable Email Obfuscation.
    fonts boolean
    Whether to enable Cloudflare Fonts.
    fromList GetRulesetRuleActionParametersFromList
    A redirect based on a bulk list lookup.
    fromValue GetRulesetRuleActionParametersFromValue
    A redirect based on the request properties.
    headers {[key: string]: GetRulesetRuleActionParametersHeaders}
    A map of headers to rewrite.
    hostHeader string
    A value to rewrite the HTTP host header to.
    hotlinkProtection boolean
    Whether to enable Hotlink Protection.
    id string
    The ID of the ruleset to execute.
    increment number
    A delta to change the score by, which can be either positive or negative.
    matchedData GetRulesetRuleActionParametersMatchedData
    The configuration to use for matched data logging.
    mirage boolean
    Whether to enable Mirage.
    opportunisticEncryption boolean
    Whether to enable Opportunistic Encryption.
    origin GetRulesetRuleActionParametersOrigin
    An origin to route to.
    originCacheControl boolean
    Whether Cloudflare will aim to strictly adhere to RFC 7234.
    originErrorPagePassthru boolean
    Whether to generate Cloudflare error pages for issues from the origin server.
    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 rulesets option. 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".
    polish string
    The Polish level to configure. Available values: "off", "lossless", "lossy", "webp".
    products string[]
    A list of legacy security products to skip the execution of. Available values: "bic", "hot", "rateLimit", "securityLevel", "uaBlock", "waf", "zoneLockdown".
    rawResponseFields GetRulesetRuleActionParametersRawResponseField[]
    The raw response fields to log.
    readTimeout number
    A timeout value between two successive read operations to use for 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
    Whether Cloudflare should respect strong ETag (entity tag) headers. If false, 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
    Whether to enable 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 option. 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
    The Security Level to configure. Available values: "off", "essentiallyoff", "low", "medium", "high", "underattack".
    serveStale GetRulesetRuleActionParametersServeStale
    When to serve stale content from cache.
    serverSideExcludes boolean
    Whether to enable Server-Side Excludes.
    sni GetRulesetRuleActionParametersSni
    A Server Name Indication (SNI) override.
    ssl string
    The SSL level to configure. Available values: "off", "flexible", "full", "strict", "origin_pull".
    statusCode number
    The status code to use for the error.
    sxg boolean
    Whether to enable Signed Exchanges (SXG).
    transformedRequestFields GetRulesetRuleActionParametersTransformedRequestField[]
    The transformed request fields to log.
    uri GetRulesetRuleActionParametersUri
    A URI rewrite.
    additional_cacheable_ports Sequence[int]
    A list of additional ports that caching should be enabled on.
    algorithms Sequence[GetRulesetRuleActionParametersAlgorithm]
    Custom order for compression algorithms.
    asset_name str
    The name of a custom asset to serve as the response.
    automatic_https_rewrites bool
    Whether to enable Automatic HTTPS Rewrites.
    autominify GetRulesetRuleActionParametersAutominify
    Which file extensions to minify automatically.
    bic bool
    Whether to enable Browser Integrity Check (BIC).
    browser_ttl GetRulesetRuleActionParametersBrowserTtl
    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
    Whether the request's response from the origin is eligible for caching. Caching itself will still depend on the cache control header and your other caching configurations.
    cache_key GetRulesetRuleActionParametersCacheKey
    Which components of the request are included in or excluded from the cache key Cloudflare uses to store the response in cache.
    cache_reserve GetRulesetRuleActionParametersCacheReserve
    Settings to determine whether the request's response from origin is eligible for Cache Reserve (requires a Cache Reserve add-on plan).
    content str
    The response content.
    content_type str
    The content type header to set with the error response. Available values: "application/json", "text/html", "text/plain", "text/xml".
    cookie_fields Sequence[GetRulesetRuleActionParametersCookieField]
    The cookie fields to log.
    disable_apps bool
    Whether to disable Cloudflare Apps.
    disable_rum bool
    Whether to disable Real User Monitoring (RUM).
    disable_zaraz bool
    Whether to disable Zaraz.
    edge_ttl GetRulesetRuleActionParametersEdgeTtl
    How long the Cloudflare edge network should cache the response.
    email_obfuscation bool
    Whether to enable Email Obfuscation.
    fonts bool
    Whether to enable Cloudflare Fonts.
    from_list GetRulesetRuleActionParametersFromList
    A redirect based on a bulk list lookup.
    from_value GetRulesetRuleActionParametersFromValue
    A redirect based on the request properties.
    headers Mapping[str, GetRulesetRuleActionParametersHeaders]
    A map of headers to rewrite.
    host_header str
    A value to rewrite the HTTP host header to.
    hotlink_protection bool
    Whether to enable Hotlink Protection.
    id str
    The ID of the ruleset to execute.
    increment int
    A delta to change the score by, which can be either positive or negative.
    matched_data GetRulesetRuleActionParametersMatchedData
    The configuration to use for matched data logging.
    mirage bool
    Whether to enable Mirage.
    opportunistic_encryption bool
    Whether to enable Opportunistic Encryption.
    origin GetRulesetRuleActionParametersOrigin
    An origin to route to.
    origin_cache_control bool
    Whether Cloudflare will aim to strictly adhere to RFC 7234.
    origin_error_page_passthru bool
    Whether to generate Cloudflare error pages for issues from the origin server.
    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 rulesets option. 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".
    polish str
    The Polish level to configure. Available values: "off", "lossless", "lossy", "webp".
    products Sequence[str]
    A list of legacy security products to skip the execution of. Available values: "bic", "hot", "rateLimit", "securityLevel", "uaBlock", "waf", "zoneLockdown".
    raw_response_fields Sequence[GetRulesetRuleActionParametersRawResponseField]
    The raw response fields to log.
    read_timeout int
    A timeout value between two successive read operations to use for 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
    Whether Cloudflare should respect strong ETag (entity tag) headers. If false, 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
    Whether to enable 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 option. 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
    The Security Level to configure. Available values: "off", "essentiallyoff", "low", "medium", "high", "underattack".
    serve_stale GetRulesetRuleActionParametersServeStale
    When to serve stale content from cache.
    server_side_excludes bool
    Whether to enable Server-Side Excludes.
    sni GetRulesetRuleActionParametersSni
    A Server Name Indication (SNI) override.
    ssl str
    The SSL level to configure. Available values: "off", "flexible", "full", "strict", "origin_pull".
    status_code int
    The status code to use for the error.
    sxg bool
    Whether to enable Signed Exchanges (SXG).
    transformed_request_fields Sequence[GetRulesetRuleActionParametersTransformedRequestField]
    The transformed request fields to log.
    uri GetRulesetRuleActionParametersUri
    A URI rewrite.
    additionalCacheablePorts List<Number>
    A list of additional ports that caching should be enabled on.
    algorithms List<Property Map>
    Custom order for compression algorithms.
    assetName String
    The name of a custom asset to serve as the response.
    automaticHttpsRewrites Boolean
    Whether to enable Automatic HTTPS Rewrites.
    autominify Property Map
    Which file extensions to minify automatically.
    bic Boolean
    Whether to enable Browser Integrity Check (BIC).
    browserTtl Property Map
    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
    Whether the request's response from the origin is eligible for caching. Caching itself will still depend on the cache control header and your other caching configurations.
    cacheKey Property Map
    Which components of the request are included in or excluded from the cache key Cloudflare uses to store the response in cache.
    cacheReserve Property Map
    Settings to determine whether the request's response from origin is eligible for Cache Reserve (requires a Cache Reserve add-on plan).
    content String
    The response content.
    contentType String
    The content type header to set with the error response. Available values: "application/json", "text/html", "text/plain", "text/xml".
    cookieFields List<Property Map>
    The cookie fields to log.
    disableApps Boolean
    Whether to disable Cloudflare Apps.
    disableRum Boolean
    Whether to disable Real User Monitoring (RUM).
    disableZaraz Boolean
    Whether to disable Zaraz.
    edgeTtl Property Map
    How long the Cloudflare edge network should cache the response.
    emailObfuscation Boolean
    Whether to enable Email Obfuscation.
    fonts Boolean
    Whether to enable Cloudflare Fonts.
    fromList Property Map
    A redirect based on a bulk list lookup.
    fromValue Property Map
    A redirect based on the request properties.
    headers Map<Property Map>
    A map of headers to rewrite.
    hostHeader String
    A value to rewrite the HTTP host header to.
    hotlinkProtection Boolean
    Whether to enable Hotlink Protection.
    id String
    The ID of the ruleset to execute.
    increment Number
    A delta to change the score by, which can be either positive or negative.
    matchedData Property Map
    The configuration to use for matched data logging.
    mirage Boolean
    Whether to enable Mirage.
    opportunisticEncryption Boolean
    Whether to enable Opportunistic Encryption.
    origin Property Map
    An origin to route to.
    originCacheControl Boolean
    Whether Cloudflare will aim to strictly adhere to RFC 7234.
    originErrorPagePassthru Boolean
    Whether to generate Cloudflare error pages for issues from the origin server.
    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 rulesets option. 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".
    polish String
    The Polish level to configure. Available values: "off", "lossless", "lossy", "webp".
    products List<String>
    A list of legacy security products to skip the execution of. Available values: "bic", "hot", "rateLimit", "securityLevel", "uaBlock", "waf", "zoneLockdown".
    rawResponseFields List<Property Map>
    The raw response fields to log.
    readTimeout Number
    A timeout value between two successive read operations to use for 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
    Whether Cloudflare should respect strong ETag (entity tag) headers. If false, 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
    Whether to enable 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 option. 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
    The Security Level to configure. Available values: "off", "essentiallyoff", "low", "medium", "high", "underattack".
    serveStale Property Map
    When to serve stale content from cache.
    serverSideExcludes Boolean
    Whether to enable Server-Side Excludes.
    sni Property Map
    A Server Name Indication (SNI) override.
    ssl String
    The SSL level to configure. Available values: "off", "flexible", "full", "strict", "origin_pull".
    statusCode Number
    The status code to use for the error.
    sxg Boolean
    Whether to enable Signed Exchanges (SXG).
    transformedRequestFields List<Property Map>
    The transformed request fields to log.
    uri Property Map
    A URI rewrite.

    GetRulesetRuleActionParametersAlgorithm

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

    GetRulesetRuleActionParametersAutominify

    Css bool
    Whether to minify CSS files.
    Html bool
    Whether to minify HTML files.
    Js bool
    Whether to minify JavaScript files.
    Css bool
    Whether to minify CSS files.
    Html bool
    Whether to minify HTML files.
    Js bool
    Whether to minify JavaScript files.
    css Boolean
    Whether to minify CSS files.
    html Boolean
    Whether to minify HTML files.
    js Boolean
    Whether to minify JavaScript files.
    css boolean
    Whether to minify CSS files.
    html boolean
    Whether to minify HTML files.
    js boolean
    Whether to minify JavaScript files.
    css bool
    Whether to minify CSS files.
    html bool
    Whether to minify HTML files.
    js bool
    Whether to minify JavaScript files.
    css Boolean
    Whether to minify CSS files.
    html Boolean
    Whether to minify HTML files.
    js Boolean
    Whether to minify JavaScript files.

    GetRulesetRuleActionParametersBrowserTtl

    Default int
    The browser TTL (in seconds) if you choose the "override_origin" mode.
    Mode string
    The browser TTL mode. Available values: "respectorigin", "bypassbydefault", "overrideorigin", "bypass".
    Default int
    The browser TTL (in seconds) if you choose the "override_origin" mode.
    Mode string
    The browser TTL mode. Available values: "respectorigin", "bypassbydefault", "overrideorigin", "bypass".
    default_ Integer
    The browser TTL (in seconds) if you choose the "override_origin" mode.
    mode String
    The browser TTL mode. Available values: "respectorigin", "bypassbydefault", "overrideorigin", "bypass".
    default number
    The browser TTL (in seconds) if you choose the "override_origin" mode.
    mode string
    The browser TTL mode. Available values: "respectorigin", "bypassbydefault", "overrideorigin", "bypass".
    default int
    The browser TTL (in seconds) if you choose the "override_origin" mode.
    mode str
    The browser TTL mode. Available values: "respectorigin", "bypassbydefault", "overrideorigin", "bypass".
    default Number
    The browser TTL (in seconds) if you choose the "override_origin" mode.
    mode String
    The browser TTL mode. Available values: "respectorigin", "bypassbydefault", "overrideorigin", "bypass".

    GetRulesetRuleActionParametersCacheKey

    CacheByDeviceType bool
    Whether to separate cached content based on the visitor's device type.
    CacheDeceptionArmor bool
    Whether to protect from web cache deception attacks, while allowing static assets to be cached.
    CustomKey GetRulesetRuleActionParametersCacheKeyCustomKey
    Which components of the request are included or excluded from the cache key.
    IgnoreQueryStringsOrder bool
    Whether to treat requests with the same query parameters the same, regardless of the order those query parameters are in.
    CacheByDeviceType bool
    Whether to separate cached content based on the visitor's device type.
    CacheDeceptionArmor bool
    Whether to protect from web cache deception attacks, while allowing static assets to be cached.
    CustomKey GetRulesetRuleActionParametersCacheKeyCustomKey
    Which components of the request are included or excluded from the cache key.
    IgnoreQueryStringsOrder bool
    Whether to treat requests with the same query parameters the same, regardless of the order those query parameters are in.
    cacheByDeviceType Boolean
    Whether to separate cached content based on the visitor's device type.
    cacheDeceptionArmor Boolean
    Whether to protect from web cache deception attacks, while allowing static assets to be cached.
    customKey GetRulesetRuleActionParametersCacheKeyCustomKey
    Which components of the request are included or excluded from the cache key.
    ignoreQueryStringsOrder Boolean
    Whether to treat requests with the same query parameters the same, regardless of the order those query parameters are in.
    cacheByDeviceType boolean
    Whether to separate cached content based on the visitor's device type.
    cacheDeceptionArmor boolean
    Whether to protect from web cache deception attacks, while allowing static assets to be cached.
    customKey GetRulesetRuleActionParametersCacheKeyCustomKey
    Which components of the request are included or excluded from the cache key.
    ignoreQueryStringsOrder boolean
    Whether to treat requests with the same query parameters the same, regardless of the order those query parameters are in.
    cache_by_device_type bool
    Whether to separate cached content based on the visitor's device type.
    cache_deception_armor bool
    Whether to protect from web cache deception attacks, while allowing static assets to be cached.
    custom_key GetRulesetRuleActionParametersCacheKeyCustomKey
    Which components of the request are included or excluded from the cache key.
    ignore_query_strings_order bool
    Whether to treat requests with the same query parameters the same, regardless of the order those query parameters are in.
    cacheByDeviceType Boolean
    Whether to separate cached content based on the visitor's device type.
    cacheDeceptionArmor Boolean
    Whether to protect from web cache deception attacks, while allowing static assets to be cached.
    customKey Property Map
    Which components of the request are included or excluded from the cache key.
    ignoreQueryStringsOrder Boolean
    Whether to treat requests with the same query parameters the same, regardless of the order those query parameters are in.

    GetRulesetRuleActionParametersCacheKeyCustomKey

    Cookie GetRulesetRuleActionParametersCacheKeyCustomKeyCookie
    Which cookies to include in the cache key.
    Header GetRulesetRuleActionParametersCacheKeyCustomKeyHeader
    Which headers to include in the cache key.
    Host GetRulesetRuleActionParametersCacheKeyCustomKeyHost
    How to use the host in the cache key.
    QueryString GetRulesetRuleActionParametersCacheKeyCustomKeyQueryString
    Which query string parameters to include in or exclude from the cache key.
    User GetRulesetRuleActionParametersCacheKeyCustomKeyUser
    How to use characteristics of the request user agent in the cache key.
    Cookie GetRulesetRuleActionParametersCacheKeyCustomKeyCookie
    Which cookies to include in the cache key.
    Header GetRulesetRuleActionParametersCacheKeyCustomKeyHeader
    Which headers to include in the cache key.
    Host GetRulesetRuleActionParametersCacheKeyCustomKeyHost
    How to use the host in the cache key.
    QueryString GetRulesetRuleActionParametersCacheKeyCustomKeyQueryString
    Which query string parameters to include in or exclude from the cache key.
    User GetRulesetRuleActionParametersCacheKeyCustomKeyUser
    How to use characteristics of the request user agent in the cache key.
    cookie GetRulesetRuleActionParametersCacheKeyCustomKeyCookie
    Which cookies to include in the cache key.
    header GetRulesetRuleActionParametersCacheKeyCustomKeyHeader
    Which headers to include in the cache key.
    host GetRulesetRuleActionParametersCacheKeyCustomKeyHost
    How to use the host in the cache key.
    queryString GetRulesetRuleActionParametersCacheKeyCustomKeyQueryString
    Which query string parameters to include in or exclude from the cache key.
    user GetRulesetRuleActionParametersCacheKeyCustomKeyUser
    How to use characteristics of the request user agent in the cache key.
    cookie GetRulesetRuleActionParametersCacheKeyCustomKeyCookie
    Which cookies to include in the cache key.
    header GetRulesetRuleActionParametersCacheKeyCustomKeyHeader
    Which headers to include in the cache key.
    host GetRulesetRuleActionParametersCacheKeyCustomKeyHost
    How to use the host in the cache key.
    queryString GetRulesetRuleActionParametersCacheKeyCustomKeyQueryString
    Which query string parameters to include in or exclude from the cache key.
    user GetRulesetRuleActionParametersCacheKeyCustomKeyUser
    How to use characteristics of the request user agent in the cache key.
    cookie GetRulesetRuleActionParametersCacheKeyCustomKeyCookie
    Which cookies to include in the cache key.
    header GetRulesetRuleActionParametersCacheKeyCustomKeyHeader
    Which headers to include in the cache key.
    host GetRulesetRuleActionParametersCacheKeyCustomKeyHost
    How to use the host in the cache key.
    query_string GetRulesetRuleActionParametersCacheKeyCustomKeyQueryString
    Which query string parameters to include in or exclude from the cache key.
    user GetRulesetRuleActionParametersCacheKeyCustomKeyUser
    How to use characteristics of the request user agent in the cache key.
    cookie Property Map
    Which cookies to include in the cache key.
    header Property Map
    Which headers to include in the cache key.
    host Property Map
    How to use the host in the cache key.
    queryString Property Map
    Which query string parameters to include in or exclude from the cache key.
    user Property Map
    How to use characteristics of the request user agent in the cache key.

    GetRulesetRuleActionParametersCacheKeyCustomKeyCookie

    CheckPresences List<string>
    A list of cookies to check for the presence of. The presence of these cookies is included in the cache key.
    Includes List<string>
    A list of cookies to include in the cache key.
    CheckPresences []string
    A list of cookies to check for the presence of. The presence of these cookies is included in the cache key.
    Includes []string
    A list of cookies to include in the cache key.
    checkPresences List<String>
    A list of cookies to check for the presence of. The presence of these cookies is included in the cache key.
    includes List<String>
    A list of cookies to include in the cache key.
    checkPresences string[]
    A list of cookies to check for the presence of. The presence of these cookies is included in the cache key.
    includes string[]
    A list of cookies to include in the cache key.
    check_presences Sequence[str]
    A list of cookies to check for the presence of. The presence of these cookies is included in the cache key.
    includes Sequence[str]
    A list of cookies to include in the cache key.
    checkPresences List<String>
    A list of cookies to check for the presence of. The presence of these cookies is included in the cache key.
    includes List<String>
    A list of cookies to include in the cache key.

    GetRulesetRuleActionParametersCacheKeyCustomKeyHeader

    CheckPresences List<string>
    A list of headers to check for the presence of. The presence of these headers is included in the cache key.
    Contains Dictionary<string, ImmutableArray<string>>
    A mapping of header names to a list of values. If a header is present in the request and contains any of the values provided, its value is included in the cache key.
    ExcludeOrigin bool
    Whether to exclude the origin header in the cache key.
    Includes List<string>
    A list of headers to include in the cache key.
    CheckPresences []string
    A list of headers to check for the presence of. The presence of these headers is included in the cache key.
    Contains map[string][]string
    A mapping of header names to a list of values. If a header is present in the request and contains any of the values provided, its value is included in the cache key.
    ExcludeOrigin bool
    Whether to exclude the origin header in the cache key.
    Includes []string
    A list of headers to include in the cache key.
    checkPresences List<String>
    A list of headers to check for the presence of. The presence of these headers is included in the cache key.
    contains Map<String,List<String>>
    A mapping of header names to a list of values. If a header is present in the request and contains any of the values provided, its value is included in the cache key.
    excludeOrigin Boolean
    Whether to exclude the origin header in the cache key.
    includes List<String>
    A list of headers to include in the cache key.
    checkPresences string[]
    A list of headers to check for the presence of. The presence of these headers is included in the cache key.
    contains {[key: string]: string[]}
    A mapping of header names to a list of values. If a header is present in the request and contains any of the values provided, its value is included in the cache key.
    excludeOrigin boolean
    Whether to exclude the origin header in the cache key.
    includes string[]
    A list of headers to include in the cache key.
    check_presences Sequence[str]
    A list of headers to check for the presence of. The presence of these headers is included in the cache key.
    contains Mapping[str, Sequence[str]]
    A mapping of header names to a list of values. If a header is present in the request and contains any of the values provided, its value is included in the cache key.
    exclude_origin bool
    Whether to exclude the origin header in the cache key.
    includes Sequence[str]
    A list of headers to include in the cache key.
    checkPresences List<String>
    A list of headers to check for the presence of. The presence of these headers is included in the cache key.
    contains Map<List<String>>
    A mapping of header names to a list of values. If a header is present in the request and contains any of the values provided, its value is included in the cache key.
    excludeOrigin Boolean
    Whether to exclude the origin header in the cache key.
    includes List<String>
    A list of headers to include in the cache key.

    GetRulesetRuleActionParametersCacheKeyCustomKeyHost

    Resolved bool
    Whether to use the resolved host in the cache key.
    Resolved bool
    Whether to use the resolved host in the cache key.
    resolved Boolean
    Whether to use the resolved host in the cache key.
    resolved boolean
    Whether to use the resolved host in the cache key.
    resolved bool
    Whether to use the resolved host in the cache key.
    resolved Boolean
    Whether to use the resolved host in the cache key.

    GetRulesetRuleActionParametersCacheKeyCustomKeyQueryString

    Exclude GetRulesetRuleActionParametersCacheKeyCustomKeyQueryStringExclude
    Which query string parameters to exclude from the cache key.
    Include GetRulesetRuleActionParametersCacheKeyCustomKeyQueryStringInclude
    Which query string parameters to include in the cache key.
    Exclude GetRulesetRuleActionParametersCacheKeyCustomKeyQueryStringExclude
    Which query string parameters to exclude from the cache key.
    Include GetRulesetRuleActionParametersCacheKeyCustomKeyQueryStringInclude
    Which query string parameters to include in the cache key.
    exclude GetRulesetRuleActionParametersCacheKeyCustomKeyQueryStringExclude
    Which query string parameters to exclude from the cache key.
    include GetRulesetRuleActionParametersCacheKeyCustomKeyQueryStringInclude
    Which query string parameters to include in the cache key.
    exclude GetRulesetRuleActionParametersCacheKeyCustomKeyQueryStringExclude
    Which query string parameters to exclude from the cache key.
    include GetRulesetRuleActionParametersCacheKeyCustomKeyQueryStringInclude
    Which query string parameters to include in the cache key.
    exclude GetRulesetRuleActionParametersCacheKeyCustomKeyQueryStringExclude
    Which query string parameters to exclude from the cache key.
    include GetRulesetRuleActionParametersCacheKeyCustomKeyQueryStringInclude
    Which query string parameters to include in the cache key.
    exclude Property Map
    Which query string parameters to exclude from the cache key.
    include Property Map
    Which query string parameters to include in the cache key.

    GetRulesetRuleActionParametersCacheKeyCustomKeyQueryStringExclude

    All bool
    Whether to exclude all query string parameters from the cache key.
    Lists List<string>
    A list of query string parameters to exclude from the cache key.
    All bool
    Whether to exclude all query string parameters from the cache key.
    Lists []string
    A list of query string parameters to exclude from the cache key.
    all Boolean
    Whether to exclude all query string parameters from the cache key.
    lists List<String>
    A list of query string parameters to exclude from the cache key.
    all boolean
    Whether to exclude all query string parameters from the cache key.
    lists string[]
    A list of query string parameters to exclude from the cache key.
    all bool
    Whether to exclude all query string parameters from the cache key.
    lists Sequence[str]
    A list of query string parameters to exclude from the cache key.
    all Boolean
    Whether to exclude all query string parameters from the cache key.
    lists List<String>
    A list of query string parameters to exclude from the cache key.

    GetRulesetRuleActionParametersCacheKeyCustomKeyQueryStringInclude

    All bool
    Whether to include all query string parameters in the cache key.
    Lists List<string>
    A list of query string parameters to include in the cache key.
    All bool
    Whether to include all query string parameters in the cache key.
    Lists []string
    A list of query string parameters to include in the cache key.
    all Boolean
    Whether to include all query string parameters in the cache key.
    lists List<String>
    A list of query string parameters to include in the cache key.
    all boolean
    Whether to include all query string parameters in the cache key.
    lists string[]
    A list of query string parameters to include in the cache key.
    all bool
    Whether to include all query string parameters in the cache key.
    lists Sequence[str]
    A list of query string parameters to include in the cache key.
    all Boolean
    Whether to include all query string parameters in the cache key.
    lists List<String>
    A list of query string parameters to include in the cache key.

    GetRulesetRuleActionParametersCacheKeyCustomKeyUser

    DeviceType bool
    Whether to use the user agent's device type in the cache key.
    Geo bool
    Whether to use the user agents's country in the cache key.
    Lang bool
    Whether to use the user agent's language in the cache key.
    DeviceType bool
    Whether to use the user agent's device type in the cache key.
    Geo bool
    Whether to use the user agents's country in the cache key.
    Lang bool
    Whether to use the user agent's language in the cache key.
    deviceType Boolean
    Whether to use the user agent's device type in the cache key.
    geo Boolean
    Whether to use the user agents's country in the cache key.
    lang Boolean
    Whether to use the user agent's language in the cache key.
    deviceType boolean
    Whether to use the user agent's device type in the cache key.
    geo boolean
    Whether to use the user agents's country in the cache key.
    lang boolean
    Whether to use the user agent's language in the cache key.
    device_type bool
    Whether to use the user agent's device type in the cache key.
    geo bool
    Whether to use the user agents's country in the cache key.
    lang bool
    Whether to use the user agent's language in the cache key.
    deviceType Boolean
    Whether to use the user agent's device type in the cache key.
    geo Boolean
    Whether to use the user agents's country in the cache key.
    lang Boolean
    Whether to use the user agent's language in the cache key.

    GetRulesetRuleActionParametersCacheReserve

    Eligible bool
    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 storage in Cache Reserve.
    Eligible bool
    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 storage in Cache Reserve.
    eligible Boolean
    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 storage in Cache Reserve.
    eligible boolean
    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 storage in Cache Reserve.
    eligible bool
    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 storage in Cache Reserve.
    eligible Boolean
    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 storage in Cache Reserve.

    GetRulesetRuleActionParametersCookieField

    Name string
    The name of the cookie.
    Name string
    The name of the cookie.
    name String
    The name of the cookie.
    name string
    The name of the cookie.
    name str
    The name of the cookie.
    name String
    The name of the cookie.

    GetRulesetRuleActionParametersEdgeTtl

    Default int
    The edge TTL (in seconds) if you choose the "override_origin" mode.
    Mode string
    The edge TTL mode. Available values: "respectorigin", "bypassbydefault", "overrideorigin".
    StatusCodeTtls List<GetRulesetRuleActionParametersEdgeTtlStatusCodeTtl>
    A list of TTLs to apply to specific status codes or status code ranges.
    Default int
    The edge TTL (in seconds) if you choose the "override_origin" mode.
    Mode string
    The edge TTL mode. Available values: "respectorigin", "bypassbydefault", "overrideorigin".
    StatusCodeTtls []GetRulesetRuleActionParametersEdgeTtlStatusCodeTtl
    A list of TTLs to apply to specific status codes or status code ranges.
    default_ Integer
    The edge TTL (in seconds) if you choose the "override_origin" mode.
    mode String
    The edge TTL mode. Available values: "respectorigin", "bypassbydefault", "overrideorigin".
    statusCodeTtls List<GetRulesetRuleActionParametersEdgeTtlStatusCodeTtl>
    A list of TTLs to apply to specific status codes or status code ranges.
    default number
    The edge TTL (in seconds) if you choose the "override_origin" mode.
    mode string
    The edge TTL mode. Available values: "respectorigin", "bypassbydefault", "overrideorigin".
    statusCodeTtls GetRulesetRuleActionParametersEdgeTtlStatusCodeTtl[]
    A list of TTLs to apply to specific status codes or status code ranges.
    default int
    The edge TTL (in seconds) if you choose the "override_origin" mode.
    mode str
    The edge TTL mode. Available values: "respectorigin", "bypassbydefault", "overrideorigin".
    status_code_ttls Sequence[GetRulesetRuleActionParametersEdgeTtlStatusCodeTtl]
    A list of TTLs to apply to specific status codes or status code ranges.
    default Number
    The edge TTL (in seconds) if you choose the "override_origin" mode.
    mode String
    The edge TTL mode. Available values: "respectorigin", "bypassbydefault", "overrideorigin".
    statusCodeTtls List<Property Map>
    A list of TTLs to apply to specific status codes or status code ranges.

    GetRulesetRuleActionParametersEdgeTtlStatusCodeTtl

    StatusCode int
    A single status code to apply the TTL to.
    StatusCodeRange GetRulesetRuleActionParametersEdgeTtlStatusCodeTtlStatusCodeRange
    A range of status codes to apply the TTL to.
    Value int
    The time to cache the response for (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 the cache control header with the value of "no-store".
    StatusCode int
    A single status code to apply the TTL to.
    StatusCodeRange GetRulesetRuleActionParametersEdgeTtlStatusCodeTtlStatusCodeRange
    A range of status codes to apply the TTL to.
    Value int
    The time to cache the response for (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 the cache control header with the value of "no-store".
    statusCode Integer
    A single status code to apply the TTL to.
    statusCodeRange GetRulesetRuleActionParametersEdgeTtlStatusCodeTtlStatusCodeRange
    A range of status codes to apply the TTL to.
    value Integer
    The time to cache the response for (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 the cache control header with the value of "no-store".
    statusCode number
    A single status code to apply the TTL to.
    statusCodeRange GetRulesetRuleActionParametersEdgeTtlStatusCodeTtlStatusCodeRange
    A range of status codes to apply the TTL to.
    value number
    The time to cache the response for (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 the cache control header with the value of "no-store".
    status_code int
    A single status code to apply the TTL to.
    status_code_range GetRulesetRuleActionParametersEdgeTtlStatusCodeTtlStatusCodeRange
    A range of status codes to apply the TTL to.
    value int
    The time to cache the response for (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 the cache control header with the value of "no-store".
    statusCode Number
    A single status code to apply the TTL to.
    statusCodeRange Property Map
    A range of status codes to apply the TTL to.
    value Number
    The time to cache the response for (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 the cache control header with the value of "no-store".

    GetRulesetRuleActionParametersEdgeTtlStatusCodeTtlStatusCodeRange

    From int
    The lower bound of the range.
    To int
    The upper bound of the range.
    From int
    The lower bound of the range.
    To int
    The upper bound of the range.
    from Integer
    The lower bound of the range.
    to Integer
    The upper bound of the range.
    from number
    The lower bound of the range.
    to number
    The upper bound of the range.
    from_ int
    The lower bound of the range.
    to int
    The upper bound of the range.
    from Number
    The lower bound of the range.
    to Number
    The upper bound of the range.

    GetRulesetRuleActionParametersFromList

    Key string
    An expression that evaluates to the list lookup key.
    Name string
    The name of the list to match against.
    Key string
    An expression that evaluates to the list lookup key.
    Name string
    The name of the list to match against.
    key String
    An expression that evaluates to the list lookup key.
    name String
    The name of the list to match against.
    key string
    An expression that evaluates to the list lookup key.
    name string
    The name of the list to match against.
    key str
    An expression that evaluates to the list lookup key.
    name str
    The name of the list to match against.
    key String
    An expression that evaluates to the list lookup key.
    name String
    The name of the list to match against.

    GetRulesetRuleActionParametersFromValue

    PreserveQueryString bool
    Whether to keep the query string of the original request.
    StatusCode int
    The status code to use for the redirect.
    TargetUrl GetRulesetRuleActionParametersFromValueTargetUrl
    A URL to redirect the request to.
    PreserveQueryString bool
    Whether to keep the query string of the original request.
    StatusCode int
    The status code to use for the redirect.
    TargetUrl GetRulesetRuleActionParametersFromValueTargetUrl
    A URL to redirect the request to.
    preserveQueryString Boolean
    Whether to keep the query string of the original request.
    statusCode Integer
    The status code to use for the redirect.
    targetUrl GetRulesetRuleActionParametersFromValueTargetUrl
    A URL to redirect the request to.
    preserveQueryString boolean
    Whether to keep the query string of the original request.
    statusCode number
    The status code to use for the redirect.
    targetUrl GetRulesetRuleActionParametersFromValueTargetUrl
    A URL to redirect the request to.
    preserve_query_string bool
    Whether to keep the query string of the original request.
    status_code int
    The status code to use for the redirect.
    target_url GetRulesetRuleActionParametersFromValueTargetUrl
    A URL to redirect the request to.
    preserveQueryString Boolean
    Whether to keep the query string of the original request.
    statusCode Number
    The status code to use for the redirect.
    targetUrl Property Map
    A URL to redirect the request to.

    GetRulesetRuleActionParametersFromValueTargetUrl

    Expression string
    An expression that evaluates to a URL to redirect the request to.
    Value string
    A URL to redirect the request to.
    Expression string
    An expression that evaluates to a URL to redirect the request to.
    Value string
    A URL to redirect the request to.
    expression String
    An expression that evaluates to a URL to redirect the request to.
    value String
    A URL to redirect the request to.
    expression string
    An expression that evaluates to a URL to redirect the request to.
    value string
    A URL to redirect the request to.
    expression str
    An expression that evaluates to a URL to redirect the request to.
    value str
    A URL to redirect the request to.
    expression String
    An expression that evaluates to a URL to redirect the request to.
    value String
    A URL to redirect the request to.

    GetRulesetRuleActionParametersHeaders

    Expression string
    An expression that evaluates to a value for the header.
    Operation string
    The operation to perform on the header. Available values: "add", "set", "remove".
    Value string
    A static value for the header.
    Expression string
    An expression that evaluates to a value for the header.
    Operation string
    The operation to perform on the header. Available values: "add", "set", "remove".
    Value string
    A static value for the header.
    expression String
    An expression that evaluates to a value for the header.
    operation String
    The operation to perform on the header. Available values: "add", "set", "remove".
    value String
    A static value for the header.
    expression string
    An expression that evaluates to a value for the header.
    operation string
    The operation to perform on the header. Available values: "add", "set", "remove".
    value string
    A static value for the header.
    expression str
    An expression that evaluates to a value for the header.
    operation str
    The operation to perform on the header. Available values: "add", "set", "remove".
    value str
    A static value for the header.
    expression String
    An expression that evaluates to a value for the header.
    operation String
    The operation to perform on the header. Available values: "add", "set", "remove".
    value String
    A 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
    A resolved host to route to.
    Port int
    A destination port to route to.
    Host string
    A resolved host to route to.
    Port int
    A destination port to route to.
    host String
    A resolved host to route to.
    port Integer
    A destination port to route to.
    host string
    A resolved host to route to.
    port number
    A destination port to route to.
    host str
    A resolved host to route to.
    port int
    A destination port to route to.
    host String
    A resolved host to route to.
    port Number
    A destination port to route to.

    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. This option is only applicable for DDoS phases. 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. This option is only applicable for DDoS phases. 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. This option is only applicable for DDoS phases. 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. This option is only applicable for DDoS phases. 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. This option is only applicable for DDoS phases. 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. This option is only applicable for DDoS phases. 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. This option is only applicable for DDoS phases. 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. This option is only applicable for DDoS phases. 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. This option is only applicable for DDoS phases. 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. This option is only applicable for DDoS phases. 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. This option is only applicable for DDoS phases. 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. This option is only applicable for DDoS phases. Available values: "default", "medium", "low", "eoff".

    GetRulesetRuleActionParametersRawResponseField

    Name string
    The name of the response header.
    PreserveDuplicates bool
    Whether to log duplicate values of the same header.
    Name string
    The name of the response header.
    PreserveDuplicates bool
    Whether to log duplicate values of the same header.
    name String
    The name of the response header.
    preserveDuplicates Boolean
    Whether to log duplicate values of the same header.
    name string
    The name of the response header.
    preserveDuplicates boolean
    Whether to log duplicate values of the same header.
    name str
    The name of the response header.
    preserve_duplicates bool
    Whether to log duplicate values of the same header.
    name String
    The name of the response header.
    preserveDuplicates Boolean
    Whether to log duplicate values of the same header.

    GetRulesetRuleActionParametersRequestField

    Name string
    The name of the header.
    Name string
    The name of the header.
    name String
    The name of the header.
    name string
    The name of the header.
    name str
    The name of the header.
    name String
    The name of the header.

    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 response header.
    PreserveDuplicates bool
    Whether to log duplicate values of the same header.
    Name string
    The name of the response header.
    PreserveDuplicates bool
    Whether to log duplicate values of the same header.
    name String
    The name of the response header.
    preserveDuplicates Boolean
    Whether to log duplicate values of the same header.
    name string
    The name of the response header.
    preserveDuplicates boolean
    Whether to log duplicate values of the same header.
    name str
    The name of the response header.
    preserve_duplicates bool
    Whether to log duplicate values of the same header.
    name String
    The name of the response header.
    preserveDuplicates Boolean
    Whether to log duplicate values of the same header.

    GetRulesetRuleActionParametersServeStale

    DisableStaleWhileUpdating bool
    Whether Cloudflare should disable serving stale content while getting the latest content from the origin.
    DisableStaleWhileUpdating bool
    Whether Cloudflare should disable serving stale content while getting the latest content from the origin.
    disableStaleWhileUpdating Boolean
    Whether Cloudflare should disable serving stale content while getting the latest content from the origin.
    disableStaleWhileUpdating boolean
    Whether Cloudflare should disable serving stale content while getting the latest content from the origin.
    disable_stale_while_updating bool
    Whether Cloudflare should disable serving stale content while getting the latest content from the origin.
    disableStaleWhileUpdating Boolean
    Whether Cloudflare should disable serving stale content while getting the latest content from the origin.

    GetRulesetRuleActionParametersSni

    Value string
    A value to override the SNI to.
    Value string
    A value to override the SNI to.
    value String
    A value to override the SNI to.
    value string
    A value to override the SNI to.
    value str
    A value to override the SNI to.
    value String
    A value to override the SNI to.

    GetRulesetRuleActionParametersTransformedRequestField

    Name string
    The name of the header.
    Name string
    The name of the header.
    name String
    The name of the header.
    name string
    The name of the header.
    name str
    The name of the header.
    name String
    The name of the header.

    GetRulesetRuleActionParametersUri

    Origin bool
    Whether to propagate the rewritten URI to origin.
    Path GetRulesetRuleActionParametersUriPath
    A URI path rewrite.
    Query GetRulesetRuleActionParametersUriQuery
    A URI query rewrite.
    Origin bool
    Whether to propagate the rewritten URI to origin.
    Path GetRulesetRuleActionParametersUriPath
    A URI path rewrite.
    Query GetRulesetRuleActionParametersUriQuery
    A URI query rewrite.
    origin Boolean
    Whether to propagate the rewritten URI to origin.
    path GetRulesetRuleActionParametersUriPath
    A URI path rewrite.
    query GetRulesetRuleActionParametersUriQuery
    A URI query rewrite.
    origin boolean
    Whether to propagate the rewritten URI to origin.
    path GetRulesetRuleActionParametersUriPath
    A URI path rewrite.
    query GetRulesetRuleActionParametersUriQuery
    A URI query rewrite.
    origin bool
    Whether to propagate the rewritten URI to origin.
    path GetRulesetRuleActionParametersUriPath
    A URI path rewrite.
    query GetRulesetRuleActionParametersUriQuery
    A URI query rewrite.
    origin Boolean
    Whether to propagate the rewritten URI to origin.
    path Property Map
    A URI path rewrite.
    query Property Map
    A URI query rewrite.

    GetRulesetRuleActionParametersUriPath

    Expression string
    An expression that evaluates to a value to rewrite the URI path to.
    Value string
    A value to rewrite the URI path to.
    Expression string
    An expression that evaluates to a value to rewrite the URI path to.
    Value string
    A value to rewrite the URI path to.
    expression String
    An expression that evaluates to a value to rewrite the URI path to.
    value String
    A value to rewrite the URI path to.
    expression string
    An expression that evaluates to a value to rewrite the URI path to.
    value string
    A value to rewrite the URI path to.
    expression str
    An expression that evaluates to a value to rewrite the URI path to.
    value str
    A value to rewrite the URI path to.
    expression String
    An expression that evaluates to a value to rewrite the URI path to.
    value String
    A value to rewrite the URI path to.

    GetRulesetRuleActionParametersUriQuery

    Expression string
    An expression that evaluates to a value to rewrite the URI query to.
    Value string
    A value to rewrite the URI query to.
    Expression string
    An expression that evaluates to a value to rewrite the URI query to.
    Value string
    A value to rewrite the URI query to.
    expression String
    An expression that evaluates to a value to rewrite the URI query to.
    value String
    A value to rewrite the URI query to.
    expression string
    An expression that evaluates to a value to rewrite the URI query to.
    value string
    A value to rewrite the URI query to.
    expression str
    An expression that evaluates to a value to rewrite the URI query to.
    value str
    A value to rewrite the URI query to.
    expression String
    An expression that evaluates to a value to rewrite the URI query to.
    value String
    A value to rewrite the URI query to.

    GetRulesetRuleExposedCredentialCheck

    PasswordExpression string
    An expression that selects the password used in the credentials check.
    UsernameExpression string
    An expression that selects the user ID used in the credentials check.
    PasswordExpression string
    An expression that selects the password used in the credentials check.
    UsernameExpression string
    An expression that selects the user ID used in the credentials check.
    passwordExpression String
    An expression that selects the password used in the credentials check.
    usernameExpression String
    An expression that selects the user ID used in the credentials check.
    passwordExpression string
    An expression that selects the password used in the credentials check.
    usernameExpression string
    An expression that selects the user ID used in the credentials check.
    password_expression str
    An expression that selects the password used in the credentials check.
    username_expression str
    An expression that selects the user ID used in the credentials check.
    passwordExpression String
    An expression that selects the password used in the credentials check.
    usernameExpression String
    An 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 rate limit counter will be incremented.
    CountingExpression string
    An expression that defines when the rate limit counter should be incremented. It 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.
    RequestsPerPeriod int
    The threshold of requests per period after which the action will be executed for the first time.
    RequestsToOrigin bool
    Whether counting is only performed when an origin is reached.
    ScorePerPeriod int
    The score threshold per period for which the action will be executed the first time.
    ScoreResponseHeaderName string
    A response header name provided by the origin, which contains the score to increment rate limit counter with.
    Characteristics []string
    Characteristics of the request on which the rate limit counter will be incremented.
    CountingExpression string
    An expression that defines when the rate limit counter should be incremented. It 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.
    RequestsPerPeriod int
    The threshold of requests per period after which the action will be executed for the first time.
    RequestsToOrigin bool
    Whether counting is only performed when an origin is reached.
    ScorePerPeriod int
    The score threshold per period for which the action will be executed the first time.
    ScoreResponseHeaderName string
    A response header name provided by the origin, which contains the score to increment rate limit counter with.
    characteristics List<String>
    Characteristics of the request on which the rate limit counter will be incremented.
    countingExpression String
    An expression that defines when the rate limit counter should be incremented. It 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.
    requestsPerPeriod Integer
    The threshold of requests per period after which the action will be executed for the first time.
    requestsToOrigin Boolean
    Whether counting is only performed when an origin is reached.
    scorePerPeriod Integer
    The score threshold per period for which the action will be executed the first time.
    scoreResponseHeaderName String
    A response header name provided by the origin, which contains the score to increment rate limit counter with.
    characteristics string[]
    Characteristics of the request on which the rate limit counter will be incremented.
    countingExpression string
    An expression that defines when the rate limit counter should be incremented. It 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.
    requestsPerPeriod number
    The threshold of requests per period after which the action will be executed for the first time.
    requestsToOrigin boolean
    Whether counting is only performed when an origin is reached.
    scorePerPeriod number
    The score threshold per period for which the action will be executed the first time.
    scoreResponseHeaderName string
    A response header name provided by the origin, which contains the score to increment rate limit counter with.
    characteristics Sequence[str]
    Characteristics of the request on which the rate limit counter will be incremented.
    counting_expression str
    An expression that defines when the rate limit counter should be incremented. It 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.
    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
    Whether counting is only performed 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
    A response header name provided by the origin, which contains the score to increment rate limit counter with.
    characteristics List<String>
    Characteristics of the request on which the rate limit counter will be incremented.
    countingExpression String
    An expression that defines when the rate limit counter should be incremented. It 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.
    requestsPerPeriod Number
    The threshold of requests per period after which the action will be executed for the first time.
    requestsToOrigin Boolean
    Whether counting is only performed when an origin is reached.
    scorePerPeriod Number
    The score threshold per period for which the action will be executed the first time.
    scoreResponseHeaderName String
    A response header name provided by the origin, which contains the score to increment rate limit counter with.

    Package Details

    Repository
    Cloudflare pulumi/pulumi-cloudflare
    License
    Apache-2.0
    Notes
    This Pulumi package is based on the cloudflare Terraform Provider.
    cloudflare logo
    Cloudflare v6.9.1 published on Thursday, Sep 18, 2025 by Pulumi