Phases
Get an account or zone entry point ruleset
Update an account or zone entry point ruleset
ModelsExpand Collapse
PhaseGetResponse object { id, kind, last_updated, 5 more } A ruleset object.
A ruleset object.
rules: array of BlockRule { last_updated, version, id, 10 more } or object { id, action, enabled, 10 more } or CompressResponseRule { last_updated, version, id, 10 more } or 18 moreThe list of rules in the ruleset.
The list of rules in the ruleset.
ChallengeRule object { id, action, enabled, 10 more }
exposed_credential_check: optional object { password_expression, username_expression } Configuration for exposed credential checking.
Configuration for exposed credential checking.
ratelimit: optional object { characteristics, period, counting_expression, 5 more } An object configuring the rule’s rate limit behavior.
An object configuring the rule’s rate limit behavior.
Characteristics of the request on which the rate limit counter will be incremented.
An expression that defines when the rate limit counter should be incremented. It defaults to the same as the rule’s expression.
Period of time in seconds after which the action will be disabled following its first execution.
The threshold of requests per period after which the action will be executed for the first time.
JavaScriptChallengeRule object { id, action, enabled, 10 more }
exposed_credential_check: optional object { password_expression, username_expression } Configuration for exposed credential checking.
Configuration for exposed credential checking.
ratelimit: optional object { characteristics, period, counting_expression, 5 more } An object configuring the rule’s rate limit behavior.
An object configuring the rule’s rate limit behavior.
Characteristics of the request on which the rate limit counter will be incremented.
An expression that defines when the rate limit counter should be incremented. It defaults to the same as the rule’s expression.
Period of time in seconds after which the action will be disabled following its first execution.
The threshold of requests per period after which the action will be executed for the first time.
SetCacheControlRule object { id, action, enabled, 10 more }
action_parameters: optional object { immutable, "max-age", "must-revalidate", 10 more } The parameters configuring the rule’s action.
The parameters configuring the rule’s action.
immutable: optional object { operation, cloudflare_only } or object { operation, cloudflare_only } A cache-control directive configuration.
A cache-control directive configuration.
"max-age": optional object { operation, value, cloudflare_only } or object { operation, cloudflare_only } A cache-control directive configuration that accepts a duration value in seconds.
A cache-control directive configuration that accepts a duration value in seconds.
"must-revalidate": optional object { operation, cloudflare_only } or object { operation, cloudflare_only } A cache-control directive configuration.
A cache-control directive configuration.
"must-understand": optional object { operation, cloudflare_only } or object { operation, cloudflare_only } A cache-control directive configuration.
A cache-control directive configuration.
"no-cache": optional object { operation, cloudflare_only, qualifiers } or object { operation, cloudflare_only } A cache-control directive configuration that accepts optional qualifiers (header names).
A cache-control directive configuration that accepts optional qualifiers (header names).
"no-store": optional object { operation, cloudflare_only } or object { operation, cloudflare_only } A cache-control directive configuration.
A cache-control directive configuration.
"no-transform": optional object { operation, cloudflare_only } or object { operation, cloudflare_only } A cache-control directive configuration.
A cache-control directive configuration.
private: optional object { operation, cloudflare_only, qualifiers } or object { operation, cloudflare_only } A cache-control directive configuration that accepts optional qualifiers (header names).
A cache-control directive configuration that accepts optional qualifiers (header names).
"proxy-revalidate": optional object { operation, cloudflare_only } or object { operation, cloudflare_only } A cache-control directive configuration.
A cache-control directive configuration.
public: optional object { operation, cloudflare_only } or object { operation, cloudflare_only } A cache-control directive configuration.
A cache-control directive configuration.
"s-maxage": optional object { operation, value, cloudflare_only } or object { operation, cloudflare_only } A cache-control directive configuration that accepts a duration value in seconds.
A cache-control directive configuration that accepts a duration value in seconds.
"stale-if-error": optional object { operation, value, cloudflare_only } or object { operation, cloudflare_only } A cache-control directive configuration that accepts a duration value in seconds.
A cache-control directive configuration that accepts a duration value in seconds.
"stale-while-revalidate": optional object { operation, value, cloudflare_only } or object { operation, cloudflare_only } A cache-control directive configuration that accepts a duration value in seconds.
A cache-control directive configuration that accepts a duration value in seconds.
exposed_credential_check: optional object { password_expression, username_expression } Configuration for exposed credential checking.
Configuration for exposed credential checking.
ratelimit: optional object { characteristics, period, counting_expression, 5 more } An object configuring the rule’s rate limit behavior.
An object configuring the rule’s rate limit behavior.
Characteristics of the request on which the rate limit counter will be incremented.
An expression that defines when the rate limit counter should be incremented. It defaults to the same as the rule’s expression.
Period of time in seconds after which the action will be disabled following its first execution.
The threshold of requests per period after which the action will be executed for the first time.
SetCacheTagsRule object { id, action, enabled, 10 more }
action_parameters: optional object { operation, values } or object { expression, operation } or object { operation, values } or 3 moreThe parameters configuring the rule’s action.
The parameters configuring the rule’s action.
exposed_credential_check: optional object { password_expression, username_expression } Configuration for exposed credential checking.
Configuration for exposed credential checking.
ratelimit: optional object { characteristics, period, counting_expression, 5 more } An object configuring the rule’s rate limit behavior.
An object configuring the rule’s rate limit behavior.
Characteristics of the request on which the rate limit counter will be incremented.
An expression that defines when the rate limit counter should be incremented. It defaults to the same as the rule’s expression.
Period of time in seconds after which the action will be disabled following its first execution.
The threshold of requests per period after which the action will be executed for the first time.
TransformResponseHTMLRule object { id, action, enabled, 10 more }
exposed_credential_check: optional object { password_expression, username_expression } Configuration for exposed credential checking.
Configuration for exposed credential checking.
ratelimit: optional object { characteristics, period, counting_expression, 5 more } An object configuring the rule’s rate limit behavior.
An object configuring the rule’s rate limit behavior.
Characteristics of the request on which the rate limit counter will be incremented.
An expression that defines when the rate limit counter should be incremented. It defaults to the same as the rule’s expression.
Period of time in seconds after which the action will be disabled following its first execution.
The threshold of requests per period after which the action will be executed for the first time.
PhaseUpdateResponse = object { id, kind, last_updated, 5 more } or unknownA result.
A result.
Ruleset object { id, kind, last_updated, 5 more } A ruleset object.
A ruleset object.
rules: array of BlockRule { last_updated, version, id, 10 more } or object { id, action, enabled, 10 more } or CompressResponseRule { last_updated, version, id, 10 more } or 18 moreThe list of rules in the ruleset.
The list of rules in the ruleset.
ChallengeRule object { id, action, enabled, 10 more }
exposed_credential_check: optional object { password_expression, username_expression } Configuration for exposed credential checking.
Configuration for exposed credential checking.
ratelimit: optional object { characteristics, period, counting_expression, 5 more } An object configuring the rule’s rate limit behavior.
An object configuring the rule’s rate limit behavior.
Characteristics of the request on which the rate limit counter will be incremented.
An expression that defines when the rate limit counter should be incremented. It defaults to the same as the rule’s expression.
Period of time in seconds after which the action will be disabled following its first execution.
The threshold of requests per period after which the action will be executed for the first time.
JavaScriptChallengeRule object { id, action, enabled, 10 more }
exposed_credential_check: optional object { password_expression, username_expression } Configuration for exposed credential checking.
Configuration for exposed credential checking.
ratelimit: optional object { characteristics, period, counting_expression, 5 more } An object configuring the rule’s rate limit behavior.
An object configuring the rule’s rate limit behavior.
Characteristics of the request on which the rate limit counter will be incremented.
An expression that defines when the rate limit counter should be incremented. It defaults to the same as the rule’s expression.
Period of time in seconds after which the action will be disabled following its first execution.
The threshold of requests per period after which the action will be executed for the first time.
SetCacheControlRule object { id, action, enabled, 10 more }
action_parameters: optional object { immutable, "max-age", "must-revalidate", 10 more } The parameters configuring the rule’s action.
The parameters configuring the rule’s action.
immutable: optional object { operation, cloudflare_only } or object { operation, cloudflare_only } A cache-control directive configuration.
A cache-control directive configuration.
"max-age": optional object { operation, value, cloudflare_only } or object { operation, cloudflare_only } A cache-control directive configuration that accepts a duration value in seconds.
A cache-control directive configuration that accepts a duration value in seconds.
"must-revalidate": optional object { operation, cloudflare_only } or object { operation, cloudflare_only } A cache-control directive configuration.
A cache-control directive configuration.
"must-understand": optional object { operation, cloudflare_only } or object { operation, cloudflare_only } A cache-control directive configuration.
A cache-control directive configuration.
"no-cache": optional object { operation, cloudflare_only, qualifiers } or object { operation, cloudflare_only } A cache-control directive configuration that accepts optional qualifiers (header names).
A cache-control directive configuration that accepts optional qualifiers (header names).
"no-store": optional object { operation, cloudflare_only } or object { operation, cloudflare_only } A cache-control directive configuration.
A cache-control directive configuration.
"no-transform": optional object { operation, cloudflare_only } or object { operation, cloudflare_only } A cache-control directive configuration.
A cache-control directive configuration.
private: optional object { operation, cloudflare_only, qualifiers } or object { operation, cloudflare_only } A cache-control directive configuration that accepts optional qualifiers (header names).
A cache-control directive configuration that accepts optional qualifiers (header names).
"proxy-revalidate": optional object { operation, cloudflare_only } or object { operation, cloudflare_only } A cache-control directive configuration.
A cache-control directive configuration.
public: optional object { operation, cloudflare_only } or object { operation, cloudflare_only } A cache-control directive configuration.
A cache-control directive configuration.
"s-maxage": optional object { operation, value, cloudflare_only } or object { operation, cloudflare_only } A cache-control directive configuration that accepts a duration value in seconds.
A cache-control directive configuration that accepts a duration value in seconds.
"stale-if-error": optional object { operation, value, cloudflare_only } or object { operation, cloudflare_only } A cache-control directive configuration that accepts a duration value in seconds.
A cache-control directive configuration that accepts a duration value in seconds.
"stale-while-revalidate": optional object { operation, value, cloudflare_only } or object { operation, cloudflare_only } A cache-control directive configuration that accepts a duration value in seconds.
A cache-control directive configuration that accepts a duration value in seconds.
exposed_credential_check: optional object { password_expression, username_expression } Configuration for exposed credential checking.
Configuration for exposed credential checking.
ratelimit: optional object { characteristics, period, counting_expression, 5 more } An object configuring the rule’s rate limit behavior.
An object configuring the rule’s rate limit behavior.
Characteristics of the request on which the rate limit counter will be incremented.
An expression that defines when the rate limit counter should be incremented. It defaults to the same as the rule’s expression.
Period of time in seconds after which the action will be disabled following its first execution.
The threshold of requests per period after which the action will be executed for the first time.
SetCacheTagsRule object { id, action, enabled, 10 more }
action_parameters: optional object { operation, values } or object { expression, operation } or object { operation, values } or 3 moreThe parameters configuring the rule’s action.
The parameters configuring the rule’s action.
exposed_credential_check: optional object { password_expression, username_expression } Configuration for exposed credential checking.
Configuration for exposed credential checking.
ratelimit: optional object { characteristics, period, counting_expression, 5 more } An object configuring the rule’s rate limit behavior.
An object configuring the rule’s rate limit behavior.
Characteristics of the request on which the rate limit counter will be incremented.
An expression that defines when the rate limit counter should be incremented. It defaults to the same as the rule’s expression.
Period of time in seconds after which the action will be disabled following its first execution.
The threshold of requests per period after which the action will be executed for the first time.
TransformResponseHTMLRule object { id, action, enabled, 10 more }
exposed_credential_check: optional object { password_expression, username_expression } Configuration for exposed credential checking.
Configuration for exposed credential checking.
ratelimit: optional object { characteristics, period, counting_expression, 5 more } An object configuring the rule’s rate limit behavior.
An object configuring the rule’s rate limit behavior.
Characteristics of the request on which the rate limit counter will be incremented.
An expression that defines when the rate limit counter should be incremented. It defaults to the same as the rule’s expression.
Period of time in seconds after which the action will be disabled following its first execution.
The threshold of requests per period after which the action will be executed for the first time.
PhasesVersions
List an account or zone entry point ruleset's versions
Get an account or zone entry point ruleset version
ModelsExpand Collapse
VersionGetResponse object { id, kind, last_updated, 5 more } A ruleset object.
A ruleset object.
rules: array of BlockRule { last_updated, version, id, 10 more } or object { id, action, enabled, 10 more } or CompressResponseRule { last_updated, version, id, 10 more } or 18 moreThe list of rules in the ruleset.
The list of rules in the ruleset.
ChallengeRule object { id, action, enabled, 10 more }
exposed_credential_check: optional object { password_expression, username_expression } Configuration for exposed credential checking.
Configuration for exposed credential checking.
ratelimit: optional object { characteristics, period, counting_expression, 5 more } An object configuring the rule’s rate limit behavior.
An object configuring the rule’s rate limit behavior.
Characteristics of the request on which the rate limit counter will be incremented.
An expression that defines when the rate limit counter should be incremented. It defaults to the same as the rule’s expression.
Period of time in seconds after which the action will be disabled following its first execution.
The threshold of requests per period after which the action will be executed for the first time.
JavaScriptChallengeRule object { id, action, enabled, 10 more }
exposed_credential_check: optional object { password_expression, username_expression } Configuration for exposed credential checking.
Configuration for exposed credential checking.
ratelimit: optional object { characteristics, period, counting_expression, 5 more } An object configuring the rule’s rate limit behavior.
An object configuring the rule’s rate limit behavior.
Characteristics of the request on which the rate limit counter will be incremented.
An expression that defines when the rate limit counter should be incremented. It defaults to the same as the rule’s expression.
Period of time in seconds after which the action will be disabled following its first execution.
The threshold of requests per period after which the action will be executed for the first time.
SetCacheControlRule object { id, action, enabled, 10 more }
action_parameters: optional object { immutable, "max-age", "must-revalidate", 10 more } The parameters configuring the rule’s action.
The parameters configuring the rule’s action.
immutable: optional object { operation, cloudflare_only } or object { operation, cloudflare_only } A cache-control directive configuration.
A cache-control directive configuration.
"max-age": optional object { operation, value, cloudflare_only } or object { operation, cloudflare_only } A cache-control directive configuration that accepts a duration value in seconds.
A cache-control directive configuration that accepts a duration value in seconds.
"must-revalidate": optional object { operation, cloudflare_only } or object { operation, cloudflare_only } A cache-control directive configuration.
A cache-control directive configuration.
"must-understand": optional object { operation, cloudflare_only } or object { operation, cloudflare_only } A cache-control directive configuration.
A cache-control directive configuration.
"no-cache": optional object { operation, cloudflare_only, qualifiers } or object { operation, cloudflare_only } A cache-control directive configuration that accepts optional qualifiers (header names).
A cache-control directive configuration that accepts optional qualifiers (header names).
"no-store": optional object { operation, cloudflare_only } or object { operation, cloudflare_only } A cache-control directive configuration.
A cache-control directive configuration.
"no-transform": optional object { operation, cloudflare_only } or object { operation, cloudflare_only } A cache-control directive configuration.
A cache-control directive configuration.
private: optional object { operation, cloudflare_only, qualifiers } or object { operation, cloudflare_only } A cache-control directive configuration that accepts optional qualifiers (header names).
A cache-control directive configuration that accepts optional qualifiers (header names).
"proxy-revalidate": optional object { operation, cloudflare_only } or object { operation, cloudflare_only } A cache-control directive configuration.
A cache-control directive configuration.
public: optional object { operation, cloudflare_only } or object { operation, cloudflare_only } A cache-control directive configuration.
A cache-control directive configuration.
"s-maxage": optional object { operation, value, cloudflare_only } or object { operation, cloudflare_only } A cache-control directive configuration that accepts a duration value in seconds.
A cache-control directive configuration that accepts a duration value in seconds.
"stale-if-error": optional object { operation, value, cloudflare_only } or object { operation, cloudflare_only } A cache-control directive configuration that accepts a duration value in seconds.
A cache-control directive configuration that accepts a duration value in seconds.
"stale-while-revalidate": optional object { operation, value, cloudflare_only } or object { operation, cloudflare_only } A cache-control directive configuration that accepts a duration value in seconds.
A cache-control directive configuration that accepts a duration value in seconds.
exposed_credential_check: optional object { password_expression, username_expression } Configuration for exposed credential checking.
Configuration for exposed credential checking.
ratelimit: optional object { characteristics, period, counting_expression, 5 more } An object configuring the rule’s rate limit behavior.
An object configuring the rule’s rate limit behavior.
Characteristics of the request on which the rate limit counter will be incremented.
An expression that defines when the rate limit counter should be incremented. It defaults to the same as the rule’s expression.
Period of time in seconds after which the action will be disabled following its first execution.
The threshold of requests per period after which the action will be executed for the first time.
SetCacheTagsRule object { id, action, enabled, 10 more }
action_parameters: optional object { operation, values } or object { expression, operation } or object { operation, values } or 3 moreThe parameters configuring the rule’s action.
The parameters configuring the rule’s action.
exposed_credential_check: optional object { password_expression, username_expression } Configuration for exposed credential checking.
Configuration for exposed credential checking.
ratelimit: optional object { characteristics, period, counting_expression, 5 more } An object configuring the rule’s rate limit behavior.
An object configuring the rule’s rate limit behavior.
Characteristics of the request on which the rate limit counter will be incremented.
An expression that defines when the rate limit counter should be incremented. It defaults to the same as the rule’s expression.
Period of time in seconds after which the action will be disabled following its first execution.
The threshold of requests per period after which the action will be executed for the first time.
TransformResponseHTMLRule object { id, action, enabled, 10 more }
exposed_credential_check: optional object { password_expression, username_expression } Configuration for exposed credential checking.
Configuration for exposed credential checking.
ratelimit: optional object { characteristics, period, counting_expression, 5 more } An object configuring the rule’s rate limit behavior.
An object configuring the rule’s rate limit behavior.
Characteristics of the request on which the rate limit counter will be incremented.
An expression that defines when the rate limit counter should be incremented. It defaults to the same as the rule’s expression.
Period of time in seconds after which the action will be disabled following its first execution.
The threshold of requests per period after which the action will be executed for the first time.