--- title: Create a token validation rule --- [Skip to content](#_top) [API Reference](https://developers.cloudflare.com/api/go) [Token Validation](https://developers.cloudflare.com/api/go/resources/token_validation) [Rules](https://developers.cloudflare.com/api/go/resources/token_validation/subresources/rules) Copy Markdown Open in **Claude**Open in **ChatGPT**Open in **Cursor** --- **Copy Markdown****View as Markdown** # Create a token validation rule client.TokenValidation.Rules.New(ctx, params) (\*[TokenValidationRule](), error) POST/zones/{zone\_id}/token\_validation/rules Creates a token validation rule for the zone. ##### Security
API Token The preferred authorization scheme for interacting with the Cloudflare API. Create a token. **Example:**Authorization: Bearer Sn3lZJTBX6kkg7OdcBUAxOO963GEIyGQqnFTOFYY
API Email + API Key The previous authorization scheme for interacting with the Cloudflare API, used in conjunction with a Global API key. **Example:**X-Auth-Email: user@example.com The previous authorization scheme for interacting with the Cloudflare API. When possible, use API tokens instead of Global API keys. **Example:**X-Auth-Key: 144c9defac04969c7bfad8efaa8ea194
##### Accepted Permissions (at least one required) `Account API Gateway``Domain API Gateway` ##### ParametersExpand Collapse
params RuleNewParams ZoneID param.Field\[string] Path param: Identifier. maxLength32 Link to this property
Action param.Field\[RuleNewParamsAction] Body param: Action to take on requests that match operations included in selector and fail expression. const RuleNewParamsActionLog RuleNewParamsAction = "log" Link to this property const RuleNewParamsActionBlock RuleNewParamsAction = "block" Link to this property
Link to this property Description param.Field\[string] Body param: A human-readable description that gives more details than title. maxLength500 Link to this property Enabled param.Field\[bool] Body param: Toggle rule on or off. Link to this property Expression param.Field\[string] Body param: Rule expression. Requests that fail to match this expression will be subject to action. For details on expressions, see the Cloudflare Docs. Link to this property
Selector param.Field\[RuleNewParamsSelector] Body param: Select operations covered by this rule. For details on selectors, see the Cloudflare Docs.
Exclude \[]RuleNewParamsSelectorExcludeOptional Ignore operations that were otherwise included by include. OperationIDs \[]stringOptional Excluded operation IDs. Link to this property
Link to this property
Include \[]RuleNewParamsSelectorIncludeOptional Select all matching operations. Host \[]stringOptional Included hostnames. Link to this property
Link to this property
Link to this property Title param.Field\[string] Body param: A human-readable name for the rule. maxLength50 Link to this property
[Link to this property](<#(resource)%20token_validation.rules%20%3E%20(method)%20create%20%3E%20(params)%20default>) ##### ReturnsExpand 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" Link to this property const TokenValidationRuleActionBlock TokenValidationRuleAction = "block" Link to this property
Link to this property Description string A human-readable description that gives more details than title. maxLength500 Link to this property Enabled bool Toggle rule on or off. Link to this property Expression string Rule expression. Requests that fail to match this expression will be subject to action. For details on expressions, see the Cloudflare Docs. Link to this property
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. Link to this property
Link to this property
Include \[]TokenValidationRuleSelectorIncludeOptional Select all matching operations. Host \[]stringOptional Included hostnames. Link to this property
Link to this property
Link to this property Title string A human-readable name for the rule. maxLength50 Link to this property ID stringOptional UUID. maxLength36 minLength36 Link to this property CreatedAt TimeOptional formatdate-time Link to this property LastUpdated TimeOptional formatdate-time Link to this property
[Link to this property](<#(resource)%20token_validation.rules%20%3E%20(model)%20token_validation_rule%20%3E%20(schema)>) ### Create a token validation rule Go HTTPTypeScriptPythonGoTerraform ``` package main import ( "context" "fmt" "github.com/cloudflare/cloudflare-go" "github.com/cloudflare/cloudflare-go/option" "github.com/cloudflare/cloudflare-go/token_validation" ) func main() { client := cloudflare.NewClient( option.WithAPIToken("Sn3lZJTBX6kkg7OdcBUAxOO963GEIyGQqnFTOFYY"), ) tokenValidationRule, err := client.TokenValidation.Rules.New(context.TODO(), token_validation.RuleNewParams{ ZoneID: cloudflare.F("023e105f4ecef8ad9ca31a8372d0c353"), Action: cloudflare.F(token_validation.RuleNewParamsActionLog), Description: cloudflare.F("Long description for Token Validation Rule"), Enabled: cloudflare.F(true), Expression: cloudflare.F(`is_jwt_valid("52973293-cb04-4a97-8f55-e7d2ad1107dd") or is_jwt_valid("46eab8d1-6376-45e3-968f-2c649d77d423")`), Selector: cloudflare.F(token_validation.RuleNewParamsSelector{ }), Title: cloudflare.F("Example Token Validation Rule"), }) if err != nil { panic(err.Error()) } fmt.Printf("%+v\n", tokenValidationRule.ID) } ``` 200 example ``` { "errors": [ { "code": 1000, "message": "message", "documentation_url": "documentation_url", "source": { "pointer": "pointer" } } ], "messages": [ { "code": 1000, "message": "message", "documentation_url": "documentation_url", "source": { "pointer": "pointer" } } ], "result": { "action": "log", "description": "Long description for Token Validation Rule", "enabled": true, "expression": "is_jwt_valid(\"52973293-cb04-4a97-8f55-e7d2ad1107dd\") or is_jwt_valid(\"46eab8d1-6376-45e3-968f-2c649d77d423\")", "selector": { "exclude": [ { "operation_ids": [ "f9c5615e-fe15-48ce-bec6-cfc1946f1bec", "56828eae-035a-4396-ba07-51c66d680a04" ] } ], "include": [ { "host": [ "v1.example.com", "v2.example.com" ] } ] }, "title": "Example Token Validation Rule", "id": "f174e90a-fafe-4643-bbbc-4a0ed4fc8415", "created_at": "2014-01-01T05:20:00.12345Z", "last_updated": "2014-01-01T05:20:00.12345Z" }, "success": true } ``` ##### Returns Examples 200 example ``` { "errors": [ { "code": 1000, "message": "message", "documentation_url": "documentation_url", "source": { "pointer": "pointer" } } ], "messages": [ { "code": 1000, "message": "message", "documentation_url": "documentation_url", "source": { "pointer": "pointer" } } ], "result": { "action": "log", "description": "Long description for Token Validation Rule", "enabled": true, "expression": "is_jwt_valid(\"52973293-cb04-4a97-8f55-e7d2ad1107dd\") or is_jwt_valid(\"46eab8d1-6376-45e3-968f-2c649d77d423\")", "selector": { "exclude": [ { "operation_ids": [ "f9c5615e-fe15-48ce-bec6-cfc1946f1bec", "56828eae-035a-4396-ba07-51c66d680a04" ] } ], "include": [ { "host": [ "v1.example.com", "v2.example.com" ] } ] }, "title": "Example Token Validation Rule", "id": "f174e90a-fafe-4643-bbbc-4a0ed4fc8415", "created_at": "2014-01-01T05:20:00.12345Z", "last_updated": "2014-01-01T05:20:00.12345Z" }, "success": true } ```