--- title: Get an account or zone ruleset --- [Skip to content](#_top) [API Reference](https://developers.cloudflare.com/api/python) [Rulesets](https://developers.cloudflare.com/api/python/resources/rulesets) Copy Markdown Open in **Claude**Open in **ChatGPT**Open in **Cursor** --- **Copy Markdown****View as Markdown** # Get an account or zone ruleset rulesets.get(strruleset\_id, RulesetGetParams\*\*kwargs) -> [RulesetGetResponse]() GET/{accounts\_or\_zones}/{account\_or\_zone\_id}/rulesets/{ruleset\_id} Fetches the latest version of an account or zone ruleset. ##### Security
API Token The preferred authorization scheme for interacting with the Cloudflare API. Create a token. **Example:**Authorization: Bearer Sn3lZJTBX6kkg7OdcBUAxOO963GEIyGQqnFTOFYY
API Email + API Key The previous authorization scheme for interacting with the Cloudflare API, used in conjunction with a Global API key. **Example:**X-Auth-Email: user@example.com The previous authorization scheme for interacting with the Cloudflare API. When possible, use API tokens instead of Global API keys. **Example:**X-Auth-Key: 144c9defac04969c7bfad8efaa8ea194
##### Accepted Permissions (at least one required) `Mass URL Redirects Write``Mass URL Redirects Read``Magic Firewall Write``Magic Firewall Read``L4 DDoS Managed Ruleset Write``L4 DDoS Managed Ruleset Read``Transform Rules Write``Transform Rules Read``Select Configuration Write``Select Configuration Read``Account WAF Write``Account WAF Read``Account Rulesets Read``Account Rulesets Write``Logs Write``Logs Read` ##### ParametersExpand Collapse ruleset\_id: str The unique ID of the ruleset. [Link to this property](<#(resource)%20rulesets%20%3E%20(method)%20get%20%3E%20(params)%20default%20%3E%20(param)%20ruleset_id%20%3E%20(schema)>) account\_id: Optional\[str] The Account ID to use for this endpoint. Mutually exclusive with the Zone ID. [Link to this property](<#(resource)%20rulesets%20%3E%20(method)%20get%20%3E%20(params)%20default%20%3E%20(param)%20account_id%20%3E%20(schema)>) zone\_id: Optional\[str] The Zone ID to use for this endpoint. Mutually exclusive with the Account ID. [Link to this property](<#(resource)%20rulesets%20%3E%20(method)%20get%20%3E%20(params)%20default%20%3E%20(param)%20zone_id%20%3E%20(schema)>) ##### ReturnsExpand Collapse
class RulesetGetResponse: … A ruleset object. id: str The unique ID of the ruleset. Link to this property
kind: Kind The kind of the ruleset. One of the following: "managed" Link to this property "custom" Link to this property "root" Link to this property "zone" Link to this property
Link to this property last\_updated: datetime The timestamp of when the ruleset was last modified. formatdate-time Link to this property name: str The human-readable name of the ruleset. minLength1 Link to this property
phase: Phase The phase of the ruleset. One of the following: "ddos\_l4" Link to this property "ddos\_l7" Link to this property "http\_config\_settings" Link to this property "http\_custom\_errors" Link to this property "http\_log\_custom\_fields" Link to this property "http\_ratelimit" Link to this property "http\_request\_cache\_settings" Link to this property "http\_request\_dynamic\_redirect" Link to this property "http\_request\_firewall\_custom" Link to this property "http\_request\_firewall\_managed" Link to this property "http\_request\_late\_transform" Link to this property "http\_request\_origin" Link to this property "http\_request\_redirect" Link to this property "http\_request\_sanitize" Link to this property "http\_request\_sbfm" Link to this property "http\_request\_transform" Link to this property "http\_response\_cache\_settings" Link to this property "http\_response\_compression" Link to this property "http\_response\_firewall\_managed" Link to this property "http\_response\_headers\_transform" Link to this property "magic\_transit" Link to this property "magic\_transit\_ids\_managed" Link to this property "magic\_transit\_managed" Link to this property "magic\_transit\_ratelimit" Link to this property
Link to this property
rules: List\[Rule] The list of rules in the ruleset. One of the following:
class RuleBlockRule: … id: str Link to this property action: str Link to this property enabled: bool Link to this property expression: str Link to this property ref: str Link to this property
Link to this property
class RuleChallengeRule: … id: str The unique ID of the rule. Link to this property action: Literal\["challenge"] The action to perform when the rule matches. Link to this property enabled: bool Whether the rule should be executed. Link to this property expression: str The expression defining which traffic will match the rule. minLength1 Link to this property last\_updated: datetime The timestamp of when the rule was last modified. formatdate-time Link to this property ref: str The reference of the rule (the rule’s ID by default). minLength1 Link to this property version: str The version of the rule. Link to this property action\_parameters: Optional\[object] The parameters configuring the rule’s action. Link to this property categories: Optional\[List\[str]] The categories of the rule. Link to this property description: Optional\[str] An informative description of the rule. Link to this property
exposed\_credential\_check: Optional\[RuleChallengeRuleExposedCredentialCheck] Configuration for exposed credential checking. password\_expression: str An expression that selects the password used in the credentials check. minLength1 Link to this property username\_expression: str An expression that selects the user ID used in the credentials check. minLength1 Link to this property
Link to this property
logging: Optional\[Logging] An object configuring the rule’s logging behavior. enabled: bool Whether to generate a log when the rule matches. Link to this property
Link to this property
ratelimit: Optional\[RuleChallengeRuleRatelimit] An object configuring the rule’s rate limit behavior. characteristics: List\[str] Characteristics of the request on which the rate limit counter will be incremented. Link to this property period: int Period in seconds over which the counter is being incremented. minimum0 Link to this property counting\_expression: Optional\[str] An expression that defines when the rate limit counter should be incremented. It defaults to the same as the rule’s expression. minLength1 Link to this property mitigation\_timeout: Optional\[int] Period of time in seconds after which the action will be disabled following its first execution. Link to this property requests\_per\_period: Optional\[int] The threshold of requests per period after which the action will be executed for the first time. minimum1 Link to this property requests\_to\_origin: Optional\[bool] Whether counting is only performed when an origin is reached. Link to this property score\_per\_period: Optional\[int] The score threshold per period for which the action will be executed the first time. Link to this property score\_response\_header\_name: Optional\[str] A response header name provided by the origin, which contains the score to increment rate limit counter with. minLength1 Link to this property
Link to this property
Link to this property
class RuleResponseCompressionRule: … id: str Link to this property action: str Link to this property enabled: bool Link to this property expression: str Link to this property ref: str Link to this property
Link to this property
class RuleDDoSDynamicRule: … id: str Link to this property action: str Link to this property enabled: bool Link to this property expression: str Link to this property ref: str Link to this property
Link to this property
class RuleExecuteRule: … id: str Link to this property action: str Link to this property enabled: bool Link to this property expression: str Link to this property ref: str Link to this property
Link to this property
class RuleForceConnectionCloseRule: … id: str Link to this property action: str Link to this property enabled: bool Link to this property expression: str Link to this property ref: str Link to this property
Link to this property
class RuleJavaScriptChallengeRule: … id: str The unique ID of the rule. Link to this property action: Literal\["js\_challenge"] The action to perform when the rule matches. Link to this property enabled: bool Whether the rule should be executed. Link to this property expression: str The expression defining which traffic will match the rule. minLength1 Link to this property last\_updated: datetime The timestamp of when the rule was last modified. formatdate-time Link to this property ref: str The reference of the rule (the rule’s ID by default). minLength1 Link to this property version: str The version of the rule. Link to this property action\_parameters: Optional\[object] The parameters configuring the rule’s action. Link to this property categories: Optional\[List\[str]] The categories of the rule. Link to this property description: Optional\[str] An informative description of the rule. Link to this property
exposed\_credential\_check: Optional\[RuleJavaScriptChallengeRuleExposedCredentialCheck] Configuration for exposed credential checking. password\_expression: str An expression that selects the password used in the credentials check. minLength1 Link to this property username\_expression: str An expression that selects the user ID used in the credentials check. minLength1 Link to this property
Link to this property
logging: Optional\[Logging] An object configuring the rule’s logging behavior. enabled: bool Whether to generate a log when the rule matches. Link to this property
Link to this property
ratelimit: Optional\[RuleJavaScriptChallengeRuleRatelimit] An object configuring the rule’s rate limit behavior. characteristics: List\[str] Characteristics of the request on which the rate limit counter will be incremented. Link to this property period: int Period in seconds over which the counter is being incremented. minimum0 Link to this property counting\_expression: Optional\[str] An expression that defines when the rate limit counter should be incremented. It defaults to the same as the rule’s expression. minLength1 Link to this property mitigation\_timeout: Optional\[int] Period of time in seconds after which the action will be disabled following its first execution. Link to this property requests\_per\_period: Optional\[int] The threshold of requests per period after which the action will be executed for the first time. minimum1 Link to this property requests\_to\_origin: Optional\[bool] Whether counting is only performed when an origin is reached. Link to this property score\_per\_period: Optional\[int] The score threshold per period for which the action will be executed the first time. Link to this property score\_response\_header\_name: Optional\[str] A response header name provided by the origin, which contains the score to increment rate limit counter with. minLength1 Link to this property
Link to this property
Link to this property
class RuleLogRule: … id: str Link to this property action: str Link to this property enabled: bool Link to this property expression: str Link to this property ref: str Link to this property
Link to this property
class RuleLogCustomFieldRule: … id: str Link to this property action: str Link to this property enabled: bool Link to this property expression: str Link to this property ref: str Link to this property
Link to this property
class RuleManagedChallengeRule: … id: str Link to this property action: str Link to this property enabled: bool Link to this property expression: str Link to this property ref: str Link to this property
Link to this property
class RuleRedirectRule: … id: str Link to this property action: str Link to this property enabled: bool Link to this property expression: str Link to this property ref: str Link to this property
Link to this property
class RuleRewriteRule: … id: str Link to this property action: str Link to this property enabled: bool Link to this property expression: str Link to this property ref: str Link to this property
Link to this property
class RuleRouteRule: … id: str Link to this property action: str Link to this property enabled: bool Link to this property expression: str Link to this property ref: str Link to this property
Link to this property
class RuleScoreRule: … id: str Link to this property action: str Link to this property enabled: bool Link to this property expression: str Link to this property ref: str Link to this property
Link to this property
class RuleServeErrorRule: … id: str Link to this property action: str Link to this property enabled: bool Link to this property expression: str Link to this property ref: str Link to this property
Link to this property
class RuleSetCacheControlRule: … id: str The unique ID of the rule. Link to this property action: Literal\["set\_cache\_control"] The action to perform when the rule matches. Link to this property enabled: bool Link to this property expression: str The expression defining which traffic will match the rule. minLength1 Link to this property last\_updated: datetime The timestamp of when the rule was last modified. formatdate-time Link to this property ref: str The reference of the rule (the rule’s ID by default). minLength1 Link to this property version: str The version of the rule. Link to this property
action\_parameters: Optional\[RuleSetCacheControlRuleActionParameters] The parameters configuring the rule’s action.
immutable: Optional\[RuleSetCacheControlRuleActionParametersImmutable] A cache-control directive configuration. One of the following:
class RuleSetCacheControlRuleActionParametersImmutableSetDirective: … Set the directive.
operation: Literal\["set", "remove"] The operation to perform on the cache-control directive. One of the following: "set" Link to this property "remove" Link to this property
Link to this property cloudflare\_only: Optional\[bool] Whether the directive should only be applied to the Cloudflare CDN cache. Link to this property
Link to this property
class RuleSetCacheControlRuleActionParametersImmutableRemoveDirective: … Remove the directive.
operation: Literal\["set", "remove"] The operation to perform on the cache-control directive. One of the following: "set" Link to this property "remove" Link to this property
Link to this property cloudflare\_only: Optional\[bool] Whether the directive should only be applied to the Cloudflare CDN cache. Link to this property
Link to this property
Link to this property
max\_age: Optional\[RuleSetCacheControlRuleActionParametersMaxAge] A cache-control directive configuration that accepts a duration value in seconds. One of the following:
class RuleSetCacheControlRuleActionParametersMaxAgeSetDirective: … Set the directive with a duration value in seconds.
operation: Literal\["set", "remove"] The operation to perform on the cache-control directive. One of the following: "set" Link to this property "remove" Link to this property
Link to this property value: int The duration value in seconds for the directive. minimum0 Link to this property cloudflare\_only: Optional\[bool] Whether the directive should only be applied to the Cloudflare CDN cache. Link to this property
Link to this property
class RuleSetCacheControlRuleActionParametersMaxAgeRemoveDirective: … Remove the directive.
operation: Literal\["set", "remove"] The operation to perform on the cache-control directive. One of the following: "set" Link to this property "remove" Link to this property
Link to this property cloudflare\_only: Optional\[bool] Whether the directive should only be applied to the Cloudflare CDN cache. Link to this property
Link to this property
Link to this property
must\_revalidate: Optional\[RuleSetCacheControlRuleActionParametersMustRevalidate] A cache-control directive configuration. One of the following:
class RuleSetCacheControlRuleActionParametersMustRevalidateSetDirective: … Set the directive.
operation: Literal\["set", "remove"] The operation to perform on the cache-control directive. One of the following: "set" Link to this property "remove" Link to this property
Link to this property cloudflare\_only: Optional\[bool] Whether the directive should only be applied to the Cloudflare CDN cache. Link to this property
Link to this property
class RuleSetCacheControlRuleActionParametersMustRevalidateRemoveDirective: … Remove the directive.
operation: Literal\["set", "remove"] The operation to perform on the cache-control directive. One of the following: "set" Link to this property "remove" Link to this property
Link to this property cloudflare\_only: Optional\[bool] Whether the directive should only be applied to the Cloudflare CDN cache. Link to this property
Link to this property
Link to this property
must\_understand: Optional\[RuleSetCacheControlRuleActionParametersMustUnderstand] A cache-control directive configuration. One of the following:
class RuleSetCacheControlRuleActionParametersMustUnderstandSetDirective: … Set the directive.
operation: Literal\["set", "remove"] The operation to perform on the cache-control directive. One of the following: "set" Link to this property "remove" Link to this property
Link to this property cloudflare\_only: Optional\[bool] Whether the directive should only be applied to the Cloudflare CDN cache. Link to this property
Link to this property
class RuleSetCacheControlRuleActionParametersMustUnderstandRemoveDirective: … Remove the directive.
operation: Literal\["set", "remove"] The operation to perform on the cache-control directive. One of the following: "set" Link to this property "remove" Link to this property
Link to this property cloudflare\_only: Optional\[bool] Whether the directive should only be applied to the Cloudflare CDN cache. Link to this property
Link to this property
Link to this property
no\_cache: Optional\[RuleSetCacheControlRuleActionParametersNoCache] A cache-control directive configuration that accepts optional qualifiers (header names). One of the following:
class RuleSetCacheControlRuleActionParametersNoCacheSetDirective: … Set the directive with optional qualifiers.
operation: Literal\["set", "remove"] The operation to perform on the cache-control directive. One of the following: "set" Link to this property "remove" Link to this property
Link to this property cloudflare\_only: Optional\[bool] Whether the directive should only be applied to the Cloudflare CDN cache. Link to this property qualifiers: Optional\[List\[str]] Optional list of header names to qualify the directive (e.g., for “private” or “no-cache” directives). Link to this property
Link to this property
class RuleSetCacheControlRuleActionParametersNoCacheRemoveDirective: … Remove the directive.
operation: Literal\["set", "remove"] The operation to perform on the cache-control directive. One of the following: "set" Link to this property "remove" Link to this property
Link to this property cloudflare\_only: Optional\[bool] Whether the directive should only be applied to the Cloudflare CDN cache. Link to this property
Link to this property
Link to this property
no\_store: Optional\[RuleSetCacheControlRuleActionParametersNoStore] A cache-control directive configuration. One of the following:
class RuleSetCacheControlRuleActionParametersNoStoreSetDirective: … Set the directive.
operation: Literal\["set", "remove"] The operation to perform on the cache-control directive. One of the following: "set" Link to this property "remove" Link to this property
Link to this property cloudflare\_only: Optional\[bool] Whether the directive should only be applied to the Cloudflare CDN cache. Link to this property
Link to this property
class RuleSetCacheControlRuleActionParametersNoStoreRemoveDirective: … Remove the directive.
operation: Literal\["set", "remove"] The operation to perform on the cache-control directive. One of the following: "set" Link to this property "remove" Link to this property
Link to this property cloudflare\_only: Optional\[bool] Whether the directive should only be applied to the Cloudflare CDN cache. Link to this property
Link to this property
Link to this property
no\_transform: Optional\[RuleSetCacheControlRuleActionParametersNoTransform] A cache-control directive configuration. One of the following:
class RuleSetCacheControlRuleActionParametersNoTransformSetDirective: … Set the directive.
operation: Literal\["set", "remove"] The operation to perform on the cache-control directive. One of the following: "set" Link to this property "remove" Link to this property
Link to this property cloudflare\_only: Optional\[bool] Whether the directive should only be applied to the Cloudflare CDN cache. Link to this property
Link to this property
class RuleSetCacheControlRuleActionParametersNoTransformRemoveDirective: … Remove the directive.
operation: Literal\["set", "remove"] The operation to perform on the cache-control directive. One of the following: "set" Link to this property "remove" Link to this property
Link to this property cloudflare\_only: Optional\[bool] Whether the directive should only be applied to the Cloudflare CDN cache. Link to this property
Link to this property
Link to this property
private: Optional\[RuleSetCacheControlRuleActionParametersPrivate] A cache-control directive configuration that accepts optional qualifiers (header names). One of the following:
class RuleSetCacheControlRuleActionParametersPrivateSetDirective: … Set the directive with optional qualifiers.
operation: Literal\["set", "remove"] The operation to perform on the cache-control directive. One of the following: "set" Link to this property "remove" Link to this property
Link to this property cloudflare\_only: Optional\[bool] Whether the directive should only be applied to the Cloudflare CDN cache. Link to this property qualifiers: Optional\[List\[str]] Optional list of header names to qualify the directive (e.g., for “private” or “no-cache” directives). Link to this property
Link to this property
class RuleSetCacheControlRuleActionParametersPrivateRemoveDirective: … Remove the directive.
operation: Literal\["set", "remove"] The operation to perform on the cache-control directive. One of the following: "set" Link to this property "remove" Link to this property
Link to this property cloudflare\_only: Optional\[bool] Whether the directive should only be applied to the Cloudflare CDN cache. Link to this property
Link to this property
Link to this property
proxy\_revalidate: Optional\[RuleSetCacheControlRuleActionParametersProxyRevalidate] A cache-control directive configuration. One of the following:
class RuleSetCacheControlRuleActionParametersProxyRevalidateSetDirective: … Set the directive.
operation: Literal\["set", "remove"] The operation to perform on the cache-control directive. One of the following: "set" Link to this property "remove" Link to this property
Link to this property cloudflare\_only: Optional\[bool] Whether the directive should only be applied to the Cloudflare CDN cache. Link to this property
Link to this property
class RuleSetCacheControlRuleActionParametersProxyRevalidateRemoveDirective: … Remove the directive.
operation: Literal\["set", "remove"] The operation to perform on the cache-control directive. One of the following: "set" Link to this property "remove" Link to this property
Link to this property cloudflare\_only: Optional\[bool] Whether the directive should only be applied to the Cloudflare CDN cache. Link to this property
Link to this property
Link to this property
public: Optional\[RuleSetCacheControlRuleActionParametersPublic] A cache-control directive configuration. One of the following:
class RuleSetCacheControlRuleActionParametersPublicSetDirective: … Set the directive.
operation: Literal\["set", "remove"] The operation to perform on the cache-control directive. One of the following: "set" Link to this property "remove" Link to this property
Link to this property cloudflare\_only: Optional\[bool] Whether the directive should only be applied to the Cloudflare CDN cache. Link to this property
Link to this property
class RuleSetCacheControlRuleActionParametersPublicRemoveDirective: … Remove the directive.
operation: Literal\["set", "remove"] The operation to perform on the cache-control directive. One of the following: "set" Link to this property "remove" Link to this property
Link to this property cloudflare\_only: Optional\[bool] Whether the directive should only be applied to the Cloudflare CDN cache. Link to this property
Link to this property
Link to this property
s\_maxage: Optional\[RuleSetCacheControlRuleActionParametersSMaxage] A cache-control directive configuration that accepts a duration value in seconds. One of the following:
class RuleSetCacheControlRuleActionParametersSMaxageSetDirective: … Set the directive with a duration value in seconds.
operation: Literal\["set", "remove"] The operation to perform on the cache-control directive. One of the following: "set" Link to this property "remove" Link to this property
Link to this property value: int The duration value in seconds for the directive. minimum0 Link to this property cloudflare\_only: Optional\[bool] Whether the directive should only be applied to the Cloudflare CDN cache. Link to this property
Link to this property
class RuleSetCacheControlRuleActionParametersSMaxageRemoveDirective: … Remove the directive.
operation: Literal\["set", "remove"] The operation to perform on the cache-control directive. One of the following: "set" Link to this property "remove" Link to this property
Link to this property cloudflare\_only: Optional\[bool] Whether the directive should only be applied to the Cloudflare CDN cache. Link to this property
Link to this property
Link to this property
stale\_if\_error: Optional\[RuleSetCacheControlRuleActionParametersStaleIfError] A cache-control directive configuration that accepts a duration value in seconds. One of the following:
class RuleSetCacheControlRuleActionParametersStaleIfErrorSetDirective: … Set the directive with a duration value in seconds.
operation: Literal\["set", "remove"] The operation to perform on the cache-control directive. One of the following: "set" Link to this property "remove" Link to this property
Link to this property value: int The duration value in seconds for the directive. minimum0 Link to this property cloudflare\_only: Optional\[bool] Whether the directive should only be applied to the Cloudflare CDN cache. Link to this property
Link to this property
class RuleSetCacheControlRuleActionParametersStaleIfErrorRemoveDirective: … Remove the directive.
operation: Literal\["set", "remove"] The operation to perform on the cache-control directive. One of the following: "set" Link to this property "remove" Link to this property
Link to this property cloudflare\_only: Optional\[bool] Whether the directive should only be applied to the Cloudflare CDN cache. Link to this property
Link to this property
Link to this property
stale\_while\_revalidate: Optional\[RuleSetCacheControlRuleActionParametersStaleWhileRevalidate] A cache-control directive configuration that accepts a duration value in seconds. One of the following:
class RuleSetCacheControlRuleActionParametersStaleWhileRevalidateSetDirective: … Set the directive with a duration value in seconds.
operation: Literal\["set", "remove"] The operation to perform on the cache-control directive. One of the following: "set" Link to this property "remove" Link to this property
Link to this property value: int The duration value in seconds for the directive. minimum0 Link to this property cloudflare\_only: Optional\[bool] Whether the directive should only be applied to the Cloudflare CDN cache. Link to this property
Link to this property
class RuleSetCacheControlRuleActionParametersStaleWhileRevalidateRemoveDirective: … Remove the directive.
operation: Literal\["set", "remove"] The operation to perform on the cache-control directive. One of the following: "set" Link to this property "remove" Link to this property
Link to this property cloudflare\_only: Optional\[bool] Whether the directive should only be applied to the Cloudflare CDN cache. Link to this property
Link to this property
Link to this property
Link to this property categories: Optional\[List\[str]] The categories of the rule. Link to this property description: Optional\[str] An informative description of the rule. Link to this property
exposed\_credential\_check: Optional\[RuleSetCacheControlRuleExposedCredentialCheck] Configuration for exposed credential checking. password\_expression: str An expression that selects the password used in the credentials check. minLength1 Link to this property username\_expression: str An expression that selects the user ID used in the credentials check. minLength1 Link to this property
Link to this property
logging: Optional\[Logging] An object configuring the rule’s logging behavior. enabled: bool Whether to generate a log when the rule matches. Link to this property
Link to this property
ratelimit: Optional\[RuleSetCacheControlRuleRatelimit] An object configuring the rule’s rate limit behavior. characteristics: List\[str] Characteristics of the request on which the rate limit counter will be incremented. Link to this property period: int Period in seconds over which the counter is being incremented. minimum0 Link to this property counting\_expression: Optional\[str] An expression that defines when the rate limit counter should be incremented. It defaults to the same as the rule’s expression. minLength1 Link to this property mitigation\_timeout: Optional\[int] Period of time in seconds after which the action will be disabled following its first execution. Link to this property requests\_per\_period: Optional\[int] The threshold of requests per period after which the action will be executed for the first time. minimum1 Link to this property requests\_to\_origin: Optional\[bool] Whether counting is only performed when an origin is reached. Link to this property score\_per\_period: Optional\[int] The score threshold per period for which the action will be executed the first time. Link to this property score\_response\_header\_name: Optional\[str] A response header name provided by the origin, which contains the score to increment rate limit counter with. minLength1 Link to this property
Link to this property
Link to this property
class RuleSetCacheSettingsRule: … id: str Link to this property action: str Link to this property enabled: bool Link to this property expression: str Link to this property ref: str Link to this property
Link to this property
class RuleSetCacheTagsRule: … id: str The unique ID of the rule. Link to this property action: Literal\["set\_cache\_tags"] The action to perform when the rule matches. Link to this property enabled: bool Link to this property expression: str The expression defining which traffic will match the rule. minLength1 Link to this property last\_updated: datetime The timestamp of when the rule was last modified. formatdate-time Link to this property ref: str The reference of the rule (the rule’s ID by default). minLength1 Link to this property version: str The version of the rule. Link to this property
action\_parameters: Optional\[RuleSetCacheTagsRuleActionParameters] The parameters configuring the rule’s action. One of the following:
class RuleSetCacheTagsRuleActionParametersAddCacheTagsValues: … Add cache tags using a list of values.
operation: Literal\["add", "remove", "set"] The operation to perform on the cache tags. One of the following: "add" Link to this property "remove" Link to this property "set" Link to this property
Link to this property values: List\[str] A list of cache tag values. Link to this property
Link to this property
class RuleSetCacheTagsRuleActionParametersAddCacheTagsExpression: … Add cache tags using an expression. expression: str An expression that evaluates to an array of cache tag values. minLength1 Link to this property
operation: Literal\["add", "remove", "set"] The operation to perform on the cache tags. One of the following: "add" Link to this property "remove" Link to this property "set" Link to this property
Link to this property
Link to this property
class RuleSetCacheTagsRuleActionParametersRemoveCacheTagsValues: … Remove cache tags using a list of values.
operation: Literal\["add", "remove", "set"] The operation to perform on the cache tags. One of the following: "add" Link to this property "remove" Link to this property "set" Link to this property
Link to this property values: List\[str] A list of cache tag values. Link to this property
Link to this property
class RuleSetCacheTagsRuleActionParametersRemoveCacheTagsExpression: … Remove cache tags using an expression. expression: str An expression that evaluates to an array of cache tag values. minLength1 Link to this property
operation: Literal\["add", "remove", "set"] The operation to perform on the cache tags. One of the following: "add" Link to this property "remove" Link to this property "set" Link to this property
Link to this property
Link to this property
class RuleSetCacheTagsRuleActionParametersSetCacheTagsValues: … Set cache tags using a list of values.
operation: Literal\["add", "remove", "set"] The operation to perform on the cache tags. One of the following: "add" Link to this property "remove" Link to this property "set" Link to this property
Link to this property values: List\[str] A list of cache tag values. Link to this property
Link to this property
class RuleSetCacheTagsRuleActionParametersSetCacheTagsExpression: … Set cache tags using an expression. expression: str An expression that evaluates to an array of cache tag values. minLength1 Link to this property
operation: Literal\["add", "remove", "set"] The operation to perform on the cache tags. One of the following: "add" Link to this property "remove" Link to this property "set" Link to this property
Link to this property
Link to this property
Link to this property categories: Optional\[List\[str]] The categories of the rule. Link to this property description: Optional\[str] An informative description of the rule. Link to this property
exposed\_credential\_check: Optional\[RuleSetCacheTagsRuleExposedCredentialCheck] Configuration for exposed credential checking. password\_expression: str An expression that selects the password used in the credentials check. minLength1 Link to this property username\_expression: str An expression that selects the user ID used in the credentials check. minLength1 Link to this property
Link to this property
logging: Optional\[Logging] An object configuring the rule’s logging behavior. enabled: bool Whether to generate a log when the rule matches. Link to this property
Link to this property
ratelimit: Optional\[RuleSetCacheTagsRuleRatelimit] An object configuring the rule’s rate limit behavior. characteristics: List\[str] Characteristics of the request on which the rate limit counter will be incremented. Link to this property period: int Period in seconds over which the counter is being incremented. minimum0 Link to this property counting\_expression: Optional\[str] An expression that defines when the rate limit counter should be incremented. It defaults to the same as the rule’s expression. minLength1 Link to this property mitigation\_timeout: Optional\[int] Period of time in seconds after which the action will be disabled following its first execution. Link to this property requests\_per\_period: Optional\[int] The threshold of requests per period after which the action will be executed for the first time. minimum1 Link to this property requests\_to\_origin: Optional\[bool] Whether counting is only performed when an origin is reached. Link to this property score\_per\_period: Optional\[int] The score threshold per period for which the action will be executed the first time. Link to this property score\_response\_header\_name: Optional\[str] A response header name provided by the origin, which contains the score to increment rate limit counter with. minLength1 Link to this property
Link to this property
Link to this property
class RuleSetConfigurationRule: … id: str Link to this property action: str Link to this property enabled: bool Link to this property expression: str Link to this property ref: str Link to this property
Link to this property
class RuleSkipRule: … id: str Link to this property action: str Link to this property enabled: bool Link to this property expression: str Link to this property ref: str Link to this property
Link to this property
class RuleTransformResponseHTMLRule: … id: str The unique ID of the rule. Link to this property action: Literal\["transform\_response\_html"] The action to perform when the rule matches. Link to this property enabled: bool Link to this property expression: str The expression defining which traffic will match the rule. minLength1 Link to this property last\_updated: datetime The timestamp of when the rule was last modified. formatdate-time Link to this property ref: str The reference of the rule (the rule’s ID by default). minLength1 Link to this property version: str The version of the rule. Link to this property
action\_parameters: Optional\[RuleTransformResponseHTMLRuleActionParameters] The parameters configuring the rule’s action. link\_maze: object Enables the link maze transformation on the response. Link to this property
Link to this property categories: Optional\[List\[str]] The categories of the rule. Link to this property description: Optional\[str] An informative description of the rule. Link to this property
exposed\_credential\_check: Optional\[RuleTransformResponseHTMLRuleExposedCredentialCheck] Configuration for exposed credential checking. password\_expression: str An expression that selects the password used in the credentials check. minLength1 Link to this property username\_expression: str An expression that selects the user ID used in the credentials check. minLength1 Link to this property
Link to this property
logging: Optional\[Logging] An object configuring the rule’s logging behavior. enabled: bool Whether to generate a log when the rule matches. Link to this property
Link to this property
ratelimit: Optional\[RuleTransformResponseHTMLRuleRatelimit] An object configuring the rule’s rate limit behavior. characteristics: List\[str] Characteristics of the request on which the rate limit counter will be incremented. Link to this property period: int Period in seconds over which the counter is being incremented. minimum0 Link to this property counting\_expression: Optional\[str] An expression that defines when the rate limit counter should be incremented. It defaults to the same as the rule’s expression. minLength1 Link to this property mitigation\_timeout: Optional\[int] Period of time in seconds after which the action will be disabled following its first execution. Link to this property requests\_per\_period: Optional\[int] The threshold of requests per period after which the action will be executed for the first time. minimum1 Link to this property requests\_to\_origin: Optional\[bool] Whether counting is only performed when an origin is reached. Link to this property score\_per\_period: Optional\[int] The score threshold per period for which the action will be executed the first time. Link to this property score\_response\_header\_name: Optional\[str] A response header name provided by the origin, which contains the score to increment rate limit counter with. minLength1 Link to this property
Link to this property
Link to this property
Link to this property version: str The version of the ruleset. Link to this property description: Optional\[str] An informative description of the ruleset. Link to this property
[Link to this property](<#(resource)%20rulesets%20%3E%20(model)%20ruleset_get_response%20%3E%20(schema)>) ### Get an account or zone ruleset Python HTTPTypeScriptPythonGoTerraform ``` import os from cloudflare import Cloudflare client = Cloudflare( api_token=os.environ.get("CLOUDFLARE_API_TOKEN"), # This is the default and can be omitted ) ruleset = client.rulesets.get( ruleset_id="2f2feab2026849078ba485f918791bdc", account_id="account_id", ) print(ruleset.id) ``` 200 example ``` { "errors": [ { "message": "something bad happened", "code": 10000, "source": { "pointer": "/rules/0/action" } } ], "messages": [ { "message": "something bad happened", "code": 10000, "source": { "pointer": "/rules/0/action" } } ], "result": { "id": "2f2feab2026849078ba485f918791bdc", "kind": "root", "last_updated": "2000-01-01T00:00:00Z", "name": "My ruleset", "phase": "http_request_firewall_custom", "rules": [ { "last_updated": "2000-01-01T00:00:00Z", "version": "1", "id": "id", "action": "action", "action_parameters": { "response": { "content": "{\n \"success\": false,\n \"error\": \"you have been blocked\"\n}", "content_type": "application/json", "status_code": 400 } }, "categories": [ "directory-traversal" ], "description": "Block the request.", "enabled": true, "exposed_credential_check": { "password_expression": "url_decode(http.request.body.form[\\\"password\\\"][0])", "username_expression": "url_decode(http.request.body.form[\\\"username\\\"][0])" }, "expression": "expression", "logging": { "enabled": true }, "ratelimit": { "characteristics": [ "cf.colo.id" ], "period": 60, "counting_expression": "http.request.body.raw eq \"abcd\"", "mitigation_timeout": 600, "requests_per_period": 1000, "requests_to_origin": true, "score_per_period": 400, "score_response_header_name": "my-score" }, "ref": "ref" } ], "version": "1", "description": "A description for my ruleset." }, "success": true } ``` ##### Returns Examples 200 example ``` { "errors": [ { "message": "something bad happened", "code": 10000, "source": { "pointer": "/rules/0/action" } } ], "messages": [ { "message": "something bad happened", "code": 10000, "source": { "pointer": "/rules/0/action" } } ], "result": { "id": "2f2feab2026849078ba485f918791bdc", "kind": "root", "last_updated": "2000-01-01T00:00:00Z", "name": "My ruleset", "phase": "http_request_firewall_custom", "rules": [ { "last_updated": "2000-01-01T00:00:00Z", "version": "1", "id": "id", "action": "action", "action_parameters": { "response": { "content": "{\n \"success\": false,\n \"error\": \"you have been blocked\"\n}", "content_type": "application/json", "status_code": 400 } }, "categories": [ "directory-traversal" ], "description": "Block the request.", "enabled": true, "exposed_credential_check": { "password_expression": "url_decode(http.request.body.form[\\\"password\\\"][0])", "username_expression": "url_decode(http.request.body.form[\\\"username\\\"][0])" }, "expression": "expression", "logging": { "enabled": true }, "ratelimit": { "characteristics": [ "cf.colo.id" ], "period": 60, "counting_expression": "http.request.body.raw eq \"abcd\"", "mitigation_timeout": 600, "requests_per_period": 1000, "requests_to_origin": true, "score_per_period": 400, "score_response_header_name": "my-score" }, "ref": "ref" } ], "version": "1", "description": "A description for my ruleset." }, "success": true } ```