Skip to content

DLPIntegrationEntriesApi.md

Latest commit

 

History

History
177 lines (127 loc) · 7.45 KB

DLPIntegrationEntriesApi.md

File metadata and controls

177 lines (127 loc) · 7.45 KB

cloudflare_dart.api.DLPIntegrationEntriesApi

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
dlpEntriesCreateIntegrationEntry POST /accounts/{account_id}/dlp/entries/integration Create integration entry
dlpEntriesDeleteIntegrationEntry DELETE /accounts/{account_id}/dlp/entries/integration/{entry_id} Delete integration entry
dlpEntriesUpdateIntegrationEntry PUT /accounts/{account_id}/dlp/entries/integration/{entry_id} Update integration entry

dlpEntriesCreateIntegrationEntry

DlpEntriesCreateIntegrationEntry200Response dlpEntriesCreateIntegrationEntry(accountId, dlpNewPredefinedEntry)

Create integration entry

Integration entries can't be created, this will update an existing integration entry This is needed for our generated terraform API

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().getDLPIntegrationEntriesApi();
final String accountId = accountId_example; // String | 
final DlpNewPredefinedEntry dlpNewPredefinedEntry = ; // DlpNewPredefinedEntry | This endpoint will update an existing integration entry. It is not possible to create new integration entries

try {
    final response = api.dlpEntriesCreateIntegrationEntry(accountId, dlpNewPredefinedEntry);
    print(response);
} catch on DioException (e) {
    print('Exception when calling DLPIntegrationEntriesApi->dlpEntriesCreateIntegrationEntry: $e\n');
}

Parameters

Name Type Description Notes
accountId String
dlpNewPredefinedEntry DlpNewPredefinedEntry This endpoint will update an existing integration entry. It is not possible to create new integration entries

Return type

DlpEntriesCreateIntegrationEntry200Response

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]

dlpEntriesDeleteIntegrationEntry

DlpEntriesDeleteIntegrationEntry200Response dlpEntriesDeleteIntegrationEntry(accountId, entryId)

Delete integration entry

This is a no-op as integration entires can't be deleted but is needed for our generated terraform API

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().getDLPIntegrationEntriesApi();
final String accountId = accountId_example; // String | 
final String entryId = 38400000-8cf0-11bd-b23e-10b96e4ef00d; // String | 

try {
    final response = api.dlpEntriesDeleteIntegrationEntry(accountId, entryId);
    print(response);
} catch on DioException (e) {
    print('Exception when calling DLPIntegrationEntriesApi->dlpEntriesDeleteIntegrationEntry: $e\n');
}

Parameters

Name Type Description Notes
accountId String
entryId String

Return type

DlpEntriesDeleteIntegrationEntry200Response

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]

dlpEntriesUpdateIntegrationEntry

DlpEntriesCreateIntegrationEntry200Response dlpEntriesUpdateIntegrationEntry(accountId, entryId, dlpPredefinedEntryUpdate)

Update integration entry

Updates a DLP entry.

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().getDLPIntegrationEntriesApi();
final String accountId = accountId_example; // String | 
final String entryId = 38400000-8cf0-11bd-b23e-10b96e4ef00d; // String | 
final DlpPredefinedEntryUpdate dlpPredefinedEntryUpdate = ; // DlpPredefinedEntryUpdate | enable or disable integration entry in owning profile

try {
    final response = api.dlpEntriesUpdateIntegrationEntry(accountId, entryId, dlpPredefinedEntryUpdate);
    print(response);
} catch on DioException (e) {
    print('Exception when calling DLPIntegrationEntriesApi->dlpEntriesUpdateIntegrationEntry: $e\n');
}

Parameters

Name Type Description Notes
accountId String
entryId String
dlpPredefinedEntryUpdate DlpPredefinedEntryUpdate enable or disable integration entry in owning profile

Return type

DlpEntriesCreateIntegrationEntry200Response

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]