Skip to content

MagicInterconnectsApi.md

Latest commit

 

History

History
237 lines (172 loc) · 11 KB

MagicInterconnectsApi.md

File metadata and controls

237 lines (172 loc) · 11 KB

cloudflare_dart.api.MagicInterconnectsApi

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
magicInterconnectsListInterconnectDetails GET /accounts/{account_id}/magic/cf_interconnects/{cf_interconnect_id} List interconnect Details
magicInterconnectsListInterconnects GET /accounts/{account_id}/magic/cf_interconnects List interconnects
magicInterconnectsUpdateInterconnect PUT /accounts/{account_id}/magic/cf_interconnects/{cf_interconnect_id} Update interconnect
magicInterconnectsUpdateMultipleInterconnects PUT /accounts/{account_id}/magic/cf_interconnects Update multiple interconnects

magicInterconnectsListInterconnectDetails

MagicComponentsSchemasTunnelSingleResponse magicInterconnectsListInterconnectDetails(cfInterconnectId, accountId, xMagicNewHcTarget)

List interconnect Details

Lists details for a specific interconnect.

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().getMagicInterconnectsApi();
final String cfInterconnectId = cfInterconnectId_example; // String | 
final String accountId = accountId_example; // String | 
final bool xMagicNewHcTarget = true; // bool | If true, the health check target in the response body will be presented using the new object format. Defaults to false.

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

Parameters

Name Type Description Notes
cfInterconnectId String
accountId String
xMagicNewHcTarget bool If true, the health check target in the response body will be presented using the new object format. Defaults to false. [optional]

Return type

MagicComponentsSchemasTunnelSingleResponse

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]

magicInterconnectsListInterconnects

MagicComponentsSchemasTunnelsCollectionResponse magicInterconnectsListInterconnects(accountId, xMagicNewHcTarget)

List interconnects

Lists interconnects associated with an 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().getMagicInterconnectsApi();
final String accountId = accountId_example; // String | 
final bool xMagicNewHcTarget = true; // bool | If true, the health check target in the response body will be presented using the new object format. Defaults to false.

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

Parameters

Name Type Description Notes
accountId String
xMagicNewHcTarget bool If true, the health check target in the response body will be presented using the new object format. Defaults to false. [optional]

Return type

MagicComponentsSchemasTunnelsCollectionResponse

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]

magicInterconnectsUpdateInterconnect

MagicComponentsSchemasTunnelModifiedResponse magicInterconnectsUpdateInterconnect(cfInterconnectId, accountId, magicInterconnectTunnelUpdateRequest, xMagicNewHcTarget)

Update interconnect

Updates a specific interconnect associated with an account. Use ?validate_only=true as an optional query parameter to only run validation without persisting changes.

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().getMagicInterconnectsApi();
final String cfInterconnectId = cfInterconnectId_example; // String | 
final String accountId = accountId_example; // String | 
final MagicInterconnectTunnelUpdateRequest magicInterconnectTunnelUpdateRequest = ; // MagicInterconnectTunnelUpdateRequest | 
final bool xMagicNewHcTarget = true; // bool | If true, the health check target in the request and response bodies will be presented using the new object format. Defaults to false.

try {
    final response = api.magicInterconnectsUpdateInterconnect(cfInterconnectId, accountId, magicInterconnectTunnelUpdateRequest, xMagicNewHcTarget);
    print(response);
} catch on DioException (e) {
    print('Exception when calling MagicInterconnectsApi->magicInterconnectsUpdateInterconnect: $e\n');
}

Parameters

Name Type Description Notes
cfInterconnectId String
accountId String
magicInterconnectTunnelUpdateRequest MagicInterconnectTunnelUpdateRequest
xMagicNewHcTarget bool If true, the health check target in the request and response bodies will be presented using the new object format. Defaults to false. [optional]

Return type

MagicComponentsSchemasTunnelModifiedResponse

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]

magicInterconnectsUpdateMultipleInterconnects

MagicComponentsSchemasModifiedTunnelsCollectionResponse magicInterconnectsUpdateMultipleInterconnects(accountId, body, xMagicNewHcTarget)

Update multiple interconnects

Updates multiple interconnects associated with an account. Use ?validate_only=true as an optional query parameter to only run validation without persisting changes.

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().getMagicInterconnectsApi();
final String accountId = accountId_example; // String | 
final JsonObject body = ; // JsonObject | 
final bool xMagicNewHcTarget = true; // bool | If true, the health check target in the request and response bodies will be presented using the new object format. Defaults to false.

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

Parameters

Name Type Description Notes
accountId String
body JsonObject
xMagicNewHcTarget bool If true, the health check target in the request and response bodies will be presented using the new object format. Defaults to false. [optional]

Return type

MagicComponentsSchemasModifiedTunnelsCollectionResponse

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]