Cloudflare v5.26.0, Apr 17 24

Cloudflare v5.26.0 published on Wednesday, Apr 17, 2024 by Pulumi

cloudflare.getRulesets

Explore with Pulumi AI

Cloudflare v5.26.0 published on Wednesday, Apr 17, 2024 by Pulumi

Example Usage

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

const example = cloudflare.getRulesets({
    filter: {
        name: ".*OWASP.*",
    },
    zoneId: "0da42c8d2132a9ddaf714f9e7c920711",
});

import pulumi
import pulumi_cloudflare as cloudflare

example = cloudflare.get_rulesets(filter=cloudflare.GetRulesetsFilterArgs(
        name=".*OWASP.*",
    ),
    zone_id="0da42c8d2132a9ddaf714f9e7c920711")

package main

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

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := cloudflare.GetRulesets(ctx, &cloudflare.GetRulesetsArgs{
			Filter: cloudflare.GetRulesetsFilter{
				Name: pulumi.StringRef(".*OWASP.*"),
			},
			ZoneId: pulumi.StringRef("0da42c8d2132a9ddaf714f9e7c920711"),
		}, 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 example = Cloudflare.GetRulesets.Invoke(new()
    {
        Filter = new Cloudflare.Inputs.GetRulesetsFilterInputArgs
        {
            Name = ".*OWASP.*",
        },
        ZoneId = "0da42c8d2132a9ddaf714f9e7c920711",
    });

});

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.GetRulesetsArgs;
import com.pulumi.cloudflare.inputs.GetRulesetsFilterArgs;
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 example = CloudflareFunctions.getRulesets(GetRulesetsArgs.builder()
            .filter(GetRulesetsFilterArgs.builder()
                .name(".*OWASP.*")
                .build())
            .zoneId("0da42c8d2132a9ddaf714f9e7c920711")
            .build());

    }
}

variables:
  example:
    fn::invoke:
      Function: cloudflare:getRulesets
      Arguments:
        filter:
          name: .*OWASP.*
        zoneId: 0da42c8d2132a9ddaf714f9e7c920711

Using getRulesets

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 getRulesets(args: GetRulesetsArgs, opts?: InvokeOptions): Promise<GetRulesetsResult>
function getRulesetsOutput(args: GetRulesetsOutputArgs, opts?: InvokeOptions): Output<GetRulesetsResult>

def get_rulesets(account_id: Optional[str] = None,
                 filter: Optional[GetRulesetsFilter] = None,
                 include_rules: Optional[bool] = None,
                 zone_id: Optional[str] = None,
                 opts: Optional[InvokeOptions] = None) -> GetRulesetsResult
def get_rulesets_output(account_id: Optional[pulumi.Input[str]] = None,
                 filter: Optional[pulumi.Input[GetRulesetsFilterArgs]] = None,
                 include_rules: Optional[pulumi.Input[bool]] = None,
                 zone_id: Optional[pulumi.Input[str]] = None,
                 opts: Optional[InvokeOptions] = None) -> Output[GetRulesetsResult]

func GetRulesets(ctx *Context, args *GetRulesetsArgs, opts ...InvokeOption) (*GetRulesetsResult, error)
func GetRulesetsOutput(ctx *Context, args *GetRulesetsOutputArgs, opts ...InvokeOption) GetRulesetsResultOutput

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

public static class GetRulesets 
{
    public static Task<GetRulesetsResult> InvokeAsync(GetRulesetsArgs args, InvokeOptions? opts = null)
    public static Output<GetRulesetsResult> Invoke(GetRulesetsInvokeArgs args, InvokeOptions? opts = null)
}

public static CompletableFuture<GetRulesetsResult> getRulesets(GetRulesetsArgs args, InvokeOptions options)
// Output-based functions aren't available in Java yet

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

The following arguments are supported:

AccountId string: The account identifier to target for the resource. Must provide only one of zone_id, account_id.
Filter GetRulesetsFilter
IncludeRules bool: Include rule data in response.
ZoneId string: The zone identifier to target for the resource. Must provide only one of zone_id, account_id.

AccountId string: The account identifier to target for the resource. Must provide only one of zone_id, account_id.
Filter GetRulesetsFilter
IncludeRules bool: Include rule data in response.
ZoneId string: The zone identifier to target for the resource. Must provide only one of zone_id, account_id.

accountId String: The account identifier to target for the resource. Must provide only one of zone_id, account_id.
filter GetRulesetsFilter
includeRules Boolean: Include rule data in response.
zoneId String: The zone identifier to target for the resource. Must provide only one of zone_id, account_id.

accountId string: The account identifier to target for the resource. Must provide only one of zone_id, account_id.
filter GetRulesetsFilter
includeRules boolean: Include rule data in response.
zoneId string: The zone identifier to target for the resource. Must provide only one of zone_id, account_id.

account_id str: The account identifier to target for the resource. Must provide only one of zone_id, account_id.
filter GetRulesetsFilter
include_rules bool: Include rule data in response.
zone_id str: The zone identifier to target for the resource. Must provide only one of zone_id, account_id.

accountId String: The account identifier to target for the resource. Must provide only one of zone_id, account_id.
filter Property Map
includeRules Boolean: Include rule data in response.
zoneId String: The zone identifier to target for the resource. Must provide only one of zone_id, account_id.

getRulesets Result

The following output properties are available:

Id string: The provider-assigned unique ID for this managed resource.
Rulesets List<GetRulesetsRuleset>
AccountId string: The account identifier to target for the resource. Must provide only one of zone_id, account_id.
Filter GetRulesetsFilter
IncludeRules bool: Include rule data in response.
ZoneId string: The zone identifier to target for the resource. Must provide only one of zone_id, account_id.

Id string: The provider-assigned unique ID for this managed resource.
Rulesets []GetRulesetsRuleset
AccountId string: The account identifier to target for the resource. Must provide only one of zone_id, account_id.
Filter GetRulesetsFilter
IncludeRules bool: Include rule data in response.
ZoneId string: The zone identifier to target for the resource. Must provide only one of zone_id, account_id.

id String: The provider-assigned unique ID for this managed resource.
rulesets List<GetRulesetsRuleset>
accountId String: The account identifier to target for the resource. Must provide only one of zone_id, account_id.
filter GetRulesetsFilter
includeRules Boolean: Include rule data in response.
zoneId String: The zone identifier to target for the resource. Must provide only one of zone_id, account_id.

id string: The provider-assigned unique ID for this managed resource.
rulesets GetRulesetsRuleset[]
accountId string: The account identifier to target for the resource. Must provide only one of zone_id, account_id.
filter GetRulesetsFilter
includeRules boolean: Include rule data in response.
zoneId string: The zone identifier to target for the resource. Must provide only one of zone_id, account_id.

id str: The provider-assigned unique ID for this managed resource.
rulesets Sequence[GetRulesetsRuleset]
account_id str: The account identifier to target for the resource. Must provide only one of zone_id, account_id.
filter GetRulesetsFilter
include_rules bool: Include rule data in response.
zone_id str: The zone identifier to target for the resource. Must provide only one of zone_id, account_id.

id String: The provider-assigned unique ID for this managed resource.
rulesets List<Property Map>
accountId String: The account identifier to target for the resource. Must provide only one of zone_id, account_id.
filter Property Map
includeRules Boolean: Include rule data in response.
zoneId String: The zone identifier to target for the resource. Must provide only one of zone_id, account_id.

Supporting Types

GetRulesetsFilter

Id string: The ID of the Ruleset to target.
Kind string: Type of Ruleset to create. Available values: custom, managed, root, zone.
Name string: Name of the ruleset.
Phase string: Point in the request/response lifecycle where the ruleset will be created. Available values: ddos_l4, ddos_l7, http_config_settings, http_custom_errors, http_log_custom_fields, http_ratelimit, http_request_cache_settings, http_request_dynamic_redirect, http_request_firewall_custom, http_request_firewall_managed, http_request_late_transform, http_request_origin, http_request_redirect, http_request_sanitize, http_request_sbfm, http_request_transform, http_response_compression, http_response_firewall_managed, http_response_headers_transform, magic_transit.
Version string: Version of the ruleset to filter on.

Id string: The ID of the Ruleset to target.
Kind string: Type of Ruleset to create. Available values: custom, managed, root, zone.
Name string: Name of the ruleset.
Phase string: Point in the request/response lifecycle where the ruleset will be created. Available values: ddos_l4, ddos_l7, http_config_settings, http_custom_errors, http_log_custom_fields, http_ratelimit, http_request_cache_settings, http_request_dynamic_redirect, http_request_firewall_custom, http_request_firewall_managed, http_request_late_transform, http_request_origin, http_request_redirect, http_request_sanitize, http_request_sbfm, http_request_transform, http_response_compression, http_response_firewall_managed, http_response_headers_transform, magic_transit.
Version string: Version of the ruleset to filter on.

id String: The ID of the Ruleset to target.
kind String: Type of Ruleset to create. Available values: custom, managed, root, zone.
name String: Name of the ruleset.
phase String: Point in the request/response lifecycle where the ruleset will be created. Available values: ddos_l4, ddos_l7, http_config_settings, http_custom_errors, http_log_custom_fields, http_ratelimit, http_request_cache_settings, http_request_dynamic_redirect, http_request_firewall_custom, http_request_firewall_managed, http_request_late_transform, http_request_origin, http_request_redirect, http_request_sanitize, http_request_sbfm, http_request_transform, http_response_compression, http_response_firewall_managed, http_response_headers_transform, magic_transit.
version String: Version of the ruleset to filter on.

id string: The ID of the Ruleset to target.
kind string: Type of Ruleset to create. Available values: custom, managed, root, zone.
name string: Name of the ruleset.
phase string: Point in the request/response lifecycle where the ruleset will be created. Available values: ddos_l4, ddos_l7, http_config_settings, http_custom_errors, http_log_custom_fields, http_ratelimit, http_request_cache_settings, http_request_dynamic_redirect, http_request_firewall_custom, http_request_firewall_managed, http_request_late_transform, http_request_origin, http_request_redirect, http_request_sanitize, http_request_sbfm, http_request_transform, http_response_compression, http_response_firewall_managed, http_response_headers_transform, magic_transit.
version string: Version of the ruleset to filter on.

id str: The ID of the Ruleset to target.
kind str: Type of Ruleset to create. Available values: custom, managed, root, zone.
name str: Name of the ruleset.
phase str: Point in the request/response lifecycle where the ruleset will be created. Available values: ddos_l4, ddos_l7, http_config_settings, http_custom_errors, http_log_custom_fields, http_ratelimit, http_request_cache_settings, http_request_dynamic_redirect, http_request_firewall_custom, http_request_firewall_managed, http_request_late_transform, http_request_origin, http_request_redirect, http_request_sanitize, http_request_sbfm, http_request_transform, http_response_compression, http_response_firewall_managed, http_response_headers_transform, magic_transit.
version str: Version of the ruleset to filter on.

id String: The ID of the Ruleset to target.
kind String: Type of Ruleset to create. Available values: custom, managed, root, zone.
name String: Name of the ruleset.
phase String: Point in the request/response lifecycle where the ruleset will be created. Available values: ddos_l4, ddos_l7, http_config_settings, http_custom_errors, http_log_custom_fields, http_ratelimit, http_request_cache_settings, http_request_dynamic_redirect, http_request_firewall_custom, http_request_firewall_managed, http_request_late_transform, http_request_origin, http_request_redirect, http_request_sanitize, http_request_sbfm, http_request_transform, http_response_compression, http_response_firewall_managed, http_response_headers_transform, magic_transit.
version String: Version of the ruleset to filter on.

GetRulesetsRuleset

Id string: ID of the ruleset.
Kind string: Type of Ruleset. Available values: custom, managed, root, zone
Name string: Name of the ruleset.
Phase string: Point in the request/response lifecycle where the ruleset executes. Available values: ddos_l4, ddos_l7, http_config_settings, http_custom_errors, http_log_custom_fields, http_ratelimit, http_request_cache_settings, http_request_dynamic_redirect, http_request_firewall_custom, http_request_firewall_managed, http_request_late_transform, http_request_origin, http_request_redirect, http_request_sanitize, http_request_sbfm, http_request_transform, http_response_compression, http_response_firewall_managed, http_response_headers_transform, magic_transit
Version string: Version of the ruleset.
Description string: Brief summary of the ruleset and its intended use.
Rules List<GetRulesetsRulesetRule>: List of rules to apply to the ruleset.

Id string: ID of the ruleset.
Kind string: Type of Ruleset. Available values: custom, managed, root, zone
Name string: Name of the ruleset.
Phase string: Point in the request/response lifecycle where the ruleset executes. Available values: ddos_l4, ddos_l7, http_config_settings, http_custom_errors, http_log_custom_fields, http_ratelimit, http_request_cache_settings, http_request_dynamic_redirect, http_request_firewall_custom, http_request_firewall_managed, http_request_late_transform, http_request_origin, http_request_redirect, http_request_sanitize, http_request_sbfm, http_request_transform, http_response_compression, http_response_firewall_managed, http_response_headers_transform, magic_transit
Version string: Version of the ruleset.
Description string: Brief summary of the ruleset and its intended use.
Rules []GetRulesetsRulesetRule: List of rules to apply to the ruleset.

id String: ID of the ruleset.
kind String: Type of Ruleset. Available values: custom, managed, root, zone
name String: Name of the ruleset.
phase String: Point in the request/response lifecycle where the ruleset executes. Available values: ddos_l4, ddos_l7, http_config_settings, http_custom_errors, http_log_custom_fields, http_ratelimit, http_request_cache_settings, http_request_dynamic_redirect, http_request_firewall_custom, http_request_firewall_managed, http_request_late_transform, http_request_origin, http_request_redirect, http_request_sanitize, http_request_sbfm, http_request_transform, http_response_compression, http_response_firewall_managed, http_response_headers_transform, magic_transit
version String: Version of the ruleset.
description String: Brief summary of the ruleset and its intended use.
rules List<GetRulesetsRulesetRule>: List of rules to apply to the ruleset.

id string: ID of the ruleset.
kind string: Type of Ruleset. Available values: custom, managed, root, zone
name string: Name of the ruleset.
phase string: Point in the request/response lifecycle where the ruleset executes. Available values: ddos_l4, ddos_l7, http_config_settings, http_custom_errors, http_log_custom_fields, http_ratelimit, http_request_cache_settings, http_request_dynamic_redirect, http_request_firewall_custom, http_request_firewall_managed, http_request_late_transform, http_request_origin, http_request_redirect, http_request_sanitize, http_request_sbfm, http_request_transform, http_response_compression, http_response_firewall_managed, http_response_headers_transform, magic_transit
version string: Version of the ruleset.
description string: Brief summary of the ruleset and its intended use.
rules GetRulesetsRulesetRule[]: List of rules to apply to the ruleset.

id str: ID of the ruleset.
kind str: Type of Ruleset. Available values: custom, managed, root, zone
name str: Name of the ruleset.
phase str: Point in the request/response lifecycle where the ruleset executes. Available values: ddos_l4, ddos_l7, http_config_settings, http_custom_errors, http_log_custom_fields, http_ratelimit, http_request_cache_settings, http_request_dynamic_redirect, http_request_firewall_custom, http_request_firewall_managed, http_request_late_transform, http_request_origin, http_request_redirect, http_request_sanitize, http_request_sbfm, http_request_transform, http_response_compression, http_response_firewall_managed, http_response_headers_transform, magic_transit
version str: Version of the ruleset.
description str: Brief summary of the ruleset and its intended use.
rules Sequence[GetRulesetsRulesetRule]: List of rules to apply to the ruleset.

id String: ID of the ruleset.
kind String: Type of Ruleset. Available values: custom, managed, root, zone
name String: Name of the ruleset.
phase String: Point in the request/response lifecycle where the ruleset executes. Available values: ddos_l4, ddos_l7, http_config_settings, http_custom_errors, http_log_custom_fields, http_ratelimit, http_request_cache_settings, http_request_dynamic_redirect, http_request_firewall_custom, http_request_firewall_managed, http_request_late_transform, http_request_origin, http_request_redirect, http_request_sanitize, http_request_sbfm, http_request_transform, http_response_compression, http_response_firewall_managed, http_response_headers_transform, magic_transit
version String: Version of the ruleset.
description String: Brief summary of the ruleset and its intended use.
rules List<Property Map>: List of rules to apply to the ruleset.

GetRulesetsRulesetRule

Expression string: Criteria for an HTTP request to trigger the ruleset rule action. Uses the Firewall Rules expression language based on Wireshark display filters. Refer to the Firewall Rules language documentation for all available fields, operators, and functions
Id string: The ID of the Ruleset to target.
Ref string: Rule reference.
Version string: Version of the ruleset to filter on.
Action string: Action to perform in the ruleset rule. Available values: block, challenge, compress_response, ddos_dynamic, ddos_mitigation, execute, force_connection_close, js_challenge, log, log_custom_field, managed_challenge, redirect, rewrite, route, score, serve_error, set_cache_settings, set_config, skip
ActionParameters GetRulesetsRulesetRuleActionParameters: List of parameters that configure the behavior of the ruleset rule action.
Description string: Brief summary of the ruleset rule and its intended use.
Enabled bool: Whether the rule is active.
ExposedCredentialCheck GetRulesetsRulesetRuleExposedCredentialCheck: List of parameters that configure exposed credential checks.
LastUpdated string: The most recent update to this rule.
Logging GetRulesetsRulesetRuleLogging: List parameters to configure how the rule generates logs.
Ratelimit GetRulesetsRulesetRuleRatelimit: List of parameters that configure HTTP rate limiting behaviour.

Expression string: Criteria for an HTTP request to trigger the ruleset rule action. Uses the Firewall Rules expression language based on Wireshark display filters. Refer to the Firewall Rules language documentation for all available fields, operators, and functions
Id string: The ID of the Ruleset to target.
Ref string: Rule reference.
Version string: Version of the ruleset to filter on.
Action string: Action to perform in the ruleset rule. Available values: block, challenge, compress_response, ddos_dynamic, ddos_mitigation, execute, force_connection_close, js_challenge, log, log_custom_field, managed_challenge, redirect, rewrite, route, score, serve_error, set_cache_settings, set_config, skip
ActionParameters GetRulesetsRulesetRuleActionParameters: List of parameters that configure the behavior of the ruleset rule action.
Description string: Brief summary of the ruleset rule and its intended use.
Enabled bool: Whether the rule is active.
ExposedCredentialCheck GetRulesetsRulesetRuleExposedCredentialCheck: List of parameters that configure exposed credential checks.
LastUpdated string: The most recent update to this rule.
Logging GetRulesetsRulesetRuleLogging: List parameters to configure how the rule generates logs.
Ratelimit GetRulesetsRulesetRuleRatelimit: List of parameters that configure HTTP rate limiting behaviour.

expression String: Criteria for an HTTP request to trigger the ruleset rule action. Uses the Firewall Rules expression language based on Wireshark display filters. Refer to the Firewall Rules language documentation for all available fields, operators, and functions
id String: The ID of the Ruleset to target.
ref String: Rule reference.
version String: Version of the ruleset to filter on.
action String: Action to perform in the ruleset rule. Available values: block, challenge, compress_response, ddos_dynamic, ddos_mitigation, execute, force_connection_close, js_challenge, log, log_custom_field, managed_challenge, redirect, rewrite, route, score, serve_error, set_cache_settings, set_config, skip
actionParameters GetRulesetsRulesetRuleActionParameters: List of parameters that configure the behavior of the ruleset rule action.
description String: Brief summary of the ruleset rule and its intended use.
enabled Boolean: Whether the rule is active.
exposedCredentialCheck GetRulesetsRulesetRuleExposedCredentialCheck: List of parameters that configure exposed credential checks.
lastUpdated String: The most recent update to this rule.
logging GetRulesetsRulesetRuleLogging: List parameters to configure how the rule generates logs.
ratelimit GetRulesetsRulesetRuleRatelimit: List of parameters that configure HTTP rate limiting behaviour.

expression string: Criteria for an HTTP request to trigger the ruleset rule action. Uses the Firewall Rules expression language based on Wireshark display filters. Refer to the Firewall Rules language documentation for all available fields, operators, and functions
id string: The ID of the Ruleset to target.
ref string: Rule reference.
version string: Version of the ruleset to filter on.
action string: Action to perform in the ruleset rule. Available values: block, challenge, compress_response, ddos_dynamic, ddos_mitigation, execute, force_connection_close, js_challenge, log, log_custom_field, managed_challenge, redirect, rewrite, route, score, serve_error, set_cache_settings, set_config, skip
actionParameters GetRulesetsRulesetRuleActionParameters: List of parameters that configure the behavior of the ruleset rule action.
description string: Brief summary of the ruleset rule and its intended use.
enabled boolean: Whether the rule is active.
exposedCredentialCheck GetRulesetsRulesetRuleExposedCredentialCheck: List of parameters that configure exposed credential checks.
lastUpdated string: The most recent update to this rule.
logging GetRulesetsRulesetRuleLogging: List parameters to configure how the rule generates logs.
ratelimit GetRulesetsRulesetRuleRatelimit: List of parameters that configure HTTP rate limiting behaviour.

expression str: Criteria for an HTTP request to trigger the ruleset rule action. Uses the Firewall Rules expression language based on Wireshark display filters. Refer to the Firewall Rules language documentation for all available fields, operators, and functions
id str: The ID of the Ruleset to target.
ref str: Rule reference.
version str: Version of the ruleset to filter on.
action str: Action to perform in the ruleset rule. Available values: block, challenge, compress_response, ddos_dynamic, ddos_mitigation, execute, force_connection_close, js_challenge, log, log_custom_field, managed_challenge, redirect, rewrite, route, score, serve_error, set_cache_settings, set_config, skip
action_parameters GetRulesetsRulesetRuleActionParameters: List of parameters that configure the behavior of the ruleset rule action.
description str: Brief summary of the ruleset rule and its intended use.
enabled bool: Whether the rule is active.
exposed_credential_check GetRulesetsRulesetRuleExposedCredentialCheck: List of parameters that configure exposed credential checks.
last_updated str: The most recent update to this rule.
logging GetRulesetsRulesetRuleLogging: List parameters to configure how the rule generates logs.
ratelimit GetRulesetsRulesetRuleRatelimit: List of parameters that configure HTTP rate limiting behaviour.

expression String: Criteria for an HTTP request to trigger the ruleset rule action. Uses the Firewall Rules expression language based on Wireshark display filters. Refer to the Firewall Rules language documentation for all available fields, operators, and functions
id String: The ID of the Ruleset to target.
ref String: Rule reference.
version String: Version of the ruleset to filter on.
action String: Action to perform in the ruleset rule. Available values: block, challenge, compress_response, ddos_dynamic, ddos_mitigation, execute, force_connection_close, js_challenge, log, log_custom_field, managed_challenge, redirect, rewrite, route, score, serve_error, set_cache_settings, set_config, skip
actionParameters Property Map: List of parameters that configure the behavior of the ruleset rule action.
description String: Brief summary of the ruleset rule and its intended use.
enabled Boolean: Whether the rule is active.
exposedCredentialCheck Property Map: List of parameters that configure exposed credential checks.
lastUpdated String: The most recent update to this rule.
logging Property Map: List parameters to configure how the rule generates logs.
ratelimit Property Map: List of parameters that configure HTTP rate limiting behaviour.

GetRulesetsRulesetRuleActionParameters

Version string: Version of the ruleset to filter on.
AdditionalCacheablePorts List<int>: Allows for the ability to support caching on non-standard ports.
AutomaticHttpsRewrites bool: Turn on or off Cloudflare Automatic HTTPS rewrites.
Autominifies List<GetRulesetsRulesetRuleActionParametersAutominify>: Indicate which file extensions to minify automatically.
Bic bool: Inspect the visitor's browser for headers commonly associated with spammers and certain bots.
BrowserTtl GetRulesetsRulesetRuleActionParametersBrowserTtl: List of browser TTL parameters to apply to the request.
Cache bool: Whether to cache if expression matches.
CacheKey GetRulesetsRulesetRuleActionParametersCacheKey: List of cache key parameters to apply to the request.
Content string: Content of the custom error response
ContentType string: Content-Type of the custom error response
CookieFields List<string>: List of cookie values to include as part of custom fields logging.
DisableApps bool: Turn off all active Cloudflare Apps.
DisableRailgun bool: Turn off railgun feature of the Cloudflare Speed app.
DisableZaraz bool: Turn off zaraz feature.
EdgeTtl GetRulesetsRulesetRuleActionParametersEdgeTtl: List of edge TTL parameters to apply to the request.
EmailObfuscation bool: Turn on or off the Cloudflare Email Obfuscation feature of the Cloudflare Scrape Shield app.
FromList GetRulesetsRulesetRuleActionParametersFromList: Use a list to lookup information for the action.
FromValue GetRulesetsRulesetRuleActionParametersFromValue: Use a value to lookup information for the action.
Headers List<GetRulesetsRulesetRuleActionParametersHeader>: List of HTTP header modifications to perform in the ruleset rule.
HostHeader string: Host Header that request origin receives.
HotlinkProtection bool: Turn on or off the hotlink protection feature.
Id string: The ID of the Ruleset to target.
Increment int
MatchedData GetRulesetsRulesetRuleActionParametersMatchedData: List of properties to configure WAF payload logging.
Mirage bool: Turn on or off Cloudflare Mirage of the Cloudflare Speed app.
OpportunisticEncryption bool: Turn on or off the Cloudflare Opportunistic Encryption feature of the Edge Certificates tab in the Cloudflare SSL/TLS app.
Origin GetRulesetsRulesetRuleActionParametersOrigin: List of properties to change request origin.
OriginCacheControl bool: Sets a more compliant mode for parsing Cache Control headers
OriginErrorPagePassthru bool: Pass-through error page for origin.
Overrides GetRulesetsRulesetRuleActionParametersOverrides: List of override configurations to apply to the ruleset.
Phases List<string>: Point in the request/response lifecycle where the ruleset will be created. Available values: ddos_l4, ddos_l7, http_config_settings, http_custom_errors, http_log_custom_fields, http_ratelimit, http_request_cache_settings, http_request_dynamic_redirect, http_request_firewall_custom, http_request_firewall_managed, http_request_late_transform, http_request_origin, http_request_redirect, http_request_sanitize, http_request_sbfm, http_request_transform, http_response_compression, http_response_firewall_managed, http_response_headers_transform, magic_transit
Polish string: Apply options from the Polish feature of the Cloudflare Speed app.
Products List<string>: Products to target with the actions. Available values: bic, hot, ratelimit, securityLevel, uablock, waf, zonelockdown
ReadTimeout int: Sets the timeout value for reading content from an origin server.
RequestFields List<string>: List of request headers to include as part of custom fields logging, in lowercase.
RespectStrongEtags bool: Respect strong ETags.
ResponseFields List<string>: List of response headers to include as part of custom fields logging, in lowercase.
Responses List<GetRulesetsRulesetRuleActionParametersResponse>: List of parameters that configure the response given to end users
RocketLoader bool: Turn on or off Cloudflare Rocket Loader in the Cloudflare Speed app.
Rules Dictionary<string, string>: Map of managed WAF rule ID to comma-delimited string of ruleset rule IDs. Example: rules = { "efb7b8c949ac4650a09736fc376e9aee" = "5de7edfa648c4d6891dc3e7f84534ffa,e3a567afc347477d9702d9047e97d760" }
Ruleset string: Which ruleset ID to target.
Rulesets List<string>: List of managed WAF rule IDs to target. Only valid when the "action" is set to skip
SecurityLevel string: Control options for the Security Level feature from the Security app.
ServeStale GetRulesetsRulesetRuleActionParametersServeStale: List of serve stale parameters to apply to the request.
ServerSideExcludes bool: Turn on or off the Server Side Excludes feature of the Cloudflare Scrape Shield app.
Sni GetRulesetsRulesetRuleActionParametersSni: List of properties to manange Server Name Indication.
Ssl string: Control options for the SSL feature of the Edge Certificates tab in the Cloudflare SSL/TLS app.
StatusCode int: HTTP status code of the custom error response
Sxg bool: Turn on or off the SXG feature.
Uri GetRulesetsRulesetRuleActionParametersUri: List of URI properties to configure for the ruleset rule when performing URL rewrite transformations.

Version string: Version of the ruleset to filter on.
AdditionalCacheablePorts []int: Allows for the ability to support caching on non-standard ports.
AutomaticHttpsRewrites bool: Turn on or off Cloudflare Automatic HTTPS rewrites.
Autominifies []GetRulesetsRulesetRuleActionParametersAutominify: Indicate which file extensions to minify automatically.
Bic bool: Inspect the visitor's browser for headers commonly associated with spammers and certain bots.
BrowserTtl GetRulesetsRulesetRuleActionParametersBrowserTtl: List of browser TTL parameters to apply to the request.
Cache bool: Whether to cache if expression matches.
CacheKey GetRulesetsRulesetRuleActionParametersCacheKey: List of cache key parameters to apply to the request.
Content string: Content of the custom error response
ContentType string: Content-Type of the custom error response
CookieFields []string: List of cookie values to include as part of custom fields logging.
DisableApps bool: Turn off all active Cloudflare Apps.
DisableRailgun bool: Turn off railgun feature of the Cloudflare Speed app.
DisableZaraz bool: Turn off zaraz feature.
EdgeTtl GetRulesetsRulesetRuleActionParametersEdgeTtl: List of edge TTL parameters to apply to the request.
EmailObfuscation bool: Turn on or off the Cloudflare Email Obfuscation feature of the Cloudflare Scrape Shield app.
FromList GetRulesetsRulesetRuleActionParametersFromList: Use a list to lookup information for the action.
FromValue GetRulesetsRulesetRuleActionParametersFromValue: Use a value to lookup information for the action.
Headers []GetRulesetsRulesetRuleActionParametersHeader: List of HTTP header modifications to perform in the ruleset rule.
HostHeader string: Host Header that request origin receives.
HotlinkProtection bool: Turn on or off the hotlink protection feature.
Id string: The ID of the Ruleset to target.
Increment int
MatchedData GetRulesetsRulesetRuleActionParametersMatchedData: List of properties to configure WAF payload logging.
Mirage bool: Turn on or off Cloudflare Mirage of the Cloudflare Speed app.
OpportunisticEncryption bool: Turn on or off the Cloudflare Opportunistic Encryption feature of the Edge Certificates tab in the Cloudflare SSL/TLS app.
Origin GetRulesetsRulesetRuleActionParametersOrigin: List of properties to change request origin.
OriginCacheControl bool: Sets a more compliant mode for parsing Cache Control headers
OriginErrorPagePassthru bool: Pass-through error page for origin.
Overrides GetRulesetsRulesetRuleActionParametersOverrides: List of override configurations to apply to the ruleset.
Phases []string: Point in the request/response lifecycle where the ruleset will be created. Available values: ddos_l4, ddos_l7, http_config_settings, http_custom_errors, http_log_custom_fields, http_ratelimit, http_request_cache_settings, http_request_dynamic_redirect, http_request_firewall_custom, http_request_firewall_managed, http_request_late_transform, http_request_origin, http_request_redirect, http_request_sanitize, http_request_sbfm, http_request_transform, http_response_compression, http_response_firewall_managed, http_response_headers_transform, magic_transit
Polish string: Apply options from the Polish feature of the Cloudflare Speed app.
Products []string: Products to target with the actions. Available values: bic, hot, ratelimit, securityLevel, uablock, waf, zonelockdown
ReadTimeout int: Sets the timeout value for reading content from an origin server.
RequestFields []string: List of request headers to include as part of custom fields logging, in lowercase.
RespectStrongEtags bool: Respect strong ETags.
ResponseFields []string: List of response headers to include as part of custom fields logging, in lowercase.
Responses []GetRulesetsRulesetRuleActionParametersResponse: List of parameters that configure the response given to end users
RocketLoader bool: Turn on or off Cloudflare Rocket Loader in the Cloudflare Speed app.
Rules map[string]string: Map of managed WAF rule ID to comma-delimited string of ruleset rule IDs. Example: rules = { "efb7b8c949ac4650a09736fc376e9aee" = "5de7edfa648c4d6891dc3e7f84534ffa,e3a567afc347477d9702d9047e97d760" }
Ruleset string: Which ruleset ID to target.
Rulesets []string: List of managed WAF rule IDs to target. Only valid when the "action" is set to skip
SecurityLevel string: Control options for the Security Level feature from the Security app.
ServeStale GetRulesetsRulesetRuleActionParametersServeStale: List of serve stale parameters to apply to the request.
ServerSideExcludes bool: Turn on or off the Server Side Excludes feature of the Cloudflare Scrape Shield app.
Sni GetRulesetsRulesetRuleActionParametersSni: List of properties to manange Server Name Indication.
Ssl string: Control options for the SSL feature of the Edge Certificates tab in the Cloudflare SSL/TLS app.
StatusCode int: HTTP status code of the custom error response
Sxg bool: Turn on or off the SXG feature.
Uri GetRulesetsRulesetRuleActionParametersUri: List of URI properties to configure for the ruleset rule when performing URL rewrite transformations.

version String: Version of the ruleset to filter on.
additionalCacheablePorts List<Integer>: Allows for the ability to support caching on non-standard ports.
automaticHttpsRewrites Boolean: Turn on or off Cloudflare Automatic HTTPS rewrites.
autominifies List<GetRulesetsRulesetRuleActionParametersAutominify>: Indicate which file extensions to minify automatically.
bic Boolean: Inspect the visitor's browser for headers commonly associated with spammers and certain bots.
browserTtl GetRulesetsRulesetRuleActionParametersBrowserTtl: List of browser TTL parameters to apply to the request.
cache Boolean: Whether to cache if expression matches.
cacheKey GetRulesetsRulesetRuleActionParametersCacheKey: List of cache key parameters to apply to the request.
content String: Content of the custom error response
contentType String: Content-Type of the custom error response
cookieFields List<String>: List of cookie values to include as part of custom fields logging.
disableApps Boolean: Turn off all active Cloudflare Apps.
disableRailgun Boolean: Turn off railgun feature of the Cloudflare Speed app.
disableZaraz Boolean: Turn off zaraz feature.
edgeTtl GetRulesetsRulesetRuleActionParametersEdgeTtl: List of edge TTL parameters to apply to the request.
emailObfuscation Boolean: Turn on or off the Cloudflare Email Obfuscation feature of the Cloudflare Scrape Shield app.
fromList GetRulesetsRulesetRuleActionParametersFromList: Use a list to lookup information for the action.
fromValue GetRulesetsRulesetRuleActionParametersFromValue: Use a value to lookup information for the action.
headers List<GetRulesetsRulesetRuleActionParametersHeader>: List of HTTP header modifications to perform in the ruleset rule.
hostHeader String: Host Header that request origin receives.
hotlinkProtection Boolean: Turn on or off the hotlink protection feature.
id String: The ID of the Ruleset to target.
increment Integer
matchedData GetRulesetsRulesetRuleActionParametersMatchedData: List of properties to configure WAF payload logging.
mirage Boolean: Turn on or off Cloudflare Mirage of the Cloudflare Speed app.
opportunisticEncryption Boolean: Turn on or off the Cloudflare Opportunistic Encryption feature of the Edge Certificates tab in the Cloudflare SSL/TLS app.
origin GetRulesetsRulesetRuleActionParametersOrigin: List of properties to change request origin.
originCacheControl Boolean: Sets a more compliant mode for parsing Cache Control headers
originErrorPagePassthru Boolean: Pass-through error page for origin.
overrides GetRulesetsRulesetRuleActionParametersOverrides: List of override configurations to apply to the ruleset.
phases List<String>: Point in the request/response lifecycle where the ruleset will be created. Available values: ddos_l4, ddos_l7, http_config_settings, http_custom_errors, http_log_custom_fields, http_ratelimit, http_request_cache_settings, http_request_dynamic_redirect, http_request_firewall_custom, http_request_firewall_managed, http_request_late_transform, http_request_origin, http_request_redirect, http_request_sanitize, http_request_sbfm, http_request_transform, http_response_compression, http_response_firewall_managed, http_response_headers_transform, magic_transit
polish String: Apply options from the Polish feature of the Cloudflare Speed app.
products List<String>: Products to target with the actions. Available values: bic, hot, ratelimit, securityLevel, uablock, waf, zonelockdown
readTimeout Integer: Sets the timeout value for reading content from an origin server.
requestFields List<String>: List of request headers to include as part of custom fields logging, in lowercase.
respectStrongEtags Boolean: Respect strong ETags.
responseFields List<String>: List of response headers to include as part of custom fields logging, in lowercase.
responses List<GetRulesetsRulesetRuleActionParametersResponse>: List of parameters that configure the response given to end users
rocketLoader Boolean: Turn on or off Cloudflare Rocket Loader in the Cloudflare Speed app.
rules Map<String,String>: Map of managed WAF rule ID to comma-delimited string of ruleset rule IDs. Example: rules = { "efb7b8c949ac4650a09736fc376e9aee" = "5de7edfa648c4d6891dc3e7f84534ffa,e3a567afc347477d9702d9047e97d760" }
ruleset String: Which ruleset ID to target.
rulesets List<String>: List of managed WAF rule IDs to target. Only valid when the "action" is set to skip
securityLevel String: Control options for the Security Level feature from the Security app.
serveStale GetRulesetsRulesetRuleActionParametersServeStale: List of serve stale parameters to apply to the request.
serverSideExcludes Boolean: Turn on or off the Server Side Excludes feature of the Cloudflare Scrape Shield app.
sni GetRulesetsRulesetRuleActionParametersSni: List of properties to manange Server Name Indication.
ssl String: Control options for the SSL feature of the Edge Certificates tab in the Cloudflare SSL/TLS app.
statusCode Integer: HTTP status code of the custom error response
sxg Boolean: Turn on or off the SXG feature.
uri GetRulesetsRulesetRuleActionParametersUri: List of URI properties to configure for the ruleset rule when performing URL rewrite transformations.

version string: Version of the ruleset to filter on.
additionalCacheablePorts number[]: Allows for the ability to support caching on non-standard ports.
automaticHttpsRewrites boolean: Turn on or off Cloudflare Automatic HTTPS rewrites.
autominifies GetRulesetsRulesetRuleActionParametersAutominify[]: Indicate which file extensions to minify automatically.
bic boolean: Inspect the visitor's browser for headers commonly associated with spammers and certain bots.
browserTtl GetRulesetsRulesetRuleActionParametersBrowserTtl: List of browser TTL parameters to apply to the request.
cache boolean: Whether to cache if expression matches.
cacheKey GetRulesetsRulesetRuleActionParametersCacheKey: List of cache key parameters to apply to the request.
content string: Content of the custom error response
contentType string: Content-Type of the custom error response
cookieFields string[]: List of cookie values to include as part of custom fields logging.
disableApps boolean: Turn off all active Cloudflare Apps.
disableRailgun boolean: Turn off railgun feature of the Cloudflare Speed app.
disableZaraz boolean: Turn off zaraz feature.
edgeTtl GetRulesetsRulesetRuleActionParametersEdgeTtl: List of edge TTL parameters to apply to the request.
emailObfuscation boolean: Turn on or off the Cloudflare Email Obfuscation feature of the Cloudflare Scrape Shield app.
fromList GetRulesetsRulesetRuleActionParametersFromList: Use a list to lookup information for the action.
fromValue GetRulesetsRulesetRuleActionParametersFromValue: Use a value to lookup information for the action.
headers GetRulesetsRulesetRuleActionParametersHeader[]: List of HTTP header modifications to perform in the ruleset rule.
hostHeader string: Host Header that request origin receives.
hotlinkProtection boolean: Turn on or off the hotlink protection feature.
id string: The ID of the Ruleset to target.
increment number
matchedData GetRulesetsRulesetRuleActionParametersMatchedData: List of properties to configure WAF payload logging.
mirage boolean: Turn on or off Cloudflare Mirage of the Cloudflare Speed app.
opportunisticEncryption boolean: Turn on or off the Cloudflare Opportunistic Encryption feature of the Edge Certificates tab in the Cloudflare SSL/TLS app.
origin GetRulesetsRulesetRuleActionParametersOrigin: List of properties to change request origin.
originCacheControl boolean: Sets a more compliant mode for parsing Cache Control headers
originErrorPagePassthru boolean: Pass-through error page for origin.
overrides GetRulesetsRulesetRuleActionParametersOverrides: List of override configurations to apply to the ruleset.
phases string[]: Point in the request/response lifecycle where the ruleset will be created. Available values: ddos_l4, ddos_l7, http_config_settings, http_custom_errors, http_log_custom_fields, http_ratelimit, http_request_cache_settings, http_request_dynamic_redirect, http_request_firewall_custom, http_request_firewall_managed, http_request_late_transform, http_request_origin, http_request_redirect, http_request_sanitize, http_request_sbfm, http_request_transform, http_response_compression, http_response_firewall_managed, http_response_headers_transform, magic_transit
polish string: Apply options from the Polish feature of the Cloudflare Speed app.
products string[]: Products to target with the actions. Available values: bic, hot, ratelimit, securityLevel, uablock, waf, zonelockdown
readTimeout number: Sets the timeout value for reading content from an origin server.
requestFields string[]: List of request headers to include as part of custom fields logging, in lowercase.
respectStrongEtags boolean: Respect strong ETags.
responseFields string[]: List of response headers to include as part of custom fields logging, in lowercase.
responses GetRulesetsRulesetRuleActionParametersResponse[]: List of parameters that configure the response given to end users
rocketLoader boolean: Turn on or off Cloudflare Rocket Loader in the Cloudflare Speed app.
rules {[key: string]: string}: Map of managed WAF rule ID to comma-delimited string of ruleset rule IDs. Example: rules = { "efb7b8c949ac4650a09736fc376e9aee" = "5de7edfa648c4d6891dc3e7f84534ffa,e3a567afc347477d9702d9047e97d760" }
ruleset string: Which ruleset ID to target.
rulesets string[]: List of managed WAF rule IDs to target. Only valid when the "action" is set to skip
securityLevel string: Control options for the Security Level feature from the Security app.
serveStale GetRulesetsRulesetRuleActionParametersServeStale: List of serve stale parameters to apply to the request.
serverSideExcludes boolean: Turn on or off the Server Side Excludes feature of the Cloudflare Scrape Shield app.
sni GetRulesetsRulesetRuleActionParametersSni: List of properties to manange Server Name Indication.
ssl string: Control options for the SSL feature of the Edge Certificates tab in the Cloudflare SSL/TLS app.
statusCode number: HTTP status code of the custom error response
sxg boolean: Turn on or off the SXG feature.
uri GetRulesetsRulesetRuleActionParametersUri: List of URI properties to configure for the ruleset rule when performing URL rewrite transformations.

version str: Version of the ruleset to filter on.
additional_cacheable_ports Sequence[int]: Allows for the ability to support caching on non-standard ports.
automatic_https_rewrites bool: Turn on or off Cloudflare Automatic HTTPS rewrites.
autominifies Sequence[GetRulesetsRulesetRuleActionParametersAutominify]: Indicate which file extensions to minify automatically.
bic bool: Inspect the visitor's browser for headers commonly associated with spammers and certain bots.
browser_ttl GetRulesetsRulesetRuleActionParametersBrowserTtl: List of browser TTL parameters to apply to the request.
cache bool: Whether to cache if expression matches.
cache_key GetRulesetsRulesetRuleActionParametersCacheKey: List of cache key parameters to apply to the request.
content str: Content of the custom error response
content_type str: Content-Type of the custom error response
cookie_fields Sequence[str]: List of cookie values to include as part of custom fields logging.
disable_apps bool: Turn off all active Cloudflare Apps.
disable_railgun bool: Turn off railgun feature of the Cloudflare Speed app.
disable_zaraz bool: Turn off zaraz feature.
edge_ttl GetRulesetsRulesetRuleActionParametersEdgeTtl: List of edge TTL parameters to apply to the request.
email_obfuscation bool: Turn on or off the Cloudflare Email Obfuscation feature of the Cloudflare Scrape Shield app.
from_list GetRulesetsRulesetRuleActionParametersFromList: Use a list to lookup information for the action.
from_value GetRulesetsRulesetRuleActionParametersFromValue: Use a value to lookup information for the action.
headers Sequence[GetRulesetsRulesetRuleActionParametersHeader]: List of HTTP header modifications to perform in the ruleset rule.
host_header str: Host Header that request origin receives.
hotlink_protection bool: Turn on or off the hotlink protection feature.
id str: The ID of the Ruleset to target.
increment int
matched_data GetRulesetsRulesetRuleActionParametersMatchedData: List of properties to configure WAF payload logging.
mirage bool: Turn on or off Cloudflare Mirage of the Cloudflare Speed app.
opportunistic_encryption bool: Turn on or off the Cloudflare Opportunistic Encryption feature of the Edge Certificates tab in the Cloudflare SSL/TLS app.
origin GetRulesetsRulesetRuleActionParametersOrigin: List of properties to change request origin.
origin_cache_control bool: Sets a more compliant mode for parsing Cache Control headers
origin_error_page_passthru bool: Pass-through error page for origin.
overrides GetRulesetsRulesetRuleActionParametersOverrides: List of override configurations to apply to the ruleset.
phases Sequence[str]: Point in the request/response lifecycle where the ruleset will be created. Available values: ddos_l4, ddos_l7, http_config_settings, http_custom_errors, http_log_custom_fields, http_ratelimit, http_request_cache_settings, http_request_dynamic_redirect, http_request_firewall_custom, http_request_firewall_managed, http_request_late_transform, http_request_origin, http_request_redirect, http_request_sanitize, http_request_sbfm, http_request_transform, http_response_compression, http_response_firewall_managed, http_response_headers_transform, magic_transit
polish str: Apply options from the Polish feature of the Cloudflare Speed app.
products Sequence[str]: Products to target with the actions. Available values: bic, hot, ratelimit, securityLevel, uablock, waf, zonelockdown
read_timeout int: Sets the timeout value for reading content from an origin server.
request_fields Sequence[str]: List of request headers to include as part of custom fields logging, in lowercase.
respect_strong_etags bool: Respect strong ETags.
response_fields Sequence[str]: List of response headers to include as part of custom fields logging, in lowercase.
responses Sequence[GetRulesetsRulesetRuleActionParametersResponse]: List of parameters that configure the response given to end users
rocket_loader bool: Turn on or off Cloudflare Rocket Loader in the Cloudflare Speed app.
rules Mapping[str, str]: Map of managed WAF rule ID to comma-delimited string of ruleset rule IDs. Example: rules = { "efb7b8c949ac4650a09736fc376e9aee" = "5de7edfa648c4d6891dc3e7f84534ffa,e3a567afc347477d9702d9047e97d760" }
ruleset str: Which ruleset ID to target.
rulesets Sequence[str]: List of managed WAF rule IDs to target. Only valid when the "action" is set to skip
security_level str: Control options for the Security Level feature from the Security app.
serve_stale GetRulesetsRulesetRuleActionParametersServeStale: List of serve stale parameters to apply to the request.
server_side_excludes bool: Turn on or off the Server Side Excludes feature of the Cloudflare Scrape Shield app.
sni GetRulesetsRulesetRuleActionParametersSni: List of properties to manange Server Name Indication.
ssl str: Control options for the SSL feature of the Edge Certificates tab in the Cloudflare SSL/TLS app.
status_code int: HTTP status code of the custom error response
sxg bool: Turn on or off the SXG feature.
uri GetRulesetsRulesetRuleActionParametersUri: List of URI properties to configure for the ruleset rule when performing URL rewrite transformations.

version String: Version of the ruleset to filter on.
additionalCacheablePorts List<Number>: Allows for the ability to support caching on non-standard ports.
automaticHttpsRewrites Boolean: Turn on or off Cloudflare Automatic HTTPS rewrites.
autominifies List<Property Map>: Indicate which file extensions to minify automatically.
bic Boolean: Inspect the visitor's browser for headers commonly associated with spammers and certain bots.
browserTtl Property Map: List of browser TTL parameters to apply to the request.
cache Boolean: Whether to cache if expression matches.
cacheKey Property Map: List of cache key parameters to apply to the request.
content String: Content of the custom error response
contentType String: Content-Type of the custom error response
cookieFields List<String>: List of cookie values to include as part of custom fields logging.
disableApps Boolean: Turn off all active Cloudflare Apps.
disableRailgun Boolean: Turn off railgun feature of the Cloudflare Speed app.
disableZaraz Boolean: Turn off zaraz feature.
edgeTtl Property Map: List of edge TTL parameters to apply to the request.
emailObfuscation Boolean: Turn on or off the Cloudflare Email Obfuscation feature of the Cloudflare Scrape Shield app.
fromList Property Map: Use a list to lookup information for the action.
fromValue Property Map: Use a value to lookup information for the action.
headers List<Property Map>: List of HTTP header modifications to perform in the ruleset rule.
hostHeader String: Host Header that request origin receives.
hotlinkProtection Boolean: Turn on or off the hotlink protection feature.
id String: The ID of the Ruleset to target.
increment Number
matchedData Property Map: List of properties to configure WAF payload logging.
mirage Boolean: Turn on or off Cloudflare Mirage of the Cloudflare Speed app.
opportunisticEncryption Boolean: Turn on or off the Cloudflare Opportunistic Encryption feature of the Edge Certificates tab in the Cloudflare SSL/TLS app.
origin Property Map: List of properties to change request origin.
originCacheControl Boolean: Sets a more compliant mode for parsing Cache Control headers
originErrorPagePassthru Boolean: Pass-through error page for origin.
overrides Property Map: List of override configurations to apply to the ruleset.
phases List<String>: Point in the request/response lifecycle where the ruleset will be created. Available values: ddos_l4, ddos_l7, http_config_settings, http_custom_errors, http_log_custom_fields, http_ratelimit, http_request_cache_settings, http_request_dynamic_redirect, http_request_firewall_custom, http_request_firewall_managed, http_request_late_transform, http_request_origin, http_request_redirect, http_request_sanitize, http_request_sbfm, http_request_transform, http_response_compression, http_response_firewall_managed, http_response_headers_transform, magic_transit
polish String: Apply options from the Polish feature of the Cloudflare Speed app.
products List<String>: Products to target with the actions. Available values: bic, hot, ratelimit, securityLevel, uablock, waf, zonelockdown
readTimeout Number: Sets the timeout value for reading content from an origin server.
requestFields List<String>: List of request headers to include as part of custom fields logging, in lowercase.
respectStrongEtags Boolean: Respect strong ETags.
responseFields List<String>: List of response headers to include as part of custom fields logging, in lowercase.
responses List<Property Map>: List of parameters that configure the response given to end users
rocketLoader Boolean: Turn on or off Cloudflare Rocket Loader in the Cloudflare Speed app.
rules Map<String>: Map of managed WAF rule ID to comma-delimited string of ruleset rule IDs. Example: rules = { "efb7b8c949ac4650a09736fc376e9aee" = "5de7edfa648c4d6891dc3e7f84534ffa,e3a567afc347477d9702d9047e97d760" }
ruleset String: Which ruleset ID to target.
rulesets List<String>: List of managed WAF rule IDs to target. Only valid when the "action" is set to skip
securityLevel String: Control options for the Security Level feature from the Security app.
serveStale Property Map: List of serve stale parameters to apply to the request.
serverSideExcludes Boolean: Turn on or off the Server Side Excludes feature of the Cloudflare Scrape Shield app.
sni Property Map: List of properties to manange Server Name Indication.
ssl String: Control options for the SSL feature of the Edge Certificates tab in the Cloudflare SSL/TLS app.
statusCode Number: HTTP status code of the custom error response
sxg Boolean: Turn on or off the SXG feature.
uri Property Map: List of URI properties to configure for the ruleset rule when performing URL rewrite transformations.

GetRulesetsRulesetRuleActionParametersAutominify

Css bool: SSL minification.
Html bool: HTML minification.
Js bool: JS minification.

Css bool: SSL minification.
Html bool: HTML minification.
Js bool: JS minification.

css Boolean: SSL minification.
html Boolean: HTML minification.
js Boolean: JS minification.

css boolean: SSL minification.
html boolean: HTML minification.
js boolean: JS minification.

css bool: SSL minification.
html bool: HTML minification.
js bool: JS minification.

css Boolean: SSL minification.
html Boolean: HTML minification.
js Boolean: JS minification.

GetRulesetsRulesetRuleActionParametersBrowserTtl

Mode string: Mode of the browser TTL.
Default int: Default browser TTL.

Mode string: Mode of the browser TTL.
Default int: Default browser TTL.

mode String: Mode of the browser TTL.
default_ Integer: Default browser TTL.

mode string: Mode of the browser TTL.
default number: Default browser TTL.

mode str: Mode of the browser TTL.
default int: Default browser TTL.

mode String: Mode of the browser TTL.
default Number: Default browser TTL.

GetRulesetsRulesetRuleActionParametersCacheKey

CacheByDeviceType bool: Cache by device type. Conflicts with "custom_key.user.device_type".
CacheDeceptionArmor bool: Cache deception armor.
CustomKey GetRulesetsRulesetRuleActionParametersCacheKeyCustomKey: Custom key parameters for the request.
IgnoreQueryStringsOrder bool: Ignore query strings order.

CacheByDeviceType bool: Cache by device type. Conflicts with "custom_key.user.device_type".
CacheDeceptionArmor bool: Cache deception armor.
CustomKey GetRulesetsRulesetRuleActionParametersCacheKeyCustomKey: Custom key parameters for the request.
IgnoreQueryStringsOrder bool: Ignore query strings order.

cacheByDeviceType Boolean: Cache by device type. Conflicts with "custom_key.user.device_type".
cacheDeceptionArmor Boolean: Cache deception armor.
customKey GetRulesetsRulesetRuleActionParametersCacheKeyCustomKey: Custom key parameters for the request.
ignoreQueryStringsOrder Boolean: Ignore query strings order.

cacheByDeviceType boolean: Cache by device type. Conflicts with "custom_key.user.device_type".
cacheDeceptionArmor boolean: Cache deception armor.
customKey GetRulesetsRulesetRuleActionParametersCacheKeyCustomKey: Custom key parameters for the request.
ignoreQueryStringsOrder boolean: Ignore query strings order.

cache_by_device_type bool: Cache by device type. Conflicts with "custom_key.user.device_type".
cache_deception_armor bool: Cache deception armor.
custom_key GetRulesetsRulesetRuleActionParametersCacheKeyCustomKey: Custom key parameters for the request.
ignore_query_strings_order bool: Ignore query strings order.

cacheByDeviceType Boolean: Cache by device type. Conflicts with "custom_key.user.device_type".
cacheDeceptionArmor Boolean: Cache deception armor.
customKey Property Map: Custom key parameters for the request.
ignoreQueryStringsOrder Boolean: Ignore query strings order.

GetRulesetsRulesetRuleActionParametersCacheKeyCustomKey

Cookie GetRulesetsRulesetRuleActionParametersCacheKeyCustomKeyCookie: Cookie parameters for the custom key.
Header GetRulesetsRulesetRuleActionParametersCacheKeyCustomKeyHeader: Header parameters for the custom key.
Host GetRulesetsRulesetRuleActionParametersCacheKeyCustomKeyHost: Host parameters for the custom key.
QueryString GetRulesetsRulesetRuleActionParametersCacheKeyCustomKeyQueryString: Query string parameters for the custom key.
User GetRulesetsRulesetRuleActionParametersCacheKeyCustomKeyUser: User parameters for the custom key.

Cookie GetRulesetsRulesetRuleActionParametersCacheKeyCustomKeyCookie: Cookie parameters for the custom key.
Header GetRulesetsRulesetRuleActionParametersCacheKeyCustomKeyHeader: Header parameters for the custom key.
Host GetRulesetsRulesetRuleActionParametersCacheKeyCustomKeyHost: Host parameters for the custom key.
QueryString GetRulesetsRulesetRuleActionParametersCacheKeyCustomKeyQueryString: Query string parameters for the custom key.
User GetRulesetsRulesetRuleActionParametersCacheKeyCustomKeyUser: User parameters for the custom key.

cookie GetRulesetsRulesetRuleActionParametersCacheKeyCustomKeyCookie: Cookie parameters for the custom key.
header GetRulesetsRulesetRuleActionParametersCacheKeyCustomKeyHeader: Header parameters for the custom key.
host GetRulesetsRulesetRuleActionParametersCacheKeyCustomKeyHost: Host parameters for the custom key.
queryString GetRulesetsRulesetRuleActionParametersCacheKeyCustomKeyQueryString: Query string parameters for the custom key.
user GetRulesetsRulesetRuleActionParametersCacheKeyCustomKeyUser: User parameters for the custom key.

cookie GetRulesetsRulesetRuleActionParametersCacheKeyCustomKeyCookie: Cookie parameters for the custom key.
header GetRulesetsRulesetRuleActionParametersCacheKeyCustomKeyHeader: Header parameters for the custom key.
host GetRulesetsRulesetRuleActionParametersCacheKeyCustomKeyHost: Host parameters for the custom key.
queryString GetRulesetsRulesetRuleActionParametersCacheKeyCustomKeyQueryString: Query string parameters for the custom key.
user GetRulesetsRulesetRuleActionParametersCacheKeyCustomKeyUser: User parameters for the custom key.

cookie GetRulesetsRulesetRuleActionParametersCacheKeyCustomKeyCookie: Cookie parameters for the custom key.
header GetRulesetsRulesetRuleActionParametersCacheKeyCustomKeyHeader: Header parameters for the custom key.
host GetRulesetsRulesetRuleActionParametersCacheKeyCustomKeyHost: Host parameters for the custom key.
query_string GetRulesetsRulesetRuleActionParametersCacheKeyCustomKeyQueryString: Query string parameters for the custom key.
user GetRulesetsRulesetRuleActionParametersCacheKeyCustomKeyUser: User parameters for the custom key.

cookie Property Map: Cookie parameters for the custom key.
header Property Map: Header parameters for the custom key.
host Property Map: Host parameters for the custom key.
queryString Property Map: Query string parameters for the custom key.
user Property Map: User parameters for the custom key.

GetRulesetsRulesetRuleActionParametersCacheKeyCustomKeyCookie

CheckPresences List<string>: List of cookies to check for presence in the custom key.
Includes List<string>: List of cookies to include in the custom key.

CheckPresences []string: List of cookies to check for presence in the custom key.
Includes []string: List of cookies to include in the custom key.

checkPresences List<String>: List of cookies to check for presence in the custom key.
includes List<String>: List of cookies to include in the custom key.

checkPresences string[]: List of cookies to check for presence in the custom key.
includes string[]: List of cookies to include in the custom key.

check_presences Sequence[str]: List of cookies to check for presence in the custom key.
includes Sequence[str]: List of cookies to include in the custom key.

checkPresences List<String>: List of cookies to check for presence in the custom key.
includes List<String>: List of cookies to include in the custom key.

GetRulesetsRulesetRuleActionParametersCacheKeyCustomKeyHeader

CheckPresences List<string>: List of headers to check for presence in the custom key.
ExcludeOrigin bool: Exclude the origin header from the custom key.
Includes List<string>: List of headers to include in the custom key.

CheckPresences []string: List of headers to check for presence in the custom key.
ExcludeOrigin bool: Exclude the origin header from the custom key.
Includes []string: List of headers to include in the custom key.

checkPresences List<String>: List of headers to check for presence in the custom key.
excludeOrigin Boolean: Exclude the origin header from the custom key.
includes List<String>: List of headers to include in the custom key.

checkPresences string[]: List of headers to check for presence in the custom key.
excludeOrigin boolean: Exclude the origin header from the custom key.
includes string[]: List of headers to include in the custom key.

check_presences Sequence[str]: List of headers to check for presence in the custom key.
exclude_origin bool: Exclude the origin header from the custom key.
includes Sequence[str]: List of headers to include in the custom key.

checkPresences List<String>: List of headers to check for presence in the custom key.
excludeOrigin Boolean: Exclude the origin header from the custom key.
includes List<String>: List of headers to include in the custom key.

GetRulesetsRulesetRuleActionParametersCacheKeyCustomKeyHost

Resolved bool: Resolve hostname to IP address.

Resolved bool: Resolve hostname to IP address.

resolved Boolean: Resolve hostname to IP address.

resolved boolean: Resolve hostname to IP address.

resolved bool: Resolve hostname to IP address.

resolved Boolean: Resolve hostname to IP address.

GetRulesetsRulesetRuleActionParametersCacheKeyCustomKeyQueryString

Excludes List<string>: List of query string parameters to exclude from the custom key. Conflicts with "include".
Includes List<string>: List of query string parameters to include in the custom key. Conflicts with "exclude".

Excludes []string: List of query string parameters to exclude from the custom key. Conflicts with "include".
Includes []string: List of query string parameters to include in the custom key. Conflicts with "exclude".

excludes List<String>: List of query string parameters to exclude from the custom key. Conflicts with "include".
includes List<String>: List of query string parameters to include in the custom key. Conflicts with "exclude".

excludes string[]: List of query string parameters to exclude from the custom key. Conflicts with "include".
includes string[]: List of query string parameters to include in the custom key. Conflicts with "exclude".

excludes Sequence[str]: List of query string parameters to exclude from the custom key. Conflicts with "include".
includes Sequence[str]: List of query string parameters to include in the custom key. Conflicts with "exclude".

excludes List<String>: List of query string parameters to exclude from the custom key. Conflicts with "include".
includes List<String>: List of query string parameters to include in the custom key. Conflicts with "exclude".

GetRulesetsRulesetRuleActionParametersCacheKeyCustomKeyUser

DeviceType bool: Add device type to the custom key. Conflicts with "cache_key.cache_by_device_type".
Geo bool: Add geo data to the custom key.
Lang bool: Add language data to the custom key.

DeviceType bool: Add device type to the custom key. Conflicts with "cache_key.cache_by_device_type".
Geo bool: Add geo data to the custom key.
Lang bool: Add language data to the custom key.

deviceType Boolean: Add device type to the custom key. Conflicts with "cache_key.cache_by_device_type".
geo Boolean: Add geo data to the custom key.
lang Boolean: Add language data to the custom key.

deviceType boolean: Add device type to the custom key. Conflicts with "cache_key.cache_by_device_type".
geo boolean: Add geo data to the custom key.
lang boolean: Add language data to the custom key.

device_type bool: Add device type to the custom key. Conflicts with "cache_key.cache_by_device_type".
geo bool: Add geo data to the custom key.
lang bool: Add language data to the custom key.

deviceType Boolean: Add device type to the custom key. Conflicts with "cache_key.cache_by_device_type".
geo Boolean: Add geo data to the custom key.
lang Boolean: Add language data to the custom key.

GetRulesetsRulesetRuleActionParametersEdgeTtl

Mode string: Mode of the edge TTL.
Default int: Default edge TTL
StatusCodeTtls List<GetRulesetsRulesetRuleActionParametersEdgeTtlStatusCodeTtl>: Edge TTL for the status codes.

Mode string: Mode of the edge TTL.
Default int: Default edge TTL
StatusCodeTtls []GetRulesetsRulesetRuleActionParametersEdgeTtlStatusCodeTtl: Edge TTL for the status codes.

mode String: Mode of the edge TTL.
default_ Integer: Default edge TTL
statusCodeTtls List<GetRulesetsRulesetRuleActionParametersEdgeTtlStatusCodeTtl>: Edge TTL for the status codes.

mode string: Mode of the edge TTL.
default number: Default edge TTL
statusCodeTtls GetRulesetsRulesetRuleActionParametersEdgeTtlStatusCodeTtl[]: Edge TTL for the status codes.

mode str: Mode of the edge TTL.
default int: Default edge TTL
status_code_ttls Sequence[GetRulesetsRulesetRuleActionParametersEdgeTtlStatusCodeTtl]: Edge TTL for the status codes.

mode String: Mode of the edge TTL.
default Number: Default edge TTL
statusCodeTtls List<Property Map>: Edge TTL for the status codes.

GetRulesetsRulesetRuleActionParametersEdgeTtlStatusCodeTtl

Value int: Status code edge TTL value.
StatusCode int: Status code for which the edge TTL is applied. Conflicts with "status_code_range".
StatusCodeRanges List<GetRulesetsRulesetRuleActionParametersEdgeTtlStatusCodeTtlStatusCodeRange>: Status code range for which the edge TTL is applied. Conflicts with "status_code".

Value int: Status code edge TTL value.
StatusCode int: Status code for which the edge TTL is applied. Conflicts with "status_code_range".
StatusCodeRanges []GetRulesetsRulesetRuleActionParametersEdgeTtlStatusCodeTtlStatusCodeRange: Status code range for which the edge TTL is applied. Conflicts with "status_code".

value Integer: Status code edge TTL value.
statusCode Integer: Status code for which the edge TTL is applied. Conflicts with "status_code_range".
statusCodeRanges List<GetRulesetsRulesetRuleActionParametersEdgeTtlStatusCodeTtlStatusCodeRange>: Status code range for which the edge TTL is applied. Conflicts with "status_code".

value number: Status code edge TTL value.
statusCode number: Status code for which the edge TTL is applied. Conflicts with "status_code_range".
statusCodeRanges GetRulesetsRulesetRuleActionParametersEdgeTtlStatusCodeTtlStatusCodeRange[]: Status code range for which the edge TTL is applied. Conflicts with "status_code".

value int: Status code edge TTL value.
status_code int: Status code for which the edge TTL is applied. Conflicts with "status_code_range".
status_code_ranges Sequence[GetRulesetsRulesetRuleActionParametersEdgeTtlStatusCodeTtlStatusCodeRange]: Status code range for which the edge TTL is applied. Conflicts with "status_code".

value Number: Status code edge TTL value.
statusCode Number: Status code for which the edge TTL is applied. Conflicts with "status_code_range".
statusCodeRanges List<Property Map>: Status code range for which the edge TTL is applied. Conflicts with "status_code".

GetRulesetsRulesetRuleActionParametersEdgeTtlStatusCodeTtlStatusCodeRange

From int: From status code.
To int: To status code.

From int: From status code.
To int: To status code.

from Integer: From status code.
to Integer: To status code.

from number: From status code.
to number: To status code.

from_ int: From status code.
to int: To status code.

from Number: From status code.
to Number: To status code.

GetRulesetsRulesetRuleActionParametersFromList

Key string: Expression to use for the list lookup.
Name string: Name of the ruleset.

Key string: Expression to use for the list lookup.
Name string: Name of the ruleset.

key String: Expression to use for the list lookup.
name String: Name of the ruleset.

key string: Expression to use for the list lookup.
name string: Name of the ruleset.

key str: Expression to use for the list lookup.
name str: Name of the ruleset.

key String: Expression to use for the list lookup.
name String: Name of the ruleset.

GetRulesetsRulesetRuleActionParametersFromValue

PreserveQueryString bool: Preserve query string for redirect URL.
StatusCode int: Status code for redirect.
TargetUrl GetRulesetsRulesetRuleActionParametersFromValueTargetUrl: Target URL for redirect.

PreserveQueryString bool: Preserve query string for redirect URL.
StatusCode int: Status code for redirect.
TargetUrl GetRulesetsRulesetRuleActionParametersFromValueTargetUrl: Target URL for redirect.

preserveQueryString Boolean: Preserve query string for redirect URL.
statusCode Integer: Status code for redirect.
targetUrl GetRulesetsRulesetRuleActionParametersFromValueTargetUrl: Target URL for redirect.

preserveQueryString boolean: Preserve query string for redirect URL.
statusCode number: Status code for redirect.
targetUrl GetRulesetsRulesetRuleActionParametersFromValueTargetUrl: Target URL for redirect.

preserve_query_string bool: Preserve query string for redirect URL.
status_code int: Status code for redirect.
target_url GetRulesetsRulesetRuleActionParametersFromValueTargetUrl: Target URL for redirect.

preserveQueryString Boolean: Preserve query string for redirect URL.
statusCode Number: Status code for redirect.
targetUrl Property Map: Target URL for redirect.

GetRulesetsRulesetRuleActionParametersFromValueTargetUrl

Expression string: Use a value dynamically determined by the Firewall Rules expression language based on Wireshark display filters. Refer to the Firewall Rules language documentation for all available fields, operators, and functions. Conflicts with "value".
Value string: Static value to provide as the HTTP request header value. Conflicts with "expression".

Expression string: Use a value dynamically determined by the Firewall Rules expression language based on Wireshark display filters. Refer to the Firewall Rules language documentation for all available fields, operators, and functions. Conflicts with "value".
Value string: Static value to provide as the HTTP request header value. Conflicts with "expression".

expression String: Use a value dynamically determined by the Firewall Rules expression language based on Wireshark display filters. Refer to the Firewall Rules language documentation for all available fields, operators, and functions. Conflicts with "value".
value String: Static value to provide as the HTTP request header value. Conflicts with "expression".

expression string: Use a value dynamically determined by the Firewall Rules expression language based on Wireshark display filters. Refer to the Firewall Rules language documentation for all available fields, operators, and functions. Conflicts with "value".
value string: Static value to provide as the HTTP request header value. Conflicts with "expression".

expression str: Use a value dynamically determined by the Firewall Rules expression language based on Wireshark display filters. Refer to the Firewall Rules language documentation for all available fields, operators, and functions. Conflicts with "value".
value str: Static value to provide as the HTTP request header value. Conflicts with "expression".

expression String: Use a value dynamically determined by the Firewall Rules expression language based on Wireshark display filters. Refer to the Firewall Rules language documentation for all available fields, operators, and functions. Conflicts with "value".
value String: Static value to provide as the HTTP request header value. Conflicts with "expression".

GetRulesetsRulesetRuleActionParametersHeader

Expression string: Use a value dynamically determined by the Firewall Rules expression language based on Wireshark display filters. Refer to the Firewall Rules language documentation for all available fields, operators, and functions. Conflicts with "value".
Name string: Name of the ruleset.
Operation string: Action to perform on the HTTP request header. Available values: remove, set, add
Value string: Static value to provide as the HTTP request header value. Conflicts with "expression".

Expression string: Use a value dynamically determined by the Firewall Rules expression language based on Wireshark display filters. Refer to the Firewall Rules language documentation for all available fields, operators, and functions. Conflicts with "value".
Name string: Name of the ruleset.
Operation string: Action to perform on the HTTP request header. Available values: remove, set, add
Value string: Static value to provide as the HTTP request header value. Conflicts with "expression".

expression String: Use a value dynamically determined by the Firewall Rules expression language based on Wireshark display filters. Refer to the Firewall Rules language documentation for all available fields, operators, and functions. Conflicts with "value".
name String: Name of the ruleset.
operation String: Action to perform on the HTTP request header. Available values: remove, set, add
value String: Static value to provide as the HTTP request header value. Conflicts with "expression".

expression string: Use a value dynamically determined by the Firewall Rules expression language based on Wireshark display filters. Refer to the Firewall Rules language documentation for all available fields, operators, and functions. Conflicts with "value".
name string: Name of the ruleset.
operation string: Action to perform on the HTTP request header. Available values: remove, set, add
value string: Static value to provide as the HTTP request header value. Conflicts with "expression".

expression str: Use a value dynamically determined by the Firewall Rules expression language based on Wireshark display filters. Refer to the Firewall Rules language documentation for all available fields, operators, and functions. Conflicts with "value".
name str: Name of the ruleset.
operation str: Action to perform on the HTTP request header. Available values: remove, set, add
value str: Static value to provide as the HTTP request header value. Conflicts with "expression".

expression String: Use a value dynamically determined by the Firewall Rules expression language based on Wireshark display filters. Refer to the Firewall Rules language documentation for all available fields, operators, and functions. Conflicts with "value".
name String: Name of the ruleset.
operation String: Action to perform on the HTTP request header. Available values: remove, set, add
value String: Static value to provide as the HTTP request header value. Conflicts with "expression".

GetRulesetsRulesetRuleActionParametersMatchedData

PublicKey string: Public key to use within WAF Ruleset payload logging to view the HTTP request parameters. You can generate a public key using the matched-data-cli command-line tool or in the Cloudflare dashboard

PublicKey string: Public key to use within WAF Ruleset payload logging to view the HTTP request parameters. You can generate a public key using the matched-data-cli command-line tool or in the Cloudflare dashboard

publicKey String: Public key to use within WAF Ruleset payload logging to view the HTTP request parameters. You can generate a public key using the matched-data-cli command-line tool or in the Cloudflare dashboard

publicKey string: Public key to use within WAF Ruleset payload logging to view the HTTP request parameters. You can generate a public key using the matched-data-cli command-line tool or in the Cloudflare dashboard

public_key str: Public key to use within WAF Ruleset payload logging to view the HTTP request parameters. You can generate a public key using the matched-data-cli command-line tool or in the Cloudflare dashboard

publicKey String: Public key to use within WAF Ruleset payload logging to view the HTTP request parameters. You can generate a public key using the matched-data-cli command-line tool or in the Cloudflare dashboard

GetRulesetsRulesetRuleActionParametersOrigin

Host string: Origin Hostname where request is sent.
Port int: Origin Port where request is sent.

Host string: Origin Hostname where request is sent.
Port int: Origin Port where request is sent.

host String: Origin Hostname where request is sent.
port Integer: Origin Port where request is sent.

host string: Origin Hostname where request is sent.
port number: Origin Port where request is sent.

host str: Origin Hostname where request is sent.
port int: Origin Port where request is sent.

host String: Origin Hostname where request is sent.
port Number: Origin Port where request is sent.

GetRulesetsRulesetRuleActionParametersOverrides

Action string: Action to perform in the rule-level override. Available values: block, challenge, compress_response, ddos_dynamic, ddos_mitigation, execute, force_connection_close, js_challenge, log, log_custom_field, managed_challenge, redirect, rewrite, route, score, serve_error, set_cache_settings, set_config, skip
Categories List<GetRulesetsRulesetRuleActionParametersOverridesCategory>: List of tag-based overrides.
Enabled bool: Defines if the current ruleset-level override enables or disables the ruleset.
Deprecated: Use status instead. Continuing to use enabled will result in an inconsistent state for your Ruleset configuration.
Rules List<GetRulesetsRulesetRuleActionParametersOverridesRule>: List of rule-based overrides.
SensitivityLevel string: Sensitivity level to override for all ruleset rules. Available values: default, medium, low, eoff
Status string: Defines if the current ruleset-level override enables or disables the ruleset. Available values: enabled, disabled

Action string: Action to perform in the rule-level override. Available values: block, challenge, compress_response, ddos_dynamic, ddos_mitigation, execute, force_connection_close, js_challenge, log, log_custom_field, managed_challenge, redirect, rewrite, route, score, serve_error, set_cache_settings, set_config, skip
Categories []GetRulesetsRulesetRuleActionParametersOverridesCategory: List of tag-based overrides.
Enabled bool: Defines if the current ruleset-level override enables or disables the ruleset.
Deprecated: Use status instead. Continuing to use enabled will result in an inconsistent state for your Ruleset configuration.
Rules []GetRulesetsRulesetRuleActionParametersOverridesRule: List of rule-based overrides.
SensitivityLevel string: Sensitivity level to override for all ruleset rules. Available values: default, medium, low, eoff
Status string: Defines if the current ruleset-level override enables or disables the ruleset. Available values: enabled, disabled

action String: Action to perform in the rule-level override. Available values: block, challenge, compress_response, ddos_dynamic, ddos_mitigation, execute, force_connection_close, js_challenge, log, log_custom_field, managed_challenge, redirect, rewrite, route, score, serve_error, set_cache_settings, set_config, skip
categories List<GetRulesetsRulesetRuleActionParametersOverridesCategory>: List of tag-based overrides.
enabled Boolean: Defines if the current ruleset-level override enables or disables the ruleset.
Deprecated: Use status instead. Continuing to use enabled will result in an inconsistent state for your Ruleset configuration.
rules List<GetRulesetsRulesetRuleActionParametersOverridesRule>: List of rule-based overrides.
sensitivityLevel String: Sensitivity level to override for all ruleset rules. Available values: default, medium, low, eoff
status String: Defines if the current ruleset-level override enables or disables the ruleset. Available values: enabled, disabled

action string: Action to perform in the rule-level override. Available values: block, challenge, compress_response, ddos_dynamic, ddos_mitigation, execute, force_connection_close, js_challenge, log, log_custom_field, managed_challenge, redirect, rewrite, route, score, serve_error, set_cache_settings, set_config, skip
categories GetRulesetsRulesetRuleActionParametersOverridesCategory[]: List of tag-based overrides.
enabled boolean: Defines if the current ruleset-level override enables or disables the ruleset.
Deprecated: Use status instead. Continuing to use enabled will result in an inconsistent state for your Ruleset configuration.
rules GetRulesetsRulesetRuleActionParametersOverridesRule[]: List of rule-based overrides.
sensitivityLevel string: Sensitivity level to override for all ruleset rules. Available values: default, medium, low, eoff
status string: Defines if the current ruleset-level override enables or disables the ruleset. Available values: enabled, disabled

action str: Action to perform in the rule-level override. Available values: block, challenge, compress_response, ddos_dynamic, ddos_mitigation, execute, force_connection_close, js_challenge, log, log_custom_field, managed_challenge, redirect, rewrite, route, score, serve_error, set_cache_settings, set_config, skip
categories Sequence[GetRulesetsRulesetRuleActionParametersOverridesCategory]: List of tag-based overrides.
enabled bool: Defines if the current ruleset-level override enables or disables the ruleset.
Deprecated: Use status instead. Continuing to use enabled will result in an inconsistent state for your Ruleset configuration.
rules Sequence[GetRulesetsRulesetRuleActionParametersOverridesRule]: List of rule-based overrides.
sensitivity_level str: Sensitivity level to override for all ruleset rules. Available values: default, medium, low, eoff
status str: Defines if the current ruleset-level override enables or disables the ruleset. Available values: enabled, disabled

action String: Action to perform in the rule-level override. Available values: block, challenge, compress_response, ddos_dynamic, ddos_mitigation, execute, force_connection_close, js_challenge, log, log_custom_field, managed_challenge, redirect, rewrite, route, score, serve_error, set_cache_settings, set_config, skip
categories List<Property Map>: List of tag-based overrides.
enabled Boolean: Defines if the current ruleset-level override enables or disables the ruleset.
Deprecated: Use status instead. Continuing to use enabled will result in an inconsistent state for your Ruleset configuration.
rules List<Property Map>: List of rule-based overrides.
sensitivityLevel String: Sensitivity level to override for all ruleset rules. Available values: default, medium, low, eoff
status String: Defines if the current ruleset-level override enables or disables the ruleset. Available values: enabled, disabled

GetRulesetsRulesetRuleActionParametersOverridesCategory

Action string: Action to perform in the tag-level override. Available values: block, challenge, compress_response, ddos_dynamic, ddos_mitigation, execute, force_connection_close, js_challenge, log, log_custom_field, managed_challenge, redirect, rewrite, route, score, serve_error, set_cache_settings, set_config, skip
Category string: Tag name to apply the ruleset rule override to.
Enabled bool: Defines if the current tag-level override enables or disables the ruleset rules with the specified tag.
Deprecated: Use status instead. Continuing to use enabled will result in an inconsistent state for your Ruleset configuration.
Status string: Defines if the current tag-level override enables or disables the ruleset rules with the specified tag. Available values: enabled, disabled

Action string: Action to perform in the tag-level override. Available values: block, challenge, compress_response, ddos_dynamic, ddos_mitigation, execute, force_connection_close, js_challenge, log, log_custom_field, managed_challenge, redirect, rewrite, route, score, serve_error, set_cache_settings, set_config, skip
Category string: Tag name to apply the ruleset rule override to.
Enabled bool: Defines if the current tag-level override enables or disables the ruleset rules with the specified tag.
Deprecated: Use status instead. Continuing to use enabled will result in an inconsistent state for your Ruleset configuration.
Status string: Defines if the current tag-level override enables or disables the ruleset rules with the specified tag. Available values: enabled, disabled

action String: Action to perform in the tag-level override. Available values: block, challenge, compress_response, ddos_dynamic, ddos_mitigation, execute, force_connection_close, js_challenge, log, log_custom_field, managed_challenge, redirect, rewrite, route, score, serve_error, set_cache_settings, set_config, skip
category String: Tag name to apply the ruleset rule override to.
enabled Boolean: Defines if the current tag-level override enables or disables the ruleset rules with the specified tag.
Deprecated: Use status instead. Continuing to use enabled will result in an inconsistent state for your Ruleset configuration.
status String: Defines if the current tag-level override enables or disables the ruleset rules with the specified tag. Available values: enabled, disabled

action string: Action to perform in the tag-level override. Available values: block, challenge, compress_response, ddos_dynamic, ddos_mitigation, execute, force_connection_close, js_challenge, log, log_custom_field, managed_challenge, redirect, rewrite, route, score, serve_error, set_cache_settings, set_config, skip
category string: Tag name to apply the ruleset rule override to.
enabled boolean: Defines if the current tag-level override enables or disables the ruleset rules with the specified tag.
Deprecated: Use status instead. Continuing to use enabled will result in an inconsistent state for your Ruleset configuration.
status string: Defines if the current tag-level override enables or disables the ruleset rules with the specified tag. Available values: enabled, disabled

action str: Action to perform in the tag-level override. Available values: block, challenge, compress_response, ddos_dynamic, ddos_mitigation, execute, force_connection_close, js_challenge, log, log_custom_field, managed_challenge, redirect, rewrite, route, score, serve_error, set_cache_settings, set_config, skip
category str: Tag name to apply the ruleset rule override to.
enabled bool: Defines if the current tag-level override enables or disables the ruleset rules with the specified tag.
Deprecated: Use status instead. Continuing to use enabled will result in an inconsistent state for your Ruleset configuration.
status str: Defines if the current tag-level override enables or disables the ruleset rules with the specified tag. Available values: enabled, disabled

action String: Action to perform in the tag-level override. Available values: block, challenge, compress_response, ddos_dynamic, ddos_mitigation, execute, force_connection_close, js_challenge, log, log_custom_field, managed_challenge, redirect, rewrite, route, score, serve_error, set_cache_settings, set_config, skip
category String: Tag name to apply the ruleset rule override to.
enabled Boolean: Defines if the current tag-level override enables or disables the ruleset rules with the specified tag.
Deprecated: Use status instead. Continuing to use enabled will result in an inconsistent state for your Ruleset configuration.
status String: Defines if the current tag-level override enables or disables the ruleset rules with the specified tag. Available values: enabled, disabled

GetRulesetsRulesetRuleActionParametersOverridesRule

Action string: Action to perform in the rule-level override. Available values: block, challenge, compress_response, ddos_dynamic, ddos_mitigation, execute, force_connection_close, js_challenge, log, log_custom_field, managed_challenge, redirect, rewrite, route, score, serve_error, set_cache_settings, set_config, skip
Enabled bool: Defines if the current rule-level override enables or disables the rule.
Deprecated: Use status instead. Continuing to use enabled will result in an inconsistent state for your Ruleset configuration.
Id string: The ID of the Ruleset to target.
ScoreThreshold int: Anomaly score threshold to apply in the ruleset rule override. Only applicable to modsecurity-based rulesets.
SensitivityLevel string: Sensitivity level for a ruleset rule override.
Status string: Defines if the current rule-level override enables or disables the rule. Available values: enabled, disabled

Action string: Action to perform in the rule-level override. Available values: block, challenge, compress_response, ddos_dynamic, ddos_mitigation, execute, force_connection_close, js_challenge, log, log_custom_field, managed_challenge, redirect, rewrite, route, score, serve_error, set_cache_settings, set_config, skip
Enabled bool: Defines if the current rule-level override enables or disables the rule.
Deprecated: Use status instead. Continuing to use enabled will result in an inconsistent state for your Ruleset configuration.
Id string: The ID of the Ruleset to target.
ScoreThreshold int: Anomaly score threshold to apply in the ruleset rule override. Only applicable to modsecurity-based rulesets.
SensitivityLevel string: Sensitivity level for a ruleset rule override.
Status string: Defines if the current rule-level override enables or disables the rule. Available values: enabled, disabled

action String: Action to perform in the rule-level override. Available values: block, challenge, compress_response, ddos_dynamic, ddos_mitigation, execute, force_connection_close, js_challenge, log, log_custom_field, managed_challenge, redirect, rewrite, route, score, serve_error, set_cache_settings, set_config, skip
enabled Boolean: Defines if the current rule-level override enables or disables the rule.
Deprecated: Use status instead. Continuing to use enabled will result in an inconsistent state for your Ruleset configuration.
id String: The ID of the Ruleset to target.
scoreThreshold Integer: Anomaly score threshold to apply in the ruleset rule override. Only applicable to modsecurity-based rulesets.
sensitivityLevel String: Sensitivity level for a ruleset rule override.
status String: Defines if the current rule-level override enables or disables the rule. Available values: enabled, disabled

action string: Action to perform in the rule-level override. Available values: block, challenge, compress_response, ddos_dynamic, ddos_mitigation, execute, force_connection_close, js_challenge, log, log_custom_field, managed_challenge, redirect, rewrite, route, score, serve_error, set_cache_settings, set_config, skip
enabled boolean: Defines if the current rule-level override enables or disables the rule.
Deprecated: Use status instead. Continuing to use enabled will result in an inconsistent state for your Ruleset configuration.
id string: The ID of the Ruleset to target.
scoreThreshold number: Anomaly score threshold to apply in the ruleset rule override. Only applicable to modsecurity-based rulesets.
sensitivityLevel string: Sensitivity level for a ruleset rule override.
status string: Defines if the current rule-level override enables or disables the rule. Available values: enabled, disabled

action str: Action to perform in the rule-level override. Available values: block, challenge, compress_response, ddos_dynamic, ddos_mitigation, execute, force_connection_close, js_challenge, log, log_custom_field, managed_challenge, redirect, rewrite, route, score, serve_error, set_cache_settings, set_config, skip
enabled bool: Defines if the current rule-level override enables or disables the rule.
Deprecated: Use status instead. Continuing to use enabled will result in an inconsistent state for your Ruleset configuration.
id str: The ID of the Ruleset to target.
score_threshold int: Anomaly score threshold to apply in the ruleset rule override. Only applicable to modsecurity-based rulesets.
sensitivity_level str: Sensitivity level for a ruleset rule override.
status str: Defines if the current rule-level override enables or disables the rule. Available values: enabled, disabled

action String: Action to perform in the rule-level override. Available values: block, challenge, compress_response, ddos_dynamic, ddos_mitigation, execute, force_connection_close, js_challenge, log, log_custom_field, managed_challenge, redirect, rewrite, route, score, serve_error, set_cache_settings, set_config, skip
enabled Boolean: Defines if the current rule-level override enables or disables the rule.
Deprecated: Use status instead. Continuing to use enabled will result in an inconsistent state for your Ruleset configuration.
id String: The ID of the Ruleset to target.
scoreThreshold Number: Anomaly score threshold to apply in the ruleset rule override. Only applicable to modsecurity-based rulesets.
sensitivityLevel String: Sensitivity level for a ruleset rule override.
status String: Defines if the current rule-level override enables or disables the rule. Available values: enabled, disabled

GetRulesetsRulesetRuleActionParametersResponse

Content string: Body content to include in the response.
ContentType string: HTTP content type to send in the response.
StatusCode int: HTTP status code to send in the response.

Content string: Body content to include in the response.
ContentType string: HTTP content type to send in the response.
StatusCode int: HTTP status code to send in the response.

content String: Body content to include in the response.
contentType String: HTTP content type to send in the response.
statusCode Integer: HTTP status code to send in the response.

content string: Body content to include in the response.
contentType string: HTTP content type to send in the response.
statusCode number: HTTP status code to send in the response.

content str: Body content to include in the response.
content_type str: HTTP content type to send in the response.
status_code int: HTTP status code to send in the response.

content String: Body content to include in the response.
contentType String: HTTP content type to send in the response.
statusCode Number: HTTP status code to send in the response.

GetRulesetsRulesetRuleActionParametersServeStale

DisableStaleWhileUpdating bool: Disable stale while updating.

DisableStaleWhileUpdating bool: Disable stale while updating.

disableStaleWhileUpdating Boolean: Disable stale while updating.

disableStaleWhileUpdating boolean: Disable stale while updating.

disable_stale_while_updating bool: Disable stale while updating.

disableStaleWhileUpdating Boolean: Disable stale while updating.

GetRulesetsRulesetRuleActionParametersSni

Value string: Value to define for SNI.

Value string: Value to define for SNI.

value String: Value to define for SNI.

value string: Value to define for SNI.

value str: Value to define for SNI.

value String: Value to define for SNI.

GetRulesetsRulesetRuleActionParametersUri

Origin bool
Path GetRulesetsRulesetRuleActionParametersUriPath: URI path configuration when performing a URL rewrite.
Query GetRulesetsRulesetRuleActionParametersUriQuery: Query string configuration when performing a URL rewrite.

Origin bool
Path GetRulesetsRulesetRuleActionParametersUriPath: URI path configuration when performing a URL rewrite.
Query GetRulesetsRulesetRuleActionParametersUriQuery: Query string configuration when performing a URL rewrite.

origin Boolean
path GetRulesetsRulesetRuleActionParametersUriPath: URI path configuration when performing a URL rewrite.
query GetRulesetsRulesetRuleActionParametersUriQuery: Query string configuration when performing a URL rewrite.

origin boolean
path GetRulesetsRulesetRuleActionParametersUriPath: URI path configuration when performing a URL rewrite.
query GetRulesetsRulesetRuleActionParametersUriQuery: Query string configuration when performing a URL rewrite.

origin bool
path GetRulesetsRulesetRuleActionParametersUriPath: URI path configuration when performing a URL rewrite.
query GetRulesetsRulesetRuleActionParametersUriQuery: Query string configuration when performing a URL rewrite.

origin Boolean
path Property Map: URI path configuration when performing a URL rewrite.
query Property Map: Query string configuration when performing a URL rewrite.

GetRulesetsRulesetRuleActionParametersUriPath

Expression string: Expression that defines the updated (dynamic) value of the URI path or query string component. Uses the Firewall Rules expression language based on Wireshark display filters. Refer to the Firewall Rules language documentation for all available fields, operators, and functions
Value string: Static string value of the updated URI path or query string component.

Expression string: Expression that defines the updated (dynamic) value of the URI path or query string component. Uses the Firewall Rules expression language based on Wireshark display filters. Refer to the Firewall Rules language documentation for all available fields, operators, and functions
Value string: Static string value of the updated URI path or query string component.

expression String: Expression that defines the updated (dynamic) value of the URI path or query string component. Uses the Firewall Rules expression language based on Wireshark display filters. Refer to the Firewall Rules language documentation for all available fields, operators, and functions
value String: Static string value of the updated URI path or query string component.

expression string: Expression that defines the updated (dynamic) value of the URI path or query string component. Uses the Firewall Rules expression language based on Wireshark display filters. Refer to the Firewall Rules language documentation for all available fields, operators, and functions
value string: Static string value of the updated URI path or query string component.

expression str: Expression that defines the updated (dynamic) value of the URI path or query string component. Uses the Firewall Rules expression language based on Wireshark display filters. Refer to the Firewall Rules language documentation for all available fields, operators, and functions
value str: Static string value of the updated URI path or query string component.

expression String: Expression that defines the updated (dynamic) value of the URI path or query string component. Uses the Firewall Rules expression language based on Wireshark display filters. Refer to the Firewall Rules language documentation for all available fields, operators, and functions
value String: Static string value of the updated URI path or query string component.

GetRulesetsRulesetRuleActionParametersUriQuery

Expression string: Expression that defines the updated (dynamic) value of the URI path or query string component. Uses the Firewall Rules expression language based on Wireshark display filters. Refer to the Firewall Rules language documentation for all available fields, operators, and functions
Value string: Static string value of the updated URI path or query string component.

Expression string: Expression that defines the updated (dynamic) value of the URI path or query string component. Uses the Firewall Rules expression language based on Wireshark display filters. Refer to the Firewall Rules language documentation for all available fields, operators, and functions
Value string: Static string value of the updated URI path or query string component.

expression String: Expression that defines the updated (dynamic) value of the URI path or query string component. Uses the Firewall Rules expression language based on Wireshark display filters. Refer to the Firewall Rules language documentation for all available fields, operators, and functions
value String: Static string value of the updated URI path or query string component.

expression string: Expression that defines the updated (dynamic) value of the URI path or query string component. Uses the Firewall Rules expression language based on Wireshark display filters. Refer to the Firewall Rules language documentation for all available fields, operators, and functions
value string: Static string value of the updated URI path or query string component.

expression str: Expression that defines the updated (dynamic) value of the URI path or query string component. Uses the Firewall Rules expression language based on Wireshark display filters. Refer to the Firewall Rules language documentation for all available fields, operators, and functions
value str: Static string value of the updated URI path or query string component.

expression String: Expression that defines the updated (dynamic) value of the URI path or query string component. Uses the Firewall Rules expression language based on Wireshark display filters. Refer to the Firewall Rules language documentation for all available fields, operators, and functions
value String: Static string value of the updated URI path or query string component.

GetRulesetsRulesetRuleExposedCredentialCheck

PasswordExpression string: Firewall Rules expression language based on Wireshark display filters for where to check for the "password" value. Refer to the Firewall Rules language.
UsernameExpression string: Firewall Rules expression language based on Wireshark display filters for where to check for the "username" value. Refer to the Firewall Rules language.

PasswordExpression string: Firewall Rules expression language based on Wireshark display filters for where to check for the "password" value. Refer to the Firewall Rules language.
UsernameExpression string: Firewall Rules expression language based on Wireshark display filters for where to check for the "username" value. Refer to the Firewall Rules language.

passwordExpression String: Firewall Rules expression language based on Wireshark display filters for where to check for the "password" value. Refer to the Firewall Rules language.
usernameExpression String: Firewall Rules expression language based on Wireshark display filters for where to check for the "username" value. Refer to the Firewall Rules language.

passwordExpression string: Firewall Rules expression language based on Wireshark display filters for where to check for the "password" value. Refer to the Firewall Rules language.
usernameExpression string: Firewall Rules expression language based on Wireshark display filters for where to check for the "username" value. Refer to the Firewall Rules language.

password_expression str: Firewall Rules expression language based on Wireshark display filters for where to check for the "password" value. Refer to the Firewall Rules language.
username_expression str: Firewall Rules expression language based on Wireshark display filters for where to check for the "username" value. Refer to the Firewall Rules language.

passwordExpression String: Firewall Rules expression language based on Wireshark display filters for where to check for the "password" value. Refer to the Firewall Rules language.
usernameExpression String: Firewall Rules expression language based on Wireshark display filters for where to check for the "username" value. Refer to the Firewall Rules language.

GetRulesetsRulesetRuleLogging

Enabled bool: Override the default logging behavior when a rule is matched.
Deprecated: Use status instead. Continuing to use enabled will result in an inconsistent state for your Ruleset configuration.
Status string: Override the default logging behavior when a rule is matched. Available values: enabled, disabled

Enabled bool: Override the default logging behavior when a rule is matched.
Deprecated: Use status instead. Continuing to use enabled will result in an inconsistent state for your Ruleset configuration.
Status string: Override the default logging behavior when a rule is matched. Available values: enabled, disabled

enabled Boolean: Override the default logging behavior when a rule is matched.
Deprecated: Use status instead. Continuing to use enabled will result in an inconsistent state for your Ruleset configuration.
status String: Override the default logging behavior when a rule is matched. Available values: enabled, disabled

enabled boolean: Override the default logging behavior when a rule is matched.
Deprecated: Use status instead. Continuing to use enabled will result in an inconsistent state for your Ruleset configuration.
status string: Override the default logging behavior when a rule is matched. Available values: enabled, disabled

enabled bool: Override the default logging behavior when a rule is matched.
Deprecated: Use status instead. Continuing to use enabled will result in an inconsistent state for your Ruleset configuration.
status str: Override the default logging behavior when a rule is matched. Available values: enabled, disabled

enabled Boolean: Override the default logging behavior when a rule is matched.
Deprecated: Use status instead. Continuing to use enabled will result in an inconsistent state for your Ruleset configuration.
status String: Override the default logging behavior when a rule is matched. Available values: enabled, disabled

GetRulesetsRulesetRuleRatelimit

Characteristics List<string>: List of parameters that define how Cloudflare tracks the request rate for this rule.
CountingExpression string: Criteria for counting HTTP requests to trigger the Rate Limiting action. Uses the Firewall Rules expression language based on Wireshark display filters. Refer to the Firewall Rules language documentation for all available fields, operators, and functions.
MitigationTimeout int: Once the request rate is reached, the Rate Limiting rule blocks further requests for the period of time defined in this field.
Period int: The period of time to consider (in seconds) when evaluating the request rate.
RequestsPerPeriod int: The number of requests over the period of time that will trigger the Rate Limiting rule.
RequestsToOrigin bool: Whether to include requests to origin within the Rate Limiting count.
ScorePerPeriod int: The maximum aggregate score over the period of time that will trigger Rate Limiting rule.
ScoreResponseHeaderName string: Name of HTTP header in the response, set by the origin server, with the score for the current request.

Characteristics []string: List of parameters that define how Cloudflare tracks the request rate for this rule.
CountingExpression string: Criteria for counting HTTP requests to trigger the Rate Limiting action. Uses the Firewall Rules expression language based on Wireshark display filters. Refer to the Firewall Rules language documentation for all available fields, operators, and functions.
MitigationTimeout int: Once the request rate is reached, the Rate Limiting rule blocks further requests for the period of time defined in this field.
Period int: The period of time to consider (in seconds) when evaluating the request rate.
RequestsPerPeriod int: The number of requests over the period of time that will trigger the Rate Limiting rule.
RequestsToOrigin bool: Whether to include requests to origin within the Rate Limiting count.
ScorePerPeriod int: The maximum aggregate score over the period of time that will trigger Rate Limiting rule.
ScoreResponseHeaderName string: Name of HTTP header in the response, set by the origin server, with the score for the current request.

characteristics List<String>: List of parameters that define how Cloudflare tracks the request rate for this rule.
countingExpression String: Criteria for counting HTTP requests to trigger the Rate Limiting action. Uses the Firewall Rules expression language based on Wireshark display filters. Refer to the Firewall Rules language documentation for all available fields, operators, and functions.
mitigationTimeout Integer: Once the request rate is reached, the Rate Limiting rule blocks further requests for the period of time defined in this field.
period Integer: The period of time to consider (in seconds) when evaluating the request rate.
requestsPerPeriod Integer: The number of requests over the period of time that will trigger the Rate Limiting rule.
requestsToOrigin Boolean: Whether to include requests to origin within the Rate Limiting count.
scorePerPeriod Integer: The maximum aggregate score over the period of time that will trigger Rate Limiting rule.
scoreResponseHeaderName String: Name of HTTP header in the response, set by the origin server, with the score for the current request.

characteristics string[]: List of parameters that define how Cloudflare tracks the request rate for this rule.
countingExpression string: Criteria for counting HTTP requests to trigger the Rate Limiting action. Uses the Firewall Rules expression language based on Wireshark display filters. Refer to the Firewall Rules language documentation for all available fields, operators, and functions.
mitigationTimeout number: Once the request rate is reached, the Rate Limiting rule blocks further requests for the period of time defined in this field.
period number: The period of time to consider (in seconds) when evaluating the request rate.
requestsPerPeriod number: The number of requests over the period of time that will trigger the Rate Limiting rule.
requestsToOrigin boolean: Whether to include requests to origin within the Rate Limiting count.
scorePerPeriod number: The maximum aggregate score over the period of time that will trigger Rate Limiting rule.
scoreResponseHeaderName string: Name of HTTP header in the response, set by the origin server, with the score for the current request.

characteristics Sequence[str]: List of parameters that define how Cloudflare tracks the request rate for this rule.
counting_expression str: Criteria for counting HTTP requests to trigger the Rate Limiting action. Uses the Firewall Rules expression language based on Wireshark display filters. Refer to the Firewall Rules language documentation for all available fields, operators, and functions.
mitigation_timeout int: Once the request rate is reached, the Rate Limiting rule blocks further requests for the period of time defined in this field.
period int: The period of time to consider (in seconds) when evaluating the request rate.
requests_per_period int: The number of requests over the period of time that will trigger the Rate Limiting rule.
requests_to_origin bool: Whether to include requests to origin within the Rate Limiting count.
score_per_period int: The maximum aggregate score over the period of time that will trigger Rate Limiting rule.
score_response_header_name str: Name of HTTP header in the response, set by the origin server, with the score for the current request.

characteristics List<String>: List of parameters that define how Cloudflare tracks the request rate for this rule.
countingExpression String: Criteria for counting HTTP requests to trigger the Rate Limiting action. Uses the Firewall Rules expression language based on Wireshark display filters. Refer to the Firewall Rules language documentation for all available fields, operators, and functions.
mitigationTimeout Number: Once the request rate is reached, the Rate Limiting rule blocks further requests for the period of time defined in this field.
period Number: The period of time to consider (in seconds) when evaluating the request rate.
requestsPerPeriod Number: The number of requests over the period of time that will trigger the Rate Limiting rule.
requestsToOrigin Boolean: Whether to include requests to origin within the Rate Limiting count.
scorePerPeriod Number: The maximum aggregate score over the period of time that will trigger Rate Limiting rule.
scoreResponseHeaderName String: Name of HTTP header in the response, set by the origin server, with the score for the current request.

Package Details

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

Cloudflare v5.26.0 published on Wednesday, Apr 17, 2024 by Pulumi

pulumi/pulumi-cloudflare

cloudflare.getRulesets

On this page

On this page

Example Usage

Using getRulesets

getRulesets Result

Supporting Types

GetRulesetsFilter

GetRulesetsRuleset

GetRulesetsRulesetRule

GetRulesetsRulesetRuleActionParameters

GetRulesetsRulesetRuleActionParametersAutominify

GetRulesetsRulesetRuleActionParametersBrowserTtl

GetRulesetsRulesetRuleActionParametersCacheKey

GetRulesetsRulesetRuleActionParametersCacheKeyCustomKey

GetRulesetsRulesetRuleActionParametersCacheKeyCustomKeyCookie

GetRulesetsRulesetRuleActionParametersCacheKeyCustomKeyHeader

GetRulesetsRulesetRuleActionParametersCacheKeyCustomKeyHost

GetRulesetsRulesetRuleActionParametersCacheKeyCustomKeyQueryString

GetRulesetsRulesetRuleActionParametersCacheKeyCustomKeyUser

GetRulesetsRulesetRuleActionParametersEdgeTtl

GetRulesetsRulesetRuleActionParametersEdgeTtlStatusCodeTtl

GetRulesetsRulesetRuleActionParametersEdgeTtlStatusCodeTtlStatusCodeRange

GetRulesetsRulesetRuleActionParametersFromList

GetRulesetsRulesetRuleActionParametersFromValue

GetRulesetsRulesetRuleActionParametersFromValueTargetUrl

GetRulesetsRulesetRuleActionParametersHeader

GetRulesetsRulesetRuleActionParametersMatchedData

GetRulesetsRulesetRuleActionParametersOrigin

GetRulesetsRulesetRuleActionParametersOverrides

GetRulesetsRulesetRuleActionParametersOverridesCategory

GetRulesetsRulesetRuleActionParametersOverridesRule

GetRulesetsRulesetRuleActionParametersResponse

GetRulesetsRulesetRuleActionParametersServeStale

GetRulesetsRulesetRuleActionParametersSni

GetRulesetsRulesetRuleActionParametersUri

GetRulesetsRulesetRuleActionParametersUriPath

GetRulesetsRulesetRuleActionParametersUriQuery

GetRulesetsRulesetRuleExposedCredentialCheck

GetRulesetsRulesetRuleLogging

GetRulesetsRulesetRuleRatelimit

Package Details

On this page

On this page