Skip to content

IPAddressManagementAddressMapsApi.md

Latest commit

 

History

History
615 lines (445 loc) · 26.4 KB

IPAddressManagementAddressMapsApi.md

File metadata and controls

615 lines (445 loc) · 26.4 KB

cloudflare_dart.api.IPAddressManagementAddressMapsApi

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
ipAddressManagementAddressMapsAddAZoneMembershipToAnAddressMap PUT /accounts/{account_id}/addressing/address_maps/{address_map_id}/zones/{zone_id} Add a zone membership to an Address Map
ipAddressManagementAddressMapsAddAnAccountMembershipToAnAddressMap PUT /accounts/{account_id}/addressing/address_maps/{address_map_id}/accounts/{account_id} Add an account membership to an Address Map
ipAddressManagementAddressMapsAddAnIpToAnAddressMap PUT /accounts/{account_id}/addressing/address_maps/{address_map_id}/ips/{ip_address} Add an IP to an Address Map
ipAddressManagementAddressMapsAddressMapDetails GET /accounts/{account_id}/addressing/address_maps/{address_map_id} Address Map Details
ipAddressManagementAddressMapsCreateAddressMap POST /accounts/{account_id}/addressing/address_maps Create Address Map
ipAddressManagementAddressMapsDeleteAddressMap DELETE /accounts/{account_id}/addressing/address_maps/{address_map_id} Delete Address Map
ipAddressManagementAddressMapsListAddressMaps GET /accounts/{account_id}/addressing/address_maps List Address Maps
ipAddressManagementAddressMapsRemoveAZoneMembershipFromAnAddressMap DELETE /accounts/{account_id}/addressing/address_maps/{address_map_id}/zones/{zone_id} Remove a zone membership from an Address Map
ipAddressManagementAddressMapsRemoveAnAccountMembershipFromAnAddressMap DELETE /accounts/{account_id}/addressing/address_maps/{address_map_id}/accounts/{account_id} Remove an account membership from an Address Map
ipAddressManagementAddressMapsRemoveAnIpFromAnAddressMap DELETE /accounts/{account_id}/addressing/address_maps/{address_map_id}/ips/{ip_address} Remove an IP from an Address Map
ipAddressManagementAddressMapsUpdateAddressMap PATCH /accounts/{account_id}/addressing/address_maps/{address_map_id} Update Address Map

ipAddressManagementAddressMapsAddAZoneMembershipToAnAddressMap

AddressingApiResponseCollection ipAddressManagementAddressMapsAddAZoneMembershipToAnAddressMap(zoneId, addressMapId, accountId)

Add a zone membership to an Address Map

Add a zone as a member of a particular address map.

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().getIPAddressManagementAddressMapsApi();
final String zoneId = zoneId_example; // String | 
final String addressMapId = addressMapId_example; // String | 
final String accountId = accountId_example; // String | 

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

Parameters

Name Type Description Notes
zoneId String
addressMapId String
accountId String

Return type

AddressingApiResponseCollection

Authorization

api_key, 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]

ipAddressManagementAddressMapsAddAnAccountMembershipToAnAddressMap

AddressingApiResponseCollection ipAddressManagementAddressMapsAddAnAccountMembershipToAnAddressMap(accountId, addressMapId)

Add an account membership to an Address Map

Add an account as a member of a particular address map.

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().getIPAddressManagementAddressMapsApi();
final String accountId = accountId_example; // String | 
final String addressMapId = addressMapId_example; // String | 

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

Parameters

Name Type Description Notes
accountId String
addressMapId String

Return type

AddressingApiResponseCollection

Authorization

api_key, 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]

ipAddressManagementAddressMapsAddAnIpToAnAddressMap

AddressingApiResponseCollection ipAddressManagementAddressMapsAddAnIpToAnAddressMap(ipAddress, addressMapId, accountId)

Add an IP to an Address Map

Add an IP from a prefix owned by the account to a particular address map.

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().getIPAddressManagementAddressMapsApi();
final String ipAddress = ipAddress_example; // String | 
final String addressMapId = addressMapId_example; // String | 
final String accountId = accountId_example; // String | 

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

Parameters

Name Type Description Notes
ipAddress String
addressMapId String
accountId String

Return type

AddressingApiResponseCollection

Authorization

api_key, 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]

ipAddressManagementAddressMapsAddressMapDetails

AddressingFullResponse ipAddressManagementAddressMapsAddressMapDetails(addressMapId, accountId)

Address Map Details

Show a particular address map owned by the account.

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().getIPAddressManagementAddressMapsApi();
final String addressMapId = addressMapId_example; // String | 
final String accountId = accountId_example; // String | 

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

Parameters

Name Type Description Notes
addressMapId String
accountId String

Return type

AddressingFullResponse

Authorization

api_key, 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]

ipAddressManagementAddressMapsCreateAddressMap

AddressingFullResponse ipAddressManagementAddressMapsCreateAddressMap(accountId, ipAddressManagementAddressMapsCreateAddressMapRequest)

Create Address Map

Create a new address map under the account.

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().getIPAddressManagementAddressMapsApi();
final String accountId = accountId_example; // String | 
final IpAddressManagementAddressMapsCreateAddressMapRequest ipAddressManagementAddressMapsCreateAddressMapRequest = ; // IpAddressManagementAddressMapsCreateAddressMapRequest | 

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

Parameters

Name Type Description Notes
accountId String
ipAddressManagementAddressMapsCreateAddressMapRequest IpAddressManagementAddressMapsCreateAddressMapRequest

Return type

AddressingFullResponse

Authorization

api_key, 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]

ipAddressManagementAddressMapsDeleteAddressMap

AddressingApiResponseCollection ipAddressManagementAddressMapsDeleteAddressMap(addressMapId, accountId)

Delete Address Map

Delete a particular address map owned by the account. An Address Map must be disabled before it can be deleted.

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().getIPAddressManagementAddressMapsApi();
final String addressMapId = addressMapId_example; // String | 
final String accountId = accountId_example; // String | 

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

Parameters

Name Type Description Notes
addressMapId String
accountId String

Return type

AddressingApiResponseCollection

Authorization

api_key, 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]

ipAddressManagementAddressMapsListAddressMaps

AddressingComponentsSchemasResponseCollection ipAddressManagementAddressMapsListAddressMaps(accountId)

List Address Maps

List all address maps owned by the account.

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().getIPAddressManagementAddressMapsApi();
final String accountId = accountId_example; // String | 

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

Parameters

Name Type Description Notes
accountId String

Return type

AddressingComponentsSchemasResponseCollection

Authorization

api_key, 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]

ipAddressManagementAddressMapsRemoveAZoneMembershipFromAnAddressMap

AddressingApiResponseCollection ipAddressManagementAddressMapsRemoveAZoneMembershipFromAnAddressMap(zoneId, addressMapId, accountId)

Remove a zone membership from an Address Map

Remove a zone as a member of a particular address map.

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().getIPAddressManagementAddressMapsApi();
final String zoneId = zoneId_example; // String | 
final String addressMapId = addressMapId_example; // String | 
final String accountId = accountId_example; // String | 

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

Parameters

Name Type Description Notes
zoneId String
addressMapId String
accountId String

Return type

AddressingApiResponseCollection

Authorization

api_key, 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]

ipAddressManagementAddressMapsRemoveAnAccountMembershipFromAnAddressMap

AddressingApiResponseCollection ipAddressManagementAddressMapsRemoveAnAccountMembershipFromAnAddressMap(accountId, addressMapId)

Remove an account membership from an Address Map

Remove an account as a member of a particular address map.

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().getIPAddressManagementAddressMapsApi();
final String accountId = accountId_example; // String | 
final String addressMapId = addressMapId_example; // String | 

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

Parameters

Name Type Description Notes
accountId String
addressMapId String

Return type

AddressingApiResponseCollection

Authorization

api_key, 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]

ipAddressManagementAddressMapsRemoveAnIpFromAnAddressMap

AddressingApiResponseCollection ipAddressManagementAddressMapsRemoveAnIpFromAnAddressMap(ipAddress, addressMapId, accountId)

Remove an IP from an Address Map

Remove an IP from a particular address map.

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().getIPAddressManagementAddressMapsApi();
final String ipAddress = ipAddress_example; // String | 
final String addressMapId = addressMapId_example; // String | 
final String accountId = accountId_example; // String | 

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

Parameters

Name Type Description Notes
ipAddress String
addressMapId String
accountId String

Return type

AddressingApiResponseCollection

Authorization

api_key, 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]

ipAddressManagementAddressMapsUpdateAddressMap

AddressingComponentsSchemasSingleResponse ipAddressManagementAddressMapsUpdateAddressMap(addressMapId, accountId, ipAddressManagementAddressMapsUpdateAddressMapRequest)

Update Address Map

Modify properties of an address map owned by the account.

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().getIPAddressManagementAddressMapsApi();
final String addressMapId = addressMapId_example; // String | 
final String accountId = accountId_example; // String | 
final IpAddressManagementAddressMapsUpdateAddressMapRequest ipAddressManagementAddressMapsUpdateAddressMapRequest = ; // IpAddressManagementAddressMapsUpdateAddressMapRequest | 

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

Parameters

Name Type Description Notes
addressMapId String
accountId String
ipAddressManagementAddressMapsUpdateAddressMapRequest IpAddressManagementAddressMapsUpdateAddressMapRequest

Return type

AddressingComponentsSchemasSingleResponse

Authorization

api_key, 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]