---
title: Rules
---

[Skip to content](#_top)

[API Reference](https://developers.cloudflare.com/api/python)

[RUM](https://developers.cloudflare.com/api/python/resources/rum)

Copy Markdown

Open in **Claude**Open in **ChatGPT**Open in **Cursor**

---

**Copy Markdown****View as Markdown**

# Rules

##### [List rules in Web Analytics ruleset](https://developers.cloudflare.com/api/python/resources/rum/subresources/rules/methods/list)

rum.rules.list(strruleset\_id, RuleListParams\*\*kwargs) -> [RuleListResponse](<https://developers.cloudflare.com/api/python/resources/rum#(resource)%20rum.rules%20%3E%20(model)%20rule_list_response%20%3E%20(schema)>)

GET/accounts/{account\_id}/rum/v2/{ruleset\_id}/rules

##### [Create a Web Analytics rule](https://developers.cloudflare.com/api/python/resources/rum/subresources/rules/methods/create)

rum.rules.create(strruleset\_id, RuleCreateParams\*\*kwargs) -> [RUMRule](<https://developers.cloudflare.com/api/python/resources/rum#(resource)%20rum.rules%20%3E%20(model)%20rum_rule%20%3E%20(schema)>)

POST/accounts/{account\_id}/rum/v2/{ruleset\_id}/rule

##### [Update a Web Analytics rule](https://developers.cloudflare.com/api/python/resources/rum/subresources/rules/methods/update)

rum.rules.update(strrule\_id, RuleUpdateParams\*\*kwargs) -> [RUMRule](<https://developers.cloudflare.com/api/python/resources/rum#(resource)%20rum.rules%20%3E%20(model)%20rum_rule%20%3E%20(schema)>)

PUT/accounts/{account\_id}/rum/v2/{ruleset\_id}/rule/{rule\_id}

##### [Delete a Web Analytics rule](https://developers.cloudflare.com/api/python/resources/rum/subresources/rules/methods/delete)

rum.rules.delete(strrule\_id, RuleDeleteParams\*\*kwargs) -> [RuleDeleteResponse](<https://developers.cloudflare.com/api/python/resources/rum#(resource)%20rum.rules%20%3E%20(model)%20rule_delete_response%20%3E%20(schema)>)

DELETE/accounts/{account\_id}/rum/v2/{ruleset\_id}/rule/{rule\_id}

##### [Update Web Analytics rules](https://developers.cloudflare.com/api/python/resources/rum/subresources/rules/methods/bulk_create)

rum.rules.bulk\_create(strruleset\_id, RuleBulkCreateParams\*\*kwargs) -> [RuleBulkCreateResponse](<https://developers.cloudflare.com/api/python/resources/rum#(resource)%20rum.rules%20%3E%20(model)%20rule_bulk_create_response%20%3E%20(schema)>)

POST/accounts/{account\_id}/rum/v2/{ruleset\_id}/rules

##### ModelsExpand Collapse

<details>

<summary>

class RUMRule: …

</summary>

id: Optional\[str]

The Web Analytics rule identifier.

<a href="#(resource)%20rum.rules%20%3E%20(model)%20rum_rule%20%3E%20(schema)%20%3E%20(property)%20id">Link to this property</a>

created: Optional\[datetime]

formatdate-time

<a href="#(resource)%20rum.rules%20%3E%20(model)%20rum_rule%20%3E%20(schema)%20%3E%20(property)%20created">Link to this property</a>

host: Optional\[str]

The hostname the rule will be applied to.

<a href="#(resource)%20rum.rules%20%3E%20(model)%20rum_rule%20%3E%20(schema)%20%3E%20(property)%20host">Link to this property</a>

inclusive: Optional\[bool]

Whether the rule includes or excludes traffic from being measured.

<a href="#(resource)%20rum.rules%20%3E%20(model)%20rum_rule%20%3E%20(schema)%20%3E%20(property)%20inclusive">Link to this property</a>

is\_paused: Optional\[bool]

Whether the rule is paused or not.

<a href="#(resource)%20rum.rules%20%3E%20(model)%20rum_rule%20%3E%20(schema)%20%3E%20(property)%20is_paused">Link to this property</a>

paths: Optional\[List\[str]]

The paths the rule will be applied to.

<a href="#(resource)%20rum.rules%20%3E%20(model)%20rum_rule%20%3E%20(schema)%20%3E%20(property)%20paths">Link to this property</a>

priority: Optional\[float]

<a href="#(resource)%20rum.rules%20%3E%20(model)%20rum_rule%20%3E%20(schema)%20%3E%20(property)%20priority">Link to this property</a>

</details>

[Link to this property](<#(resource)%20rum.rules%20%3E%20(model)%20rum_rule%20%3E%20(schema)>)

<details>

<summary>

class RuleListResponse: …

</summary>

<details>

<summary>

rules: Optional\[List\[<a href="https://developers.cloudflare.com/api/python/resources/rum#(resource)%20rum.rules%20%3E%20(model)%20rum_rule%20%3E%20(schema)">RUMRule</a>]]

A list of rules.

</summary>

id: Optional\[str]

The Web Analytics rule identifier.

<a href="#(resource)%20rum.rules%20%3E%20(model)%20rum_rule%20%3E%20(schema)%20%3E%20(property)%20id">Link to this property</a>

created: Optional\[datetime]

formatdate-time

<a href="#(resource)%20rum.rules%20%3E%20(model)%20rum_rule%20%3E%20(schema)%20%3E%20(property)%20created">Link to this property</a>

host: Optional\[str]

The hostname the rule will be applied to.

<a href="#(resource)%20rum.rules%20%3E%20(model)%20rum_rule%20%3E%20(schema)%20%3E%20(property)%20host">Link to this property</a>

inclusive: Optional\[bool]

Whether the rule includes or excludes traffic from being measured.

<a href="#(resource)%20rum.rules%20%3E%20(model)%20rum_rule%20%3E%20(schema)%20%3E%20(property)%20inclusive">Link to this property</a>

is\_paused: Optional\[bool]

Whether the rule is paused or not.

<a href="#(resource)%20rum.rules%20%3E%20(model)%20rum_rule%20%3E%20(schema)%20%3E%20(property)%20is_paused">Link to this property</a>

paths: Optional\[List\[str]]

The paths the rule will be applied to.

<a href="#(resource)%20rum.rules%20%3E%20(model)%20rum_rule%20%3E%20(schema)%20%3E%20(property)%20paths">Link to this property</a>

priority: Optional\[float]

<a href="#(resource)%20rum.rules%20%3E%20(model)%20rum_rule%20%3E%20(schema)%20%3E%20(property)%20priority">Link to this property</a>

</details>

<a href="#(resource)%20rum.rules%20%3E%20(model)%20rule_list_response%20%3E%20(schema)%20%3E%20(property)%20rules">Link to this property</a>

<details>

<summary>

ruleset: Optional\[Ruleset]

</summary>

id: Optional\[str]

The Web Analytics ruleset identifier.

<a href="#(resource)%20rum.rules%20%3E%20(model)%20rule_list_response%20%3E%20(schema)%20%3E%20(property)%20ruleset%20%3E%20(property)%20id">Link to this property</a>

enabled: Optional\[bool]

Whether the ruleset is enabled.

<a href="#(resource)%20rum.rules%20%3E%20(model)%20rule_list_response%20%3E%20(schema)%20%3E%20(property)%20ruleset%20%3E%20(property)%20enabled">Link to this property</a>

zone\_name: Optional\[str]

<a href="#(resource)%20rum.rules%20%3E%20(model)%20rule_list_response%20%3E%20(schema)%20%3E%20(property)%20ruleset%20%3E%20(property)%20zone_name">Link to this property</a>

zone\_tag: Optional\[str]

The zone identifier.

<a href="#(resource)%20rum.rules%20%3E%20(model)%20rule_list_response%20%3E%20(schema)%20%3E%20(property)%20ruleset%20%3E%20(property)%20zone_tag">Link to this property</a>

</details>

<a href="#(resource)%20rum.rules%20%3E%20(model)%20rule_list_response%20%3E%20(schema)%20%3E%20(property)%20ruleset">Link to this property</a>

</details>

[Link to this property](<#(resource)%20rum.rules%20%3E%20(model)%20rule_list_response%20%3E%20(schema)>)

<details>

<summary>

class RuleDeleteResponse: …

</summary>

id: Optional\[str]

The Web Analytics rule identifier.

<a href="#(resource)%20rum.rules%20%3E%20(model)%20rule_delete_response%20%3E%20(schema)%20%3E%20(property)%20id">Link to this property</a>

</details>

[Link to this property](<#(resource)%20rum.rules%20%3E%20(model)%20rule_delete_response%20%3E%20(schema)>)

<details>

<summary>

class RuleBulkCreateResponse: …

</summary>

<details>

<summary>

rules: Optional\[List\[<a href="https://developers.cloudflare.com/api/python/resources/rum#(resource)%20rum.rules%20%3E%20(model)%20rum_rule%20%3E%20(schema)">RUMRule</a>]]

A list of rules.

</summary>

id: Optional\[str]

The Web Analytics rule identifier.

<a href="#(resource)%20rum.rules%20%3E%20(model)%20rum_rule%20%3E%20(schema)%20%3E%20(property)%20id">Link to this property</a>

created: Optional\[datetime]

formatdate-time

<a href="#(resource)%20rum.rules%20%3E%20(model)%20rum_rule%20%3E%20(schema)%20%3E%20(property)%20created">Link to this property</a>

host: Optional\[str]

The hostname the rule will be applied to.

<a href="#(resource)%20rum.rules%20%3E%20(model)%20rum_rule%20%3E%20(schema)%20%3E%20(property)%20host">Link to this property</a>

inclusive: Optional\[bool]

Whether the rule includes or excludes traffic from being measured.

<a href="#(resource)%20rum.rules%20%3E%20(model)%20rum_rule%20%3E%20(schema)%20%3E%20(property)%20inclusive">Link to this property</a>

is\_paused: Optional\[bool]

Whether the rule is paused or not.

<a href="#(resource)%20rum.rules%20%3E%20(model)%20rum_rule%20%3E%20(schema)%20%3E%20(property)%20is_paused">Link to this property</a>

paths: Optional\[List\[str]]

The paths the rule will be applied to.

<a href="#(resource)%20rum.rules%20%3E%20(model)%20rum_rule%20%3E%20(schema)%20%3E%20(property)%20paths">Link to this property</a>

priority: Optional\[float]

<a href="#(resource)%20rum.rules%20%3E%20(model)%20rum_rule%20%3E%20(schema)%20%3E%20(property)%20priority">Link to this property</a>

</details>

<a href="#(resource)%20rum.rules%20%3E%20(model)%20rule_bulk_create_response%20%3E%20(schema)%20%3E%20(property)%20rules">Link to this property</a>

<details>

<summary>

ruleset: Optional\[Ruleset]

</summary>

id: Optional\[str]

The Web Analytics ruleset identifier.

<a href="#(resource)%20rum.rules%20%3E%20(model)%20rule_bulk_create_response%20%3E%20(schema)%20%3E%20(property)%20ruleset%20%3E%20(property)%20id">Link to this property</a>

enabled: Optional\[bool]

Whether the ruleset is enabled.

<a href="#(resource)%20rum.rules%20%3E%20(model)%20rule_bulk_create_response%20%3E%20(schema)%20%3E%20(property)%20ruleset%20%3E%20(property)%20enabled">Link to this property</a>

zone\_name: Optional\[str]

<a href="#(resource)%20rum.rules%20%3E%20(model)%20rule_bulk_create_response%20%3E%20(schema)%20%3E%20(property)%20ruleset%20%3E%20(property)%20zone_name">Link to this property</a>

zone\_tag: Optional\[str]

The zone identifier.

<a href="#(resource)%20rum.rules%20%3E%20(model)%20rule_bulk_create_response%20%3E%20(schema)%20%3E%20(property)%20ruleset%20%3E%20(property)%20zone_tag">Link to this property</a>

</details>

<a href="#(resource)%20rum.rules%20%3E%20(model)%20rule_bulk_create_response%20%3E%20(schema)%20%3E%20(property)%20ruleset">Link to this property</a>

</details>

[Link to this property](<#(resource)%20rum.rules%20%3E%20(model)%20rule_bulk_create_response%20%3E%20(schema)>)