Skip to content
Cloudflare API
Start here
API Reference
Token Validation

Rules

List token validation rules
client.TokenValidation.Rules.List(ctx, params) (*V4PagePaginationArray[TokenValidationRule], error)
GET/zones/{zone_id}/token_validation/rules
Create a token validation rule
client.TokenValidation.Rules.New(ctx, params) (*TokenValidationRule, error)
POST/zones/{zone_id}/token_validation/rules
Bulk create token validation rules
client.TokenValidation.Rules.BulkNew(ctx, params) (*SinglePage[TokenValidationRule], error)
POST/zones/{zone_id}/token_validation/rules/bulk
Bulk edit token validation rules
client.TokenValidation.Rules.BulkEdit(ctx, params) (*SinglePage[TokenValidationRule], error)
PATCH/zones/{zone_id}/token_validation/rules/bulk
Get a zone token validation rule
client.TokenValidation.Rules.Get(ctx, ruleID, query) (*TokenValidationRule, error)
GET/zones/{zone_id}/token_validation/rules/{rule_id}
Delete a zone token validation rule
client.TokenValidation.Rules.Delete(ctx, ruleID, body) (*RuleDeleteResponse, error)
DELETE/zones/{zone_id}/token_validation/rules/{rule_id}
Edit a zone token validation rule
client.TokenValidation.Rules.Edit(ctx, ruleID, params) (*TokenValidationRule, error)
PATCH/zones/{zone_id}/token_validation/rules/{rule_id}
ModelsExpand Collapse
type TokenValidationRule struct{…}

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

Action TokenValidationRuleAction

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

One of the following:
const TokenValidationRuleActionLog TokenValidationRuleAction = "log"
const TokenValidationRuleActionBlock TokenValidationRuleAction = "block"
Description string

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

maxLength500
Enabled bool

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 TokenValidationRuleSelector

Select operations covered by this rule.

For details on selectors, see the Cloudflare Docs.

Exclude []TokenValidationRuleSelectorExcludeoptional

Ignore operations that were otherwise included by include.

OperationIDs []stringoptional

Excluded operation IDs.

Include []TokenValidationRuleSelectorIncludeoptional

Select all matching operations.

Host []stringoptional

Included hostnames.

Title string

A human-readable name for the rule.

maxLength50
ID stringoptional

UUID.

maxLength36
minLength36
CreatedAt Timeoptional
formatdate-time
LastUpdated Timeoptional
formatdate-time