cloudflare_dart.api.AccountLoadBalancerMonitorsApi

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
accountLoadBalancerMonitorsCreateMonitor	POST /accounts/{account_id}/load_balancers/monitors	Create Monitor
accountLoadBalancerMonitorsDeleteMonitor	DELETE /accounts/{account_id}/load_balancers/monitors/{monitor_id}	Delete Monitor
accountLoadBalancerMonitorsListMonitorReferences	GET /accounts/{account_id}/load_balancers/monitors/{monitor_id}/references	List Monitor References
accountLoadBalancerMonitorsListMonitors	GET /accounts/{account_id}/load_balancers/monitors	List Monitors
accountLoadBalancerMonitorsMonitorDetails	GET /accounts/{account_id}/load_balancers/monitors/{monitor_id}	Monitor Details
accountLoadBalancerMonitorsPatchMonitor	PATCH /accounts/{account_id}/load_balancers/monitors/{monitor_id}	Patch Monitor
accountLoadBalancerMonitorsPreviewMonitor	POST /accounts/{account_id}/load_balancers/monitors/{monitor_id}/preview	Preview Monitor
accountLoadBalancerMonitorsPreviewResult	GET /accounts/{account_id}/load_balancers/preview/{preview_id}	Preview Result
accountLoadBalancerMonitorsUpdateMonitor	PUT /accounts/{account_id}/load_balancers/monitors/{monitor_id}	Update Monitor

accountLoadBalancerMonitorsCreateMonitor

LoadBalancingMonitorResponseSingle accountLoadBalancerMonitorsCreateMonitor(accountId, loadBalancingMonitorEditable)

Create Monitor

Create a configured monitor.

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

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

Parameters

Name	Type	Description	Notes
accountId	String
loadBalancingMonitorEditable	LoadBalancingMonitorEditable

Return type

LoadBalancingMonitorResponseSingle

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]

accountLoadBalancerMonitorsDeleteMonitor

LoadBalancingIdResponse accountLoadBalancerMonitorsDeleteMonitor(monitorId, accountId)

Delete Monitor

Delete a configured monitor.

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

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

Parameters

Name	Type	Description	Notes
monitorId	String
accountId	String

Return type

LoadBalancingIdResponse

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]

accountLoadBalancerMonitorsListMonitorReferences

LoadBalancingMonitorReferencesResponse accountLoadBalancerMonitorsListMonitorReferences(monitorId, accountId)

List Monitor References

Get the list of resources that reference the provided monitor.

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

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

Parameters

Name	Type	Description	Notes
monitorId	String
accountId	String

Return type

LoadBalancingMonitorReferencesResponse

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]

accountLoadBalancerMonitorsListMonitors

LoadBalancingMonitorResponseCollection accountLoadBalancerMonitorsListMonitors(accountId)

List Monitors

List configured monitors for 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().getAccountLoadBalancerMonitorsApi();
final String accountId = accountId_example; // String | 

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

Parameters

Name	Type	Description	Notes
accountId	String

Return type

LoadBalancingMonitorResponseCollection

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]

accountLoadBalancerMonitorsMonitorDetails

LoadBalancingMonitorResponseSingle accountLoadBalancerMonitorsMonitorDetails(monitorId, accountId)

Monitor Details

List a single configured monitor for 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().getAccountLoadBalancerMonitorsApi();
final String monitorId = monitorId_example; // String | 
final String accountId = accountId_example; // String | 

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

Parameters

Name	Type	Description	Notes
monitorId	String
accountId	String

Return type

LoadBalancingMonitorResponseSingle

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]

accountLoadBalancerMonitorsPatchMonitor

LoadBalancingMonitorResponseSingle accountLoadBalancerMonitorsPatchMonitor(monitorId, accountId, loadBalancingMonitorEditable)

Patch Monitor

Apply changes to an existing monitor, overwriting the supplied properties.

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().getAccountLoadBalancerMonitorsApi();
final String monitorId = monitorId_example; // String | 
final String accountId = accountId_example; // String | 
final LoadBalancingMonitorEditable loadBalancingMonitorEditable = ; // LoadBalancingMonitorEditable | 

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

Parameters

Name	Type	Description	Notes
monitorId	String
accountId	String
loadBalancingMonitorEditable	LoadBalancingMonitorEditable

Return type

LoadBalancingMonitorResponseSingle

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]

accountLoadBalancerMonitorsPreviewMonitor

LoadBalancingPreviewResponse accountLoadBalancerMonitorsPreviewMonitor(monitorId, accountId, loadBalancingMonitorEditable)

Preview Monitor

Preview pools using the specified monitor with provided monitor details. The returned preview_id can be used in the preview endpoint to retrieve the results.

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().getAccountLoadBalancerMonitorsApi();
final String monitorId = monitorId_example; // String | 
final String accountId = accountId_example; // String | 
final LoadBalancingMonitorEditable loadBalancingMonitorEditable = ; // LoadBalancingMonitorEditable | 

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

Parameters

Name	Type	Description	Notes
monitorId	String
accountId	String
loadBalancingMonitorEditable	LoadBalancingMonitorEditable

Return type

LoadBalancingPreviewResponse

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]

accountLoadBalancerMonitorsPreviewResult

LoadBalancingPreviewResultResponse accountLoadBalancerMonitorsPreviewResult(previewId, accountId)

Preview Result

Get the result of a previous preview operation using the provided preview_id.

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

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

Parameters

Name	Type	Description	Notes
previewId	String
accountId	String

Return type

LoadBalancingPreviewResultResponse

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]

accountLoadBalancerMonitorsUpdateMonitor

LoadBalancingMonitorResponseSingle accountLoadBalancerMonitorsUpdateMonitor(monitorId, accountId, loadBalancingMonitorEditable)

Update Monitor

Modify a configured monitor.

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().getAccountLoadBalancerMonitorsApi();
final String monitorId = monitorId_example; // String | 
final String accountId = accountId_example; // String | 
final LoadBalancingMonitorEditable loadBalancingMonitorEditable = ; // LoadBalancingMonitorEditable | 

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

Parameters

Name	Type	Description	Notes
monitorId	String
accountId	String
loadBalancingMonitorEditable	LoadBalancingMonitorEditable

Return type

LoadBalancingMonitorResponseSingle

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

AccountLoadBalancerMonitorsApi.md

Latest commit

History

AccountLoadBalancerMonitorsApi.md

File metadata and controls

cloudflare_dart.api.AccountLoadBalancerMonitorsApi

Load the API package

accountLoadBalancerMonitorsCreateMonitor

Example

Parameters

Return type

Authorization

HTTP request headers

accountLoadBalancerMonitorsDeleteMonitor

Example

Parameters

Return type

Authorization

HTTP request headers

accountLoadBalancerMonitorsListMonitorReferences

Example

Parameters

Return type

Authorization

HTTP request headers

accountLoadBalancerMonitorsListMonitors

Example

Parameters

Return type

Authorization

HTTP request headers

accountLoadBalancerMonitorsMonitorDetails

Example

Parameters

Return type

Authorization

HTTP request headers

accountLoadBalancerMonitorsPatchMonitor

Example

Parameters

Return type

Authorization

HTTP request headers

accountLoadBalancerMonitorsPreviewMonitor

Example

Parameters

Return type

Authorization

HTTP request headers

accountLoadBalancerMonitorsPreviewResult

Example

Parameters

Return type

Authorization

HTTP request headers

accountLoadBalancerMonitorsUpdateMonitor

Example

Parameters

Return type

Authorization

HTTP request headers