---
title: Rules
---

[Skip to content](#_top)

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

[RUM](https://developers.cloudflare.com/api/typescript/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/typescript/resources/rum/subresources/rules/methods/list)

client.rum.rules.list(stringrulesetID, RuleListParams {account\_id } params, RequestOptionsoptions?): [RuleListResponse](<https://developers.cloudflare.com/api/typescript/resources/rum#(resource)%20rum.rules%20%3E%20(model)%20rule_list_response%20%3E%20(schema)>) {rules, ruleset }

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

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

client.rum.rules.create(stringrulesetID, RuleCreateParams {account\_id, host, inclusive, 2 more } params, RequestOptionsoptions?): [RUMRule](<https://developers.cloudflare.com/api/typescript/resources/rum#(resource)%20rum.rules%20%3E%20(model)%20rum_rule%20%3E%20(schema)>) {id, created, host, 4 more }

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

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

client.rum.rules.update(stringruleID, RuleUpdateParams {account\_id, ruleset\_id, host, 3 more } params, RequestOptionsoptions?): [RUMRule](<https://developers.cloudflare.com/api/typescript/resources/rum#(resource)%20rum.rules%20%3E%20(model)%20rum_rule%20%3E%20(schema)>) {id, created, host, 4 more }

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

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

client.rum.rules.delete(stringruleID, RuleDeleteParams {account\_id, ruleset\_id } params, RequestOptionsoptions?): [RuleDeleteResponse](<https://developers.cloudflare.com/api/typescript/resources/rum#(resource)%20rum.rules%20%3E%20(model)%20rule_delete_response%20%3E%20(schema)>) {id }

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

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

client.rum.rules.bulkCreate(stringrulesetID, RuleBulkCreateParams {account\_id, delete\_rules, rules } params, RequestOptionsoptions?): [RuleBulkCreateResponse](<https://developers.cloudflare.com/api/typescript/resources/rum#(resource)%20rum.rules%20%3E%20(model)%20rule_bulk_create_response%20%3E%20(schema)>) {rules, ruleset }

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

##### ModelsExpand Collapse

<details>

<summary>

RUMRule {id, created, host, 4 more }

</summary>

id?: string

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?: string

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?: string

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?: boolean

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?: boolean

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?: Array&lt;string&gt;

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?: number

<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>

RuleListResponse {rules, ruleset }

</summary>

<details>

<summary>

rules?: Array&lt;<a href="https://developers.cloudflare.com/api/typescript/resources/rum#(resource)%20rum.rules%20%3E%20(model)%20rum_rule%20%3E%20(schema)">RUMRule</a> {id, created, host, 4 more } &gt;

A list of rules.

</summary>

id?: string

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?: string

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?: string

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?: boolean

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?: boolean

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?: Array&lt;string&gt;

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?: number

<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?: Ruleset {id, enabled, zone\_name, zone\_tag }

</summary>

id?: string

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?: boolean

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?: string

<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?: string

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>

RuleDeleteResponse {id }

</summary>

id?: string

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>

RuleBulkCreateResponse {rules, ruleset }

</summary>

<details>

<summary>

rules?: Array&lt;<a href="https://developers.cloudflare.com/api/typescript/resources/rum#(resource)%20rum.rules%20%3E%20(model)%20rum_rule%20%3E%20(schema)">RUMRule</a> {id, created, host, 4 more } &gt;

A list of rules.

</summary>

id?: string

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?: string

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?: string

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?: boolean

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?: boolean

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?: Array&lt;string&gt;

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?: number

<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?: Ruleset {id, enabled, zone\_name, zone\_tag }

</summary>

id?: string

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?: boolean

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?: string

<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?: string

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)>)