Skip to content

AccountLoadBalancerMonitorGroupsApi.md

Latest commit

 

History

History
393 lines (283 loc) · 16.8 KB

AccountLoadBalancerMonitorGroupsApi.md

File metadata and controls

393 lines (283 loc) · 16.8 KB

cloudflare_dart.api.AccountLoadBalancerMonitorGroupsApi

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
accountLoadBalancerMonitorGroupsCreateMonitorGroup POST /accounts/{account_id}/load_balancers/monitor_groups Create Monitor Group
accountLoadBalancerMonitorGroupsDeleteMonitorGroup DELETE /accounts/{account_id}/load_balancers/monitor_groups/{monitor_group_id} Delete Monitor Group
accountLoadBalancerMonitorGroupsListMonitorGroupReferences GET /accounts/{account_id}/load_balancers/monitor_groups/{monitor_group_id}/references List Monitor Group References
accountLoadBalancerMonitorGroupsListMonitorGroups GET /accounts/{account_id}/load_balancers/monitor_groups List Monitor Groups
accountLoadBalancerMonitorGroupsMonitorGroupDetails GET /accounts/{account_id}/load_balancers/monitor_groups/{monitor_group_id} Monitor Group Details
accountLoadBalancerMonitorGroupsPatchMonitorGroup PATCH /accounts/{account_id}/load_balancers/monitor_groups/{monitor_group_id} Patch Monitor Group
accountLoadBalancerMonitorGroupsUpdateMonitorGroup PUT /accounts/{account_id}/load_balancers/monitor_groups/{monitor_group_id} Update Monitor Group

accountLoadBalancerMonitorGroupsCreateMonitorGroup

LoadBalancingMonitorGroupSingleResponse accountLoadBalancerMonitorGroupsCreateMonitorGroup(accountId, loadBalancingMonitorGroup)

Create Monitor Group

Create a new monitor group.

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

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

Parameters

Name Type Description Notes
accountId String
loadBalancingMonitorGroup LoadBalancingMonitorGroup

Return type

LoadBalancingMonitorGroupSingleResponse

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]

accountLoadBalancerMonitorGroupsDeleteMonitorGroup

LoadBalancingMonitorGroupSingleResponse accountLoadBalancerMonitorGroupsDeleteMonitorGroup(monitorGroupId, accountId)

Delete Monitor Group

Delete a configured monitor group.

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

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

Parameters

Name Type Description Notes
monitorGroupId String
accountId String

Return type

LoadBalancingMonitorGroupSingleResponse

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]

accountLoadBalancerMonitorGroupsListMonitorGroupReferences

LoadBalancingMonitorGroupReferencesResponse accountLoadBalancerMonitorGroupsListMonitorGroupReferences(monitorGroupId, accountId)

List Monitor Group References

Get the list of resources that reference the provided monitor group.

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

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

Parameters

Name Type Description Notes
monitorGroupId String
accountId String

Return type

LoadBalancingMonitorGroupReferencesResponse

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]

accountLoadBalancerMonitorGroupsListMonitorGroups

LoadBalancingMonitorGroupResponseCollection accountLoadBalancerMonitorGroupsListMonitorGroups(accountId)

List Monitor Groups

List configured monitor groups.

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

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

Parameters

Name Type Description Notes
accountId String

Return type

LoadBalancingMonitorGroupResponseCollection

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]

accountLoadBalancerMonitorGroupsMonitorGroupDetails

LoadBalancingMonitorGroupSingleResponse accountLoadBalancerMonitorGroupsMonitorGroupDetails(monitorGroupId, accountId)

Monitor Group Details

Fetch a single configured monitor group.

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

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

Parameters

Name Type Description Notes
monitorGroupId String
accountId String

Return type

LoadBalancingMonitorGroupSingleResponse

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]

accountLoadBalancerMonitorGroupsPatchMonitorGroup

LoadBalancingMonitorGroupSingleResponse accountLoadBalancerMonitorGroupsPatchMonitorGroup(monitorGroupId, accountId, loadBalancingMonitorGroup)

Patch Monitor Group

Apply changes to an existing monitor group, 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().getAccountLoadBalancerMonitorGroupsApi();
final String monitorGroupId = monitorGroupId_example; // String | 
final String accountId = accountId_example; // String | 
final LoadBalancingMonitorGroup loadBalancingMonitorGroup = ; // LoadBalancingMonitorGroup | 

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

Parameters

Name Type Description Notes
monitorGroupId String
accountId String
loadBalancingMonitorGroup LoadBalancingMonitorGroup

Return type

LoadBalancingMonitorGroupSingleResponse

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]

accountLoadBalancerMonitorGroupsUpdateMonitorGroup

LoadBalancingMonitorGroupSingleResponse accountLoadBalancerMonitorGroupsUpdateMonitorGroup(monitorGroupId, accountId, loadBalancingMonitorGroup)

Update Monitor Group

Modify a configured monitor group.

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().getAccountLoadBalancerMonitorGroupsApi();
final String monitorGroupId = monitorGroupId_example; // String | 
final String accountId = accountId_example; // String | 
final LoadBalancingMonitorGroup loadBalancingMonitorGroup = ; // LoadBalancingMonitorGroup | 

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

Parameters

Name Type Description Notes
monitorGroupId String
accountId String
loadBalancingMonitorGroup LoadBalancingMonitorGroup

Return type

LoadBalancingMonitorGroupSingleResponse

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]