API Reference

Token Validation

Copy Markdown

Open in Claude

Open in ChatGPT

Open in Cursor

---

Copy Markdown

View as Markdown

Rules

List token validation rules

client.tokenValidation.rules.list(RuleListParams { zone_id, id, action, 7 more } params, RequestOptionsoptions?): V4PagePaginationArray<TokenValidationRule { action, description, enabled, 6 more } >

GET/zones/{zone_id}/token_validation/rules

Create a token validation rule

client.tokenValidation.rules.create(RuleCreateParams { zone_id, action, description, 4 more } params, RequestOptionsoptions?): TokenValidationRule { action, description, enabled, 6 more }

POST/zones/{zone_id}/token_validation/rules

Bulk create token validation rules

client.tokenValidation.rules.bulkCreate(RuleBulkCreateParams { zone_id, body } params, RequestOptionsoptions?): SinglePage<TokenValidationRule { action, description, enabled, 6 more } >

POST/zones/{zone_id}/token_validation/rules/bulk

Bulk edit token validation rules

client.tokenValidation.rules.bulkEdit(RuleBulkEditParams { zone_id, body } params, RequestOptionsoptions?): SinglePage<TokenValidationRule { action, description, enabled, 6 more } >

PATCH/zones/{zone_id}/token_validation/rules/bulk

Get a zone token validation rule

client.tokenValidation.rules.get(stringruleId, RuleGetParams { zone_id } params, RequestOptionsoptions?): TokenValidationRule { action, description, enabled, 6 more }

GET/zones/{zone_id}/token_validation/rules/{rule_id}

Delete a zone token validation rule

client.tokenValidation.rules.delete(stringruleId, RuleDeleteParams { zone_id } params, RequestOptionsoptions?): RuleDeleteResponse

DELETE/zones/{zone_id}/token_validation/rules/{rule_id}

Edit a zone token validation rule

client.tokenValidation.rules.edit(stringruleId, RuleEditParams { zone_id, action, description, 5 more } params, RequestOptionsoptions?): TokenValidationRule { action, description, enabled, 6 more }

PATCH/zones/{zone_id}/token_validation/rules/{rule_id}

ModelsExpand Collapse

TokenValidationRule { action, description, enabled, 6 more }

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

action: "log" | "block"

Action to take on requests that match operations included in selector and fail expression.

One of the following:

"log"

"block"

description: string

A human-readable description that gives more details than title.

maxLength500

enabled: boolean

Toggle rule on or off.

expression: string

Rule expression. Requests that fail to match this expression will be subject to action.

For details on expressions, see the Cloudflare Docs.

selector: Selector { exclude, include }

Select operations covered by this rule.

For details on selectors, see the Cloudflare Docs.

exclude?: Array<Exclude> | null

Ignore operations that were otherwise included by include.

operation_ids?: Array<string>

Excluded operation IDs.

include?: Array<Include> | null

Select all matching operations.

host?: Array<string>

Included hostnames.

title: string

A human-readable name for the rule.

maxLength50

id?: string

UUID.

maxLength36

minLength36

created_at?: string

formatdate-time

last_updated?: string

formatdate-time

RuleDeleteResponse = unknown