Skip to content
Cloudflare API
Start here
API Reference
Load Balancers
Monitor Groups

List Monitor Groups

load_balancers.monitor_groups.list(MonitorGroupListParams**kwargs) -> SyncSinglePage[MonitorGroup]
GET/accounts/{account_id}/load_balancers/monitor_groups

List configured monitor groups.

Security
API Token

The preferred authorization scheme for interacting with the Cloudflare API. Create a token.

Example:Authorization: Bearer Sn3lZJTBX6kkg7OdcBUAxOO963GEIyGQqnFTOFYY
API Email + API Key

The previous authorization scheme for interacting with the Cloudflare API, used in conjunction with a Global API key.

Example:X-Auth-Email: user@example.com

The previous authorization scheme for interacting with the Cloudflare API. When possible, use API tokens instead of Global API keys.

Example:X-Auth-Key: 144c9defac04969c7bfad8efaa8ea194
ParametersExpand Collapse
account_id: str

Identifier.

maxLength32
ReturnsExpand Collapse
class MonitorGroup: …
id: str

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

description: str

A short description of the monitor group

members: List[Member]

List of monitors in this group

enabled: bool

Whether this monitor is enabled in the group

monitor_id: str

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

monitoring_only: bool

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

must_be_healthy: bool

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

created_at: Optional[datetime]

The timestamp of when the monitor was added to the group

formatdate-time
updated_at: Optional[datetime]

The timestamp of when the monitor group member was last updated

formatdate-time
created_at: Optional[datetime]

The timestamp of when the monitor group was created

formatdate-time
updated_at: Optional[datetime]

The timestamp of when the monitor group was last updated

formatdate-time

List Monitor Groups

import os
from cloudflare import Cloudflare

client = Cloudflare(
    api_token=os.environ.get("CLOUDFLARE_API_TOKEN"),  # This is the default and can be omitted
)
page = client.load_balancers.monitor_groups.list(
    account_id="023e105f4ecef8ad9ca31a8372d0c353",
)
page = page.result[0]
print(page.id)
{
  "errors": [
    {
      "code": 1000,
      "message": "message",
      "documentation_url": "documentation_url",
      "source": {
        "pointer": "pointer"
      }
    }
  ],
  "messages": [
    {
      "code": 1000,
      "message": "message",
      "documentation_url": "documentation_url",
      "source": {
        "pointer": "pointer"
      }
    }
  ],
  "result": [
    {
      "id": "id",
      "description": "Primary datacenter monitors",
      "members": [
        {
          "enabled": true,
          "monitor_id": "monitor_id",
          "monitoring_only": false,
          "must_be_healthy": true,
          "created_at": "2014-01-01T05:20:00.12345Z",
          "updated_at": "2014-01-01T05:20:00.12345Z"
        }
      ],
      "created_at": "2014-01-01T05:20:00.12345Z",
      "updated_at": "2014-01-01T05:20:00.12345Z"
    }
  ],
  "success": true,
  "result_info": {
    "count": 20,
    "page": 1,
    "per_page": 20,
    "total_count": 2000,
    "total_pages": 100
  }
}
Returns Examples
{
  "errors": [
    {
      "code": 1000,
      "message": "message",
      "documentation_url": "documentation_url",
      "source": {
        "pointer": "pointer"
      }
    }
  ],
  "messages": [
    {
      "code": 1000,
      "message": "message",
      "documentation_url": "documentation_url",
      "source": {
        "pointer": "pointer"
      }
    }
  ],
  "result": [
    {
      "id": "id",
      "description": "Primary datacenter monitors",
      "members": [
        {
          "enabled": true,
          "monitor_id": "monitor_id",
          "monitoring_only": false,
          "must_be_healthy": true,
          "created_at": "2014-01-01T05:20:00.12345Z",
          "updated_at": "2014-01-01T05:20:00.12345Z"
        }
      ],
      "created_at": "2014-01-01T05:20:00.12345Z",
      "updated_at": "2014-01-01T05:20:00.12345Z"
    }
  ],
  "success": true,
  "result_info": {
    "count": 20,
    "page": 1,
    "per_page": 20,
    "total_count": 2000,
    "total_pages": 100
  }
}