Skip to content

ManagedTransformsApi.md

Latest commit

 

History

History
170 lines (120 loc) · 6.03 KB

ManagedTransformsApi.md

File metadata and controls

170 lines (120 loc) · 6.03 KB

cloudflare_dart.api.ManagedTransformsApi

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
deleteManagedTransforms DELETE /zones/{zone_id}/managed_headers Delete Managed Transforms
listManagedTransforms GET /zones/{zone_id}/managed_headers List Managed Transforms
updateManagedTransforms PATCH /zones/{zone_id}/managed_headers Update Managed Transforms

deleteManagedTransforms

deleteManagedTransforms(zoneId)

Delete Managed Transforms

Disables all Managed Transforms.

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().getManagedTransformsApi();
final String zoneId = zoneId_example; // String | 

try {
    api.deleteManagedTransforms(zoneId);
} catch on DioException (e) {
    print('Exception when calling ManagedTransformsApi->deleteManagedTransforms: $e\n');
}

Parameters

Name Type Description Notes
zoneId String

Return type

void (empty response body)

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]

listManagedTransforms

ListManagedTransforms200Response listManagedTransforms(zoneId)

List Managed Transforms

Fetches a list of all Managed Transforms.

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().getManagedTransformsApi();
final String zoneId = zoneId_example; // String | 

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

Parameters

Name Type Description Notes
zoneId String

Return type

ListManagedTransforms200Response

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]

updateManagedTransforms

ListManagedTransforms200Response updateManagedTransforms(zoneId, rulesetsManagedTransforms)

Update Managed Transforms

Updates the status of one or more Managed Transforms.

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().getManagedTransformsApi();
final String zoneId = zoneId_example; // String | 
final RulesetsManagedTransforms rulesetsManagedTransforms = ; // RulesetsManagedTransforms | 

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

Parameters

Name Type Description Notes
zoneId String
rulesetsManagedTransforms RulesetsManagedTransforms

Return type

ListManagedTransforms200Response

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]