cloudflare_dart.api.TokenValidationTokenRulesApi

Load the API package

import 'package:cloudflare_dart/api.dart';

All URIs are relative to https://api.cloudflare.com/client/v4

Method	HTTP request	Description
tokenValidationRulesBulkCreate	POST /zones/{zone_id}/token_validation/rules/bulk	Bulk create token validation rules
tokenValidationRulesBulkEdit	PATCH /zones/{zone_id}/token_validation/rules/bulk	Bulk edit token validation rules
tokenValidationRulesCreate	POST /zones/{zone_id}/token_validation/rules	Create a token validation rule
tokenValidationRulesDelete	DELETE /zones/{zone_id}/token_validation/rules/{rule_id}	Delete a zone token validation rule
tokenValidationRulesEdit	PATCH /zones/{zone_id}/token_validation/rules/{rule_id}	Edit a zone token validation rule
tokenValidationRulesGet	GET /zones/{zone_id}/token_validation/rules/{rule_id}	Get a zone token validation rule
tokenValidationRulesList	GET /zones/{zone_id}/token_validation/rules	List token validation rules
tokenValidationRulesPreview	POST /zones/{zone_id}/token_validation/rules/preview	Preview operations covered by a Token Validation rule

tokenValidationRulesBulkCreate

TokenValidationRulesList200Response tokenValidationRulesBulkCreate(zoneId, apiShieldCreateSingleRuleRequest)

Bulk create token validation rules

Create zone token validation rules. A request can create multiple Token Validation Rules.

Example

import 'package:cloudflare_dart/api.dart';
// TODO Configure API key authorization: api_key
//defaultApiClient.getAuthentication<ApiKeyAuth>('api_key').apiKey = 'YOUR_API_KEY';
// uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//defaultApiClient.getAuthentication<ApiKeyAuth>('api_key').apiKeyPrefix = 'Bearer';
// TODO Configure API key authorization: api_email
//defaultApiClient.getAuthentication<ApiKeyAuth>('api_email').apiKey = 'YOUR_API_KEY';
// uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//defaultApiClient.getAuthentication<ApiKeyAuth>('api_email').apiKeyPrefix = 'Bearer';

final api = CloudflareDart().getTokenValidationTokenRulesApi();
final ApiShieldSchemasIdentifier zoneId = ; // ApiShieldSchemasIdentifier | 
final BuiltList<ApiShieldCreateSingleRuleRequest> apiShieldCreateSingleRuleRequest = ; // BuiltList<ApiShieldCreateSingleRuleRequest> | 

try {
    final response = api.tokenValidationRulesBulkCreate(zoneId, apiShieldCreateSingleRuleRequest);
    print(response);
} catch on DioException (e) {
    print('Exception when calling TokenValidationTokenRulesApi->tokenValidationRulesBulkCreate: $e\n');
}

Parameters

Name	Type	Description	Notes
zoneId	ApiShieldSchemasIdentifier
apiShieldCreateSingleRuleRequest	BuiltList<ApiShieldCreateSingleRuleRequest>

Return type

TokenValidationRulesList200Response

Authorization

api_key, api_token, api_email

HTTP request headers

Content-Type: application/json
Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

tokenValidationRulesBulkEdit

TokenValidationRulesList200Response tokenValidationRulesBulkEdit(zoneId, tokenValidationRulesBulkEditRequestInner)

Bulk edit token validation rules

Edit token validation rules. A request can update multiple Token Validation Rules. Rules can be re-ordered using the position field. Returns all updated rules.

Example

import 'package:cloudflare_dart/api.dart';
// TODO Configure API key authorization: api_key
//defaultApiClient.getAuthentication<ApiKeyAuth>('api_key').apiKey = 'YOUR_API_KEY';
// uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//defaultApiClient.getAuthentication<ApiKeyAuth>('api_key').apiKeyPrefix = 'Bearer';
// TODO Configure API key authorization: api_email
//defaultApiClient.getAuthentication<ApiKeyAuth>('api_email').apiKey = 'YOUR_API_KEY';
// uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//defaultApiClient.getAuthentication<ApiKeyAuth>('api_email').apiKeyPrefix = 'Bearer';

final api = CloudflareDart().getTokenValidationTokenRulesApi();
final ApiShieldSchemasIdentifier zoneId = ; // ApiShieldSchemasIdentifier | 
final BuiltList<TokenValidationRulesBulkEditRequestInner> tokenValidationRulesBulkEditRequestInner = ; // BuiltList<TokenValidationRulesBulkEditRequestInner> | 

try {
    final response = api.tokenValidationRulesBulkEdit(zoneId, tokenValidationRulesBulkEditRequestInner);
    print(response);
} catch on DioException (e) {
    print('Exception when calling TokenValidationTokenRulesApi->tokenValidationRulesBulkEdit: $e\n');
}

Parameters

Name	Type	Description	Notes
zoneId	ApiShieldSchemasIdentifier
tokenValidationRulesBulkEditRequestInner	BuiltList<TokenValidationRulesBulkEditRequestInner>

Return type

TokenValidationRulesList200Response

Authorization

api_key, api_token, api_email

HTTP request headers

Content-Type: application/json
Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

tokenValidationRulesCreate

TokenValidationRulesCreate200Response tokenValidationRulesCreate(zoneId, apiShieldCreateSingleRuleRequest)

Create a token validation rule

Create a token validation rule.

Example

import 'package:cloudflare_dart/api.dart';
// TODO Configure API key authorization: api_key
//defaultApiClient.getAuthentication<ApiKeyAuth>('api_key').apiKey = 'YOUR_API_KEY';
// uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//defaultApiClient.getAuthentication<ApiKeyAuth>('api_key').apiKeyPrefix = 'Bearer';
// TODO Configure API key authorization: api_email
//defaultApiClient.getAuthentication<ApiKeyAuth>('api_email').apiKey = 'YOUR_API_KEY';
// uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//defaultApiClient.getAuthentication<ApiKeyAuth>('api_email').apiKeyPrefix = 'Bearer';

final api = CloudflareDart().getTokenValidationTokenRulesApi();
final ApiShieldSchemasIdentifier zoneId = ; // ApiShieldSchemasIdentifier | 
final ApiShieldCreateSingleRuleRequest apiShieldCreateSingleRuleRequest = ; // ApiShieldCreateSingleRuleRequest | 

try {
    final response = api.tokenValidationRulesCreate(zoneId, apiShieldCreateSingleRuleRequest);
    print(response);
} catch on DioException (e) {
    print('Exception when calling TokenValidationTokenRulesApi->tokenValidationRulesCreate: $e\n');
}

Parameters

Name	Type	Description	Notes
zoneId	ApiShieldSchemasIdentifier
apiShieldCreateSingleRuleRequest	ApiShieldCreateSingleRuleRequest

Return type

TokenValidationRulesCreate200Response

Authorization

api_key, api_token, api_email

HTTP request headers

Content-Type: application/json
Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

tokenValidationRulesDelete

ApiShieldApiResponseSingleObj tokenValidationRulesDelete(zoneId, ruleId)

Delete a zone token validation rule

Delete a zone token validation rule.

Example

import 'package:cloudflare_dart/api.dart';
// TODO Configure API key authorization: api_key
//defaultApiClient.getAuthentication<ApiKeyAuth>('api_key').apiKey = 'YOUR_API_KEY';
// uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//defaultApiClient.getAuthentication<ApiKeyAuth>('api_key').apiKeyPrefix = 'Bearer';
// TODO Configure API key authorization: api_email
//defaultApiClient.getAuthentication<ApiKeyAuth>('api_email').apiKey = 'YOUR_API_KEY';
// uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//defaultApiClient.getAuthentication<ApiKeyAuth>('api_email').apiKeyPrefix = 'Bearer';

final api = CloudflareDart().getTokenValidationTokenRulesApi();
final ApiShieldSchemasIdentifier zoneId = ; // ApiShieldSchemasIdentifier | 
final ApiShieldSchemasUuid ruleId = 4a7ee8d3-dd63-4ceb-9d5f-c27831854ce7; // ApiShieldSchemasUuid | Token Validation Rule ID

try {
    final response = api.tokenValidationRulesDelete(zoneId, ruleId);
    print(response);
} catch on DioException (e) {
    print('Exception when calling TokenValidationTokenRulesApi->tokenValidationRulesDelete: $e\n');
}

Parameters

Name	Type	Description	Notes
zoneId	ApiShieldSchemasIdentifier
ruleId	ApiShieldSchemasUuid	Token Validation Rule ID

Return type

ApiShieldApiResponseSingleObj

Authorization

api_key, api_token, api_email

HTTP request headers

Content-Type: Not defined
Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

tokenValidationRulesEdit

TokenValidationRulesCreate200Response tokenValidationRulesEdit(zoneId, ruleId, apiShieldEditSingleRuleRequest)

Edit a zone token validation rule

Edit a zone token validation rule.

Example

import 'package:cloudflare_dart/api.dart';
// TODO Configure API key authorization: api_key
//defaultApiClient.getAuthentication<ApiKeyAuth>('api_key').apiKey = 'YOUR_API_KEY';
// uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//defaultApiClient.getAuthentication<ApiKeyAuth>('api_key').apiKeyPrefix = 'Bearer';
// TODO Configure API key authorization: api_email
//defaultApiClient.getAuthentication<ApiKeyAuth>('api_email').apiKey = 'YOUR_API_KEY';
// uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//defaultApiClient.getAuthentication<ApiKeyAuth>('api_email').apiKeyPrefix = 'Bearer';

final api = CloudflareDart().getTokenValidationTokenRulesApi();
final ApiShieldSchemasIdentifier zoneId = ; // ApiShieldSchemasIdentifier | 
final ApiShieldSchemasUuid ruleId = 4a7ee8d3-dd63-4ceb-9d5f-c27831854ce7; // ApiShieldSchemasUuid | Token Validation Rule ID
final ApiShieldEditSingleRuleRequest apiShieldEditSingleRuleRequest = ; // ApiShieldEditSingleRuleRequest | 

try {
    final response = api.tokenValidationRulesEdit(zoneId, ruleId, apiShieldEditSingleRuleRequest);
    print(response);
} catch on DioException (e) {
    print('Exception when calling TokenValidationTokenRulesApi->tokenValidationRulesEdit: $e\n');
}

Parameters

Name	Type	Description
zoneId	ApiShieldSchemasIdentifier
ruleId	ApiShieldSchemasUuid	Token Validation Rule ID
apiShieldEditSingleRuleRequest	ApiShieldEditSingleRuleRequest

Return type

TokenValidationRulesCreate200Response

Authorization

api_key, api_token, api_email

HTTP request headers

Content-Type: application/json
Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

tokenValidationRulesGet

TokenValidationRulesGet200Response tokenValidationRulesGet(zoneId, ruleId)

Get a zone token validation rule

Get a zone token validation rule.

Example

import 'package:cloudflare_dart/api.dart';
// TODO Configure API key authorization: api_key
//defaultApiClient.getAuthentication<ApiKeyAuth>('api_key').apiKey = 'YOUR_API_KEY';
// uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//defaultApiClient.getAuthentication<ApiKeyAuth>('api_key').apiKeyPrefix = 'Bearer';
// TODO Configure API key authorization: api_email
//defaultApiClient.getAuthentication<ApiKeyAuth>('api_email').apiKey = 'YOUR_API_KEY';
// uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//defaultApiClient.getAuthentication<ApiKeyAuth>('api_email').apiKeyPrefix = 'Bearer';

final api = CloudflareDart().getTokenValidationTokenRulesApi();
final ApiShieldSchemasIdentifier zoneId = ; // ApiShieldSchemasIdentifier | 
final ApiShieldSchemasUuid ruleId = 4a7ee8d3-dd63-4ceb-9d5f-c27831854ce7; // ApiShieldSchemasUuid | Token Validation Rule ID

try {
    final response = api.tokenValidationRulesGet(zoneId, ruleId);
    print(response);
} catch on DioException (e) {
    print('Exception when calling TokenValidationTokenRulesApi->tokenValidationRulesGet: $e\n');
}

Parameters

Name	Type	Description	Notes
zoneId	ApiShieldSchemasIdentifier
ruleId	ApiShieldSchemasUuid	Token Validation Rule ID

Return type

TokenValidationRulesGet200Response

Authorization

api_key, api_token, api_email

HTTP request headers

Content-Type: Not defined
Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

tokenValidationRulesList

TokenValidationRulesList200Response tokenValidationRulesList(zoneId, perPage, page, tokenConfiguration, action, enabled, id, ruleId, host, hostname)

List token validation rules

Example

import 'package:cloudflare_dart/api.dart';
// TODO Configure API key authorization: api_key
//defaultApiClient.getAuthentication<ApiKeyAuth>('api_key').apiKey = 'YOUR_API_KEY';
// uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//defaultApiClient.getAuthentication<ApiKeyAuth>('api_key').apiKeyPrefix = 'Bearer';
// TODO Configure API key authorization: api_email
//defaultApiClient.getAuthentication<ApiKeyAuth>('api_email').apiKey = 'YOUR_API_KEY';
// uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//defaultApiClient.getAuthentication<ApiKeyAuth>('api_email').apiKeyPrefix = 'Bearer';

final api = CloudflareDart().getTokenValidationTokenRulesApi();
final ApiShieldSchemasIdentifier zoneId = ; // ApiShieldSchemasIdentifier | 
final int perPage = 56; // int | Maximum number of results per page.
final int page = 56; // int | Page number of paginated results.
final BuiltList<ApiShieldSchemasUuid> tokenConfiguration = ["f0963ed4-f3a1-4599-8a61-9e5658c865e0,3aad66bb-059d-4b3d-87e1-cdf4d406f412"]; // BuiltList<ApiShieldSchemasUuid> | Select rules using any of these token configurations.
final ApiShieldAction action = ; // ApiShieldAction | 
final bool enabled = true; // bool | 
final ApiShieldSchemasUuid id = ; // ApiShieldSchemasUuid | Select rules with these IDs.
final ApiShieldSchemasUuid ruleId = ; // ApiShieldSchemasUuid | Select rules with these IDs.
final String host = host_example; // String | Select rules with this host in `include`.
final String hostname = hostname_example; // String | Select rules with this host in `include`.

try {
    final response = api.tokenValidationRulesList(zoneId, perPage, page, tokenConfiguration, action, enabled, id, ruleId, host, hostname);
    print(response);
} catch on DioException (e) {
    print('Exception when calling TokenValidationTokenRulesApi->tokenValidationRulesList: $e\n');
}

Parameters

Name	Type	Description	Notes
zoneId	ApiShieldSchemasIdentifier
perPage	int	Maximum number of results per page.	[optional] [default to 20]
page	int	Page number of paginated results.	[optional] [default to 1]
tokenConfiguration	BuiltList<ApiShieldSchemasUuid>	Select rules using any of these token configurations.	[optional]
action	ApiShieldAction		[optional]
enabled	bool		[optional]
id	ApiShieldSchemasUuid	Select rules with these IDs.	[optional]
ruleId	ApiShieldSchemasUuid	Select rules with these IDs.	[optional]
host	String	Select rules with this host in `include`.	[optional]
hostname	String	Select rules with this host in `include`.	[optional]

Return type

TokenValidationRulesList200Response

Authorization

api_key, api_token, api_email

HTTP request headers

Content-Type: Not defined
Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

tokenValidationRulesPreview

TokenValidationRulesPreview200Response tokenValidationRulesPreview(zoneId, apiShieldSelector, perPage, page, state, host, hostname, method, endpoint)

Preview operations covered by a Token Validation rule

Preview operations covered by a Token Validation rule. The API will return all operations on a zone annotated with an additional state field. Operations with an included state will be covered by a Token Validation Rule.

Example

import 'package:cloudflare_dart/api.dart';
// TODO Configure API key authorization: api_key
//defaultApiClient.getAuthentication<ApiKeyAuth>('api_key').apiKey = 'YOUR_API_KEY';
// uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//defaultApiClient.getAuthentication<ApiKeyAuth>('api_key').apiKeyPrefix = 'Bearer';
// TODO Configure API key authorization: api_email
//defaultApiClient.getAuthentication<ApiKeyAuth>('api_email').apiKey = 'YOUR_API_KEY';
// uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//defaultApiClient.getAuthentication<ApiKeyAuth>('api_email').apiKeyPrefix = 'Bearer';

final api = CloudflareDart().getTokenValidationTokenRulesApi();
final ApiShieldSchemasIdentifier zoneId = ; // ApiShieldSchemasIdentifier | 
final ApiShieldSelector apiShieldSelector = ; // ApiShieldSelector | 
final int perPage = 56; // int | Maximum number of results per page.
final int page = 56; // int | Page number of paginated results.
final BuiltList<ApiShieldSelectorOperationState> state = ["included,excluded"]; // BuiltList<ApiShieldSelectorOperationState> | 
final BuiltList<String> host = ; // BuiltList<String> | Filter operations by host.
final BuiltList<String> hostname = ; // BuiltList<String> | Filter operations by host.
final BuiltList<ApiShieldMethod> method = ; // BuiltList<ApiShieldMethod> | Filter operations by method.
final BuiltList<String> endpoint = ; // BuiltList<String> | Filter operations by endpoint. Allows substring matching.

try {
    final response = api.tokenValidationRulesPreview(zoneId, apiShieldSelector, perPage, page, state, host, hostname, method, endpoint);
    print(response);
} catch on DioException (e) {
    print('Exception when calling TokenValidationTokenRulesApi->tokenValidationRulesPreview: $e\n');
}

Parameters

Name	Type	Description	Notes
zoneId	ApiShieldSchemasIdentifier
apiShieldSelector	ApiShieldSelector
perPage	int	Maximum number of results per page.	[optional] [default to 20]
page	int	Page number of paginated results.	[optional] [default to 1]
state	BuiltList<ApiShieldSelectorOperationState>		[optional]
host	BuiltList<String>	Filter operations by host.	[optional]
hostname	BuiltList<String>	Filter operations by host.	[optional]
method	BuiltList<ApiShieldMethod>	Filter operations by method.	[optional]
endpoint	BuiltList<String>	Filter operations by endpoint. Allows substring matching.	[optional]

Return type

TokenValidationRulesPreview200Response

Authorization

api_key, api_token, api_email

HTTP request headers

Content-Type: application/json
Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

FilesExpand file tree

TokenValidationTokenRulesApi.md

Latest commit

History

TokenValidationTokenRulesApi.md

File metadata and controls

cloudflare_dart.api.TokenValidationTokenRulesApi

Load the API package

tokenValidationRulesBulkCreate

Example

Parameters

Return type

Authorization

HTTP request headers

tokenValidationRulesBulkEdit

Example

Parameters

Return type

Authorization

HTTP request headers

tokenValidationRulesCreate

Example

Parameters

Return type

Authorization

HTTP request headers

tokenValidationRulesDelete

Example

Parameters

Return type

Authorization

HTTP request headers

tokenValidationRulesEdit

Example

Parameters

Return type

Authorization

HTTP request headers

tokenValidationRulesGet

Example

Parameters

Return type

Authorization

HTTP request headers

tokenValidationRulesList

Example

Parameters

Return type

Authorization

HTTP request headers

tokenValidationRulesPreview

Example

Parameters

Return type

Authorization

HTTP request headers