---
title: Rules
---

[Skip to content](#_top)

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

[Token Validation](https://developers.cloudflare.com/api/typescript/resources/token_validation)

Copy Markdown

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

---

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

# Rules

##### [List token validation rules](https://developers.cloudflare.com/api/typescript/resources/token_validation/subresources/rules/methods/list)

client.tokenValidation.rules.list(RuleListParams {zone\_id, id, action, 7 more } params, RequestOptionsoptions?): V4PagePaginationArray< [TokenValidationRule](<https://developers.cloudflare.com/api/typescript/resources/token_validation#(resource)%20token_validation.rules%20%3E%20(model)%20token_validation_rule%20%3E%20(schema)>) {action, description, enabled, 6 more } >

GET/zones/{zone\_id}/token\_validation/rules

##### [Create a token validation rule](https://developers.cloudflare.com/api/typescript/resources/token_validation/subresources/rules/methods/create)

client.tokenValidation.rules.create(RuleCreateParams {zone\_id, action, description, 4 more } params, RequestOptionsoptions?): [TokenValidationRule](<https://developers.cloudflare.com/api/typescript/resources/token_validation#(resource)%20token_validation.rules%20%3E%20(model)%20token_validation_rule%20%3E%20(schema)>) {action, description, enabled, 6 more }

POST/zones/{zone\_id}/token\_validation/rules

##### [Create token validation rules](https://developers.cloudflare.com/api/typescript/resources/token_validation/subresources/rules/methods/bulk_create)

client.tokenValidation.rules.bulkCreate(RuleBulkCreateParams {zone\_id, body } params, RequestOptionsoptions?): SinglePage< [TokenValidationRule](<https://developers.cloudflare.com/api/typescript/resources/token_validation#(resource)%20token_validation.rules%20%3E%20(model)%20token_validation_rule%20%3E%20(schema)>) {action, description, enabled, 6 more } >

POST/zones/{zone\_id}/token\_validation/rules/bulk

##### [Edit token validation rules](https://developers.cloudflare.com/api/typescript/resources/token_validation/subresources/rules/methods/bulk_edit)

client.tokenValidation.rules.bulkEdit(RuleBulkEditParams {zone\_id, body } params, RequestOptionsoptions?): SinglePage< [TokenValidationRule](<https://developers.cloudflare.com/api/typescript/resources/token_validation#(resource)%20token_validation.rules%20%3E%20(model)%20token_validation_rule%20%3E%20(schema)>) {action, description, enabled, 6 more } >

PATCH/zones/{zone\_id}/token\_validation/rules/bulk

##### [Get a token validation rule](https://developers.cloudflare.com/api/typescript/resources/token_validation/subresources/rules/methods/get)

client.tokenValidation.rules.get(stringruleID, RuleGetParams {zone\_id } params, RequestOptionsoptions?): [TokenValidationRule](<https://developers.cloudflare.com/api/typescript/resources/token_validation#(resource)%20token_validation.rules%20%3E%20(model)%20token_validation_rule%20%3E%20(schema)>) {action, description, enabled, 6 more }

GET/zones/{zone\_id}/token\_validation/rules/{rule\_id}

##### [Delete a token validation rule](https://developers.cloudflare.com/api/typescript/resources/token_validation/subresources/rules/methods/delete)

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

DELETE/zones/{zone\_id}/token\_validation/rules/{rule\_id}

##### [Edit a token validation rule](https://developers.cloudflare.com/api/typescript/resources/token_validation/subresources/rules/methods/edit)

client.tokenValidation.rules.edit(stringruleID, RuleEditParams {zone\_id, action, description, 5 more } params, RequestOptionsoptions?): [TokenValidationRule](<https://developers.cloudflare.com/api/typescript/resources/token_validation#(resource)%20token_validation.rules%20%3E%20(model)%20token_validation_rule%20%3E%20(schema)>) {action, description, enabled, 6 more }

PATCH/zones/{zone\_id}/token\_validation/rules/{rule\_id}

##### ModelsExpand Collapse

<details>

<summary>

TokenValidationRule {action, description, enabled, 6 more }

A Token Validation rule that can enforce security policies using JWT Tokens.

</summary>

<details>

<summary>

action: "log"| "block"

Action to take on requests that match operations included in <code>selector</code> and fail <code>expression</code>.

</summary>

One of the following:

"log"

<a href="#(resource)%20token_validation.rules%20%3E%20(model)%20token_validation_rule%20%3E%20(schema)%20%3E%20(property)%20action%20%3E%20(member)%200">Link to this property</a>

"block"

<a href="#(resource)%20token_validation.rules%20%3E%20(model)%20token_validation_rule%20%3E%20(schema)%20%3E%20(property)%20action%20%3E%20(member)%201">Link to this property</a>

</details>

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

description: string

A human-readable description that gives more details than <code>title</code>.

maxLength500

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

enabled: boolean

Toggle rule on or off.

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

expression: string

Rule expression. Requests that fail to match this expression will be subject to <code>action</code>.

For details on expressions, see the <a href="https://developers.cloudflare.com/api-shield/security/jwt-validation/">Cloudflare Docs</a>.

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

<details>

<summary>

selector: Selector {exclude, include }

Select operations covered by this rule.

For details on selectors, see the <a href="https://developers.cloudflare.com/api-shield/security/jwt-validation/">Cloudflare Docs</a>.

</summary>

<details>

<summary>

exclude?: Array&lt;Exclude&gt;| null

Ignore operations that were otherwise included by <code>include</code>.

</summary>

operation\_ids?: Array&lt;string&gt;

Excluded operation IDs.

<a href="#(resource)%20token_validation.rules%20%3E%20(model)%20token_validation_rule%20%3E%20(schema)%20%3E%20(property)%20selector%20%3E%20(property)%20exclude%20%3E%20(items)%20%3E%20(property)%20operation_ids">Link to this property</a>

</details>

<a href="#(resource)%20token_validation.rules%20%3E%20(model)%20token_validation_rule%20%3E%20(schema)%20%3E%20(property)%20selector%20%3E%20(property)%20exclude">Link to this property</a>

<details>

<summary>

include?: Array&lt;Include&gt;| null

Select all matching operations.

</summary>

host?: Array&lt;string&gt;

Included hostnames.

<a href="#(resource)%20token_validation.rules%20%3E%20(model)%20token_validation_rule%20%3E%20(schema)%20%3E%20(property)%20selector%20%3E%20(property)%20include%20%3E%20(items)%20%3E%20(property)%20host">Link to this property</a>

</details>

<a href="#(resource)%20token_validation.rules%20%3E%20(model)%20token_validation_rule%20%3E%20(schema)%20%3E%20(property)%20selector%20%3E%20(property)%20include">Link to this property</a>

</details>

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

title: string

A human-readable name for the rule.

maxLength50

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

id?: string

UUID.

maxLength36

minLength36

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

created\_at?: string

formatdate-time

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

last\_updated?: string

formatdate-time

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

</details>

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

RuleDeleteResponse = unknown

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