---
title: Monitor Groups
---

[Skip to content](#_top)

[API Reference](https://developers.cloudflare.com/api/python)

[Load Balancers](https://developers.cloudflare.com/api/python/resources/load_balancers)

Copy Markdown

Open in **Claude**Open in **ChatGPT**Open in **Cursor**

---

**Copy Markdown****View as Markdown**

# Monitor Groups

##### [List Monitor Groups](https://developers.cloudflare.com/api/python/resources/load_balancers/subresources/monitor_groups/methods/list)

load\_balancers.monitor\_groups.list(MonitorGroupListParams\*\*kwargs) -> SyncSinglePage\[[MonitorGroup](<https://developers.cloudflare.com/api/python/resources/load_balancers#(resource)%20load_balancers.monitor_groups%20%3E%20(model)%20monitor_group%20%3E%20(schema)>)]

GET/accounts/{account\_id}/load\_balancers/monitor\_groups

##### [Monitor Group Details](https://developers.cloudflare.com/api/python/resources/load_balancers/subresources/monitor_groups/methods/get)

load\_balancers.monitor\_groups.get(strmonitor\_group\_id, MonitorGroupGetParams\*\*kwargs) -> [MonitorGroup](<https://developers.cloudflare.com/api/python/resources/load_balancers#(resource)%20load_balancers.monitor_groups%20%3E%20(model)%20monitor_group%20%3E%20(schema)>)

GET/accounts/{account\_id}/load\_balancers/monitor\_groups/{monitor\_group\_id}

##### [Create Monitor Group](https://developers.cloudflare.com/api/python/resources/load_balancers/subresources/monitor_groups/methods/create)

load\_balancers.monitor\_groups.create(MonitorGroupCreateParams\*\*kwargs) -> [MonitorGroup](<https://developers.cloudflare.com/api/python/resources/load_balancers#(resource)%20load_balancers.monitor_groups%20%3E%20(model)%20monitor_group%20%3E%20(schema)>)

POST/accounts/{account\_id}/load\_balancers/monitor\_groups

##### [Update Monitor Group](https://developers.cloudflare.com/api/python/resources/load_balancers/subresources/monitor_groups/methods/update)

load\_balancers.monitor\_groups.update(strmonitor\_group\_id, MonitorGroupUpdateParams\*\*kwargs) -> [MonitorGroup](<https://developers.cloudflare.com/api/python/resources/load_balancers#(resource)%20load_balancers.monitor_groups%20%3E%20(model)%20monitor_group%20%3E%20(schema)>)

PUT/accounts/{account\_id}/load\_balancers/monitor\_groups/{monitor\_group\_id}

##### [Patch Monitor Group](https://developers.cloudflare.com/api/python/resources/load_balancers/subresources/monitor_groups/methods/edit)

load\_balancers.monitor\_groups.edit(strmonitor\_group\_id, MonitorGroupEditParams\*\*kwargs) -> [MonitorGroup](<https://developers.cloudflare.com/api/python/resources/load_balancers#(resource)%20load_balancers.monitor_groups%20%3E%20(model)%20monitor_group%20%3E%20(schema)>)

PATCH/accounts/{account\_id}/load\_balancers/monitor\_groups/{monitor\_group\_id}

##### [Delete Monitor Group](https://developers.cloudflare.com/api/python/resources/load_balancers/subresources/monitor_groups/methods/delete)

load\_balancers.monitor\_groups.delete(strmonitor\_group\_id, MonitorGroupDeleteParams\*\*kwargs) -> [MonitorGroup](<https://developers.cloudflare.com/api/python/resources/load_balancers#(resource)%20load_balancers.monitor_groups%20%3E%20(model)%20monitor_group%20%3E%20(schema)>)

DELETE/accounts/{account\_id}/load\_balancers/monitor\_groups/{monitor\_group\_id}

##### ModelsExpand Collapse

<details>

<summary>

class MonitorGroup: …

</summary>

id: str

The ID of the Monitor Group to use for checking the health of origins within this pool.

<a href="#(resource)%20load_balancers.monitor_groups%20%3E%20(model)%20monitor_group%20%3E%20(schema)%20%3E%20(property)%20id">Link to this property</a>

description: str

A short description of the monitor group

<a href="#(resource)%20load_balancers.monitor_groups%20%3E%20(model)%20monitor_group%20%3E%20(schema)%20%3E%20(property)%20description">Link to this property</a>

<details>

<summary>

members: List\[Member]

List of monitors in this group

</summary>

enabled: bool

Whether this monitor is enabled in the group

<a href="#(resource)%20load_balancers.monitor_groups%20%3E%20(model)%20monitor_group%20%3E%20(schema)%20%3E%20(property)%20members%20%3E%20(items)%20%3E%20(property)%20enabled">Link to this property</a>

monitor\_id: str

The ID of the Monitor to use for checking the health of origins within this pool.

<a href="#(resource)%20load_balancers.monitor_groups%20%3E%20(model)%20monitor_group%20%3E%20(schema)%20%3E%20(property)%20members%20%3E%20(items)%20%3E%20(property)%20monitor_id">Link to this property</a>

monitoring\_only: bool

Whether this monitor is used for monitoring only (does not affect pool health)

<a href="#(resource)%20load_balancers.monitor_groups%20%3E%20(model)%20monitor_group%20%3E%20(schema)%20%3E%20(property)%20members%20%3E%20(items)%20%3E%20(property)%20monitoring_only">Link to this property</a>

must\_be\_healthy: bool

Whether this monitor must be healthy for the pool to be considered healthy

<a href="#(resource)%20load_balancers.monitor_groups%20%3E%20(model)%20monitor_group%20%3E%20(schema)%20%3E%20(property)%20members%20%3E%20(items)%20%3E%20(property)%20must_be_healthy">Link to this property</a>

created\_at: Optional\[datetime]

The timestamp of when the monitor was added to the group

formatdate-time

<a href="#(resource)%20load_balancers.monitor_groups%20%3E%20(model)%20monitor_group%20%3E%20(schema)%20%3E%20(property)%20members%20%3E%20(items)%20%3E%20(property)%20created_at">Link to this property</a>

updated\_at: Optional\[datetime]

The timestamp of when the monitor group member was last updated

formatdate-time

<a href="#(resource)%20load_balancers.monitor_groups%20%3E%20(model)%20monitor_group%20%3E%20(schema)%20%3E%20(property)%20members%20%3E%20(items)%20%3E%20(property)%20updated_at">Link to this property</a>

</details>

<a href="#(resource)%20load_balancers.monitor_groups%20%3E%20(model)%20monitor_group%20%3E%20(schema)%20%3E%20(property)%20members">Link to this property</a>

created\_on: Optional\[datetime]

The timestamp of when the monitor group was created

formatdate-time

<a href="#(resource)%20load_balancers.monitor_groups%20%3E%20(model)%20monitor_group%20%3E%20(schema)%20%3E%20(property)%20created_on">Link to this property</a>

modified\_on: Optional\[datetime]

The timestamp of when the monitor group was last updated

formatdate-time

<a href="#(resource)%20load_balancers.monitor_groups%20%3E%20(model)%20monitor_group%20%3E%20(schema)%20%3E%20(property)%20modified_on">Link to this property</a>

</details>

[Link to this property](<#(resource)%20load_balancers.monitor_groups%20%3E%20(model)%20monitor_group%20%3E%20(schema)>)

#### Monitor GroupsReferences

##### [List Monitor Group References](https://developers.cloudflare.com/api/python/resources/load_balancers/subresources/monitor_groups/subresources/references/methods/get)

load\_balancers.monitor\_groups.references.get(strmonitor\_group\_id, ReferenceGetParams\*\*kwargs) -> SyncSinglePage\[[ReferenceGetResponse](<https://developers.cloudflare.com/api/python/resources/load_balancers#(resource)%20load_balancers.monitor_groups.references%20%3E%20(model)%20reference_get_response%20%3E%20(schema)>)]

GET/accounts/{account\_id}/load\_balancers/monitor\_groups/{monitor\_group\_id}/references

##### ModelsExpand Collapse

<details>

<summary>

class ReferenceGetResponse: …

</summary>

<details>

<summary>

reference\_type: Optional\[Literal\["\*", "referral", "referrer"]]

</summary>

One of the following:

"\*"

<a href="#(resource)%20load_balancers.monitor_groups.references%20%3E%20(model)%20reference_get_response%20%3E%20(schema)%20%3E%20(property)%20reference_type%20%3E%20(member)%200">Link to this property</a>

"referral"

<a href="#(resource)%20load_balancers.monitor_groups.references%20%3E%20(model)%20reference_get_response%20%3E%20(schema)%20%3E%20(property)%20reference_type%20%3E%20(member)%201">Link to this property</a>

"referrer"

<a href="#(resource)%20load_balancers.monitor_groups.references%20%3E%20(model)%20reference_get_response%20%3E%20(schema)%20%3E%20(property)%20reference_type%20%3E%20(member)%202">Link to this property</a>

</details>

<a href="#(resource)%20load_balancers.monitor_groups.references%20%3E%20(model)%20reference_get_response%20%3E%20(schema)%20%3E%20(property)%20reference_type">Link to this property</a>

resource\_id: Optional\[str]

<a href="#(resource)%20load_balancers.monitor_groups.references%20%3E%20(model)%20reference_get_response%20%3E%20(schema)%20%3E%20(property)%20resource_id">Link to this property</a>

resource\_name: Optional\[str]

<a href="#(resource)%20load_balancers.monitor_groups.references%20%3E%20(model)%20reference_get_response%20%3E%20(schema)%20%3E%20(property)%20resource_name">Link to this property</a>

resource\_type: Optional\[str]

<a href="#(resource)%20load_balancers.monitor_groups.references%20%3E%20(model)%20reference_get_response%20%3E%20(schema)%20%3E%20(property)%20resource_type">Link to this property</a>

</details>

[Link to this property](<#(resource)%20load_balancers.monitor_groups.references%20%3E%20(model)%20reference_get_response%20%3E%20(schema)>)