Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
94 changes: 94 additions & 0 deletions docs/content/2.api/0.accounts/19.load-balancer-monitor-groups.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,94 @@
---
title: Load Balancer Monitor Groups
description: Manage groups of monitors that can be applied together to load balancer pools.
navigation:
title: Load Balancer Monitor Groups
---

# Load Balancer Monitor Groups

Manage groups of monitors that can be applied together to load balancer pools.

:button-link[Cloudflare API docs]{icon="heroicons-outline:external-link" href="https://developers.cloudflare.com/api/operations/account-load-balancer-monitor-groups-list-monitor-groups" blank}

## List

List configured load balancer monitor groups for an account.

```php [php]
$response = $client->accounts()->loadBalancerMonitorGroups()->list('account_id');
```

## Create

Create a new load balancer monitor group for an account.

```php [php]
$values = [
'description' => 'Primary datacenter monitors',
'members' => [
[
'monitor_id' => 'monitor_id',
'enabled' => true,
'monitoring_only' => false,
'must_be_healthy' => true,
],
],
];

$response = $client->accounts()->loadBalancerMonitorGroups()->create('account_id', $values);
```

## Details

Get a single configured load balancer monitor group for an account.

```php [php]
$response = $client->accounts()->loadBalancerMonitorGroups()->details('account_id', 'monitor_group_id');
```

## Patch

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

```php [php]
$response = $client->accounts()->loadBalancerMonitorGroups()->patch('account_id', 'monitor_group_id', [
'description' => 'Secondary datacenter monitors',
]);
```

## Update

Update an existing load balancer monitor group for an account.

```php [php]
$values = [
'description' => 'Primary datacenter monitors',
'members' => [
[
'monitor_id' => 'monitor_id',
'enabled' => true,
'monitoring_only' => false,
'must_be_healthy' => true,
],
],
];

$response = $client->accounts()->loadBalancerMonitorGroups()->update('account_id', 'monitor_group_id', $values);
```

## Delete

Delete a load balancer monitor group for an account.

```php [php]
$response = $client->accounts()->loadBalancerMonitorGroups()->delete('account_id', 'monitor_group_id');
```

## References

List the pools that reference a given monitor group.

```php [php]
$response = $client->accounts()->loadBalancerMonitorGroups()->references('account_id', 'monitor_group_id');
```
36 changes: 36 additions & 0 deletions docs/content/2.api/0.accounts/6.load-balancers.md
Original file line number Diff line number Diff line change
Expand Up @@ -62,3 +62,39 @@ Delete a load balancer for an account.
```php [php]
$response = $client->accounts()->loadBalancers()->delete('account_id', 'load_balancer_id');
```

## Patch

Apply changes to an existing load balancer, overwriting only the supplied properties.

```php [php]
$response = $client->accounts()->loadBalancers()->patch('account_id', 'load_balancer_id', [
'enabled' => false,
]);
```

## Usage

Fetch the current load balancer usage for an account.

```php [php]
$response = $client->accounts()->loadBalancers()->usage('account_id');
```

## Search

Search load balancing resources (Load Balancers, Pools, Monitors) by name.

```php [php]
$response = $client->accounts()->loadBalancers()->search('account_id', [
'query' => 'www.example.com',
]);
```

## Preview Result

Get the result of a previously requested monitor or pool preview.

```php [php]
$response = $client->accounts()->loadBalancers()->previewResult('account_id', 'preview_id');
```
18 changes: 18 additions & 0 deletions docs/content/2.api/0.accounts/7.load-balancer-monitors.md
Original file line number Diff line number Diff line change
Expand Up @@ -73,3 +73,21 @@ $values = [

$response = $client->accounts()->loadBalancerMonitors()->preview('account_id', 'monitor_id', $values);
```

## Patch

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

```php [php]
$response = $client->accounts()->loadBalancerMonitors()->patch('account_id', 'monitor_id', [
'method' => 'POST',
]);
```

## References

List the load balancers and pools that reference a given monitor.

```php [php]
$response = $client->accounts()->loadBalancerMonitors()->references('account_id', 'monitor_id');
```
28 changes: 28 additions & 0 deletions docs/content/2.api/0.accounts/8.load-balancer-pools.md
Original file line number Diff line number Diff line change
Expand Up @@ -91,3 +91,31 @@ $values = [

$response = $client->accounts()->loadBalancerPools()->preview('account_id', 'pool_id', $values);
```

## Patch

Apply changes to an existing pool, overwriting only the supplied properties.

```php [php]
$response = $client->accounts()->loadBalancerPools()->patch('account_id', 'pool_id', [
'enabled' => false,
]);
```

## Patch Multiple Pools

Apply changes to a number of existing pools, overwriting the supplied properties. Returns the list of affected pools.

```php [php]
$response = $client->accounts()->loadBalancerPools()->patchMultiplePools('account_id', [
['id' => 'pool_id', 'enabled' => false],
]);
```

## References

List the load balancers that reference a given pool.

```php [php]
$response = $client->accounts()->loadBalancerPools()->references('account_id', 'pool_id');
```
8 changes: 8 additions & 0 deletions docs/content/2.api/0.accounts/9.load-balancer-regions.md
Original file line number Diff line number Diff line change
Expand Up @@ -18,3 +18,11 @@ List Load Balancer region mappings for an account.
```php [php]
$response = $client->accounts()->loadBalancerRegions()->list('account_id');
```

## Details

Get a single Load Balancer region mapping for an account.

```php [php]
$response = $client->accounts()->loadBalancerRegions()->details('account_id', 'WNAM');
```
10 changes: 10 additions & 0 deletions docs/content/2.api/1.zones/15.load-balancers.md
Original file line number Diff line number Diff line change
Expand Up @@ -62,3 +62,13 @@ Delete a load balancer for a zone.
```php [php]
$response = $client->zones()->loadBalancers()->delete('zone_id', 'load_balancer_id');
```

## Patch

Apply changes to an existing load balancer, overwriting only the supplied properties.

```php [php]
$response = $client->zones()->loadBalancers()->patch('zone_id', 'load_balancer_id', [
'enabled' => false,
]);
```
58 changes: 29 additions & 29 deletions docs/content/4.coverage.md
Original file line number Diff line number Diff line change
Expand Up @@ -141,48 +141,48 @@ Please find below implemented endpoints.
- [ ] Billing Profile Details

## Account Load Balancer Monitor Groups
- [ ] List Monitor Groups
- [ ] Create Monitor Group
- [ ] Delete Monitor Group
- [ ] Monitor Group Details
- [ ] Patch Monitor Group
- [ ] Update Monitor Group
- [ ] List Monitor Group References
- [x] [List Monitor Groups](/api/accounts/load-balancer-monitor-groups#list)
- [x] [Create Monitor Group](/api/accounts/load-balancer-monitor-groups#create)
- [x] [Delete Monitor Group](/api/accounts/load-balancer-monitor-groups#delete)
- [x] [Monitor Group Details](/api/accounts/load-balancer-monitor-groups#details)
- [x] [Patch Monitor Group](/api/accounts/load-balancer-monitor-groups#patch)
- [x] [Update Monitor Group](/api/accounts/load-balancer-monitor-groups#update)
- [x] [List Monitor Group References](/api/accounts/load-balancer-monitor-groups#references)

## Account Load Balancer Monitors
- [x] [List Monitors](/api/accounts/load-balancer-monitors#list)
- [x] [Create Monitor](/api/accounts/load-balancer-monitors#create)
- [x] [Delete Monitor](/api/accounts/load-balancer-monitors#delete)
- [x] [Monitor Details](/api/accounts/load-balancer-monitors#details)
- [ ] Patch Monitor
- [x] [Patch Monitor](/api/accounts/load-balancer-monitors#patch)
- [x] [Update Monitor](/api/accounts/load-balancer-monitors#update)
- [x] [Preview Monitor](/api/accounts/load-balancer-monitors#preview)
- [ ] List Monitor References
- [ ] Preview Result
- [x] [List Monitor References](/api/accounts/load-balancer-monitors#references)
- [x] [Preview Result](/api/accounts/load-balancers#preview-result)

## Account Load Balancer Pools
- [x] [List Pools](/api/accounts/load-balancer-pools#list)
- [ ] Patch Pools
- [x] [Patch Pools](/api/accounts/load-balancer-pools#patch-multiple-pools)
- [x] [Create Pool](/api/accounts/load-balancer-pools#create)
- [x] [Delete Pool](/api/accounts/load-balancer-pools#delete)
- [x] [Pool Details](/api/accounts/load-balancer-pools#details)
- [ ] Patch Pool
- [x] [Patch Pool](/api/accounts/load-balancer-pools#patch)
- [x] [Update Pool](/api/accounts/load-balancer-pools#update)
- [x] [Pool Health Details](/api/accounts/load-balancer-pools#health)
- [x] [Preview Pool](/api/accounts/load-balancer-pools#preview)
- [ ] List Pool References
- [x] [List Pool References](/api/accounts/load-balancer-pools#references)

## Account Load Balancer Search
- [ ] Search Resources
- [x] [Search Resources](/api/accounts/load-balancers#search)

## Account Load Balancers
- [ ] List Account Load Balancers
- [ ] Create Account Load Balancer
- [ ] List Load Balancer Usage
- [ ] Delete Account Load Balancer
- [ ] Account Load Balancer Details
- [ ] Patch Account Load Balancer
- [ ] Update Account Load Balancer
- [x] [List Account Load Balancers](/api/accounts/load-balancers#list)
- [x] [Create Account Load Balancer](/api/accounts/load-balancers#create)
- [x] [List Load Balancer Usage](/api/accounts/load-balancers#usage)
- [x] [Delete Account Load Balancer](/api/accounts/load-balancers#delete)
- [x] [Account Load Balancer Details](/api/accounts/load-balancers#details)
- [x] [Patch Account Load Balancer](/api/accounts/load-balancers#patch)
- [x] [Update Account Load Balancer](/api/accounts/load-balancers#update)

## Account Members
- [x] [List Members](/api/accounts/members#list)
Expand Down Expand Up @@ -1812,34 +1812,34 @@ Please find below implemented endpoints.
- [x] [Create Monitor](/api/accounts/load-balancer-monitors#create)
- [x] [Delete Monitor](/api/accounts/load-balancer-monitors#delete)
- [x] [Monitor Details](/api/accounts/load-balancer-monitors#details)
- [ ] Patch Monitor
- [x] [Patch Monitor](/api/accounts/load-balancer-monitors#patch)
- [x] [Update Monitor](/api/accounts/load-balancer-monitors#update)
- [x] [Preview Monitor](/api/accounts/load-balancer-monitors#preview)
- [ ] List Monitor References
- [ ] Preview Result
- [x] [List Monitor References](/api/accounts/load-balancer-monitors#references)
- [x] [Preview Result](/api/accounts/load-balancers#preview-result)

## Load Balancer Pools
- [x] [List Pools](/api/accounts/load-balancer-pools#list)
- [ ] Patch Pools
- [x] [Patch Pools](/api/accounts/load-balancer-pools#patch-multiple-pools)
- [x] [Create Pool](/api/accounts/load-balancer-pools#create)
- [x] [Delete Pool](/api/accounts/load-balancer-pools#delete)
- [x] [Pool Details](/api/accounts/load-balancer-pools#details)
- [ ] Patch Pool
- [x] [Patch Pool](/api/accounts/load-balancer-pools#patch)
- [x] [Update Pool](/api/accounts/load-balancer-pools#update)
- [x] [Pool Health Details](/api/accounts/load-balancer-pools#health)
- [x] [Preview Pool](/api/accounts/load-balancer-pools#preview)
- [ ] List Pool References
- [x] [List Pool References](/api/accounts/load-balancer-pools#references)

## Load Balancer Regions
- [x] [List Regions](/api/accounts/load-balancer-regions#list)
- [ ] Get Region
- [x] [Get Region](/api/accounts/load-balancer-regions#details)

## Load Balancers
- [x] [List Load Balancers](/api/zones/load-balancers#list)
- [x] [Create Load Balancer](/api/zones/load-balancers#create)
- [x] [Delete Load Balancer](/api/zones/load-balancers#delete)
- [x] [Load Balancer Details](/api/zones/load-balancers#details)
- [ ] Patch Load Balancer
- [x] [Patch Load Balancer](/api/zones/load-balancers#patch)
- [x] [Update Load Balancer](/api/zones/load-balancers#update)

## Log Explorer Datasets
Expand Down
11 changes: 11 additions & 0 deletions src/Endpoints/Accounts.php
Original file line number Diff line number Diff line change
Expand Up @@ -11,6 +11,7 @@
use Cloudflare\Endpoints\Accounts\LoadBalancerMonitors;
use Cloudflare\Endpoints\Accounts\LoadBalancerPools;
use Cloudflare\Endpoints\Accounts\LoadBalancerRegions;
use Cloudflare\Endpoints\Accounts\LoadBalancerMonitorGroups;
use Cloudflare\Endpoints\Accounts\R2Buckets;
use Cloudflare\Endpoints\Accounts\R2Cors;
use Cloudflare\Endpoints\Accounts\R2Lifecycle;
Expand Down Expand Up @@ -200,6 +201,16 @@ public function loadBalancerRegions(): LoadBalancerRegions
return new LoadBalancerRegions($this->getClient());
}

/**
* Account Load Balancer Monitor Groups
*
* @return \Cloudflare\Endpoints\Accounts\LoadBalancerMonitorGroups
*/
public function loadBalancerMonitorGroups(): LoadBalancerMonitorGroups
{
return new LoadBalancerMonitorGroups($this->getClient());
}

/**
* Account R2 Buckets
*
Expand Down
Loading
Loading