List Monitor Groups

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

Path ParametersExpand Collapse

account_id: string

Identifier.

maxLength32

ReturnsExpand Collapse

errors: array of ResponseInfo { code, message, documentation_url, source }

code: number

minimum1000

message: string

documentation_url: optional string

source: optional object { pointer }

pointer: optional string

messages: array of ResponseInfo { code, message, documentation_url, source }

code: number

minimum1000

message: string

documentation_url: optional string

source: optional object { pointer }

pointer: optional string

result: array of MonitorGroup { id, description, members, 2 more }

id: string

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

description: string

A short description of the monitor group

members: array of object { enabled, monitor_id, monitoring_only, 3 more }

List of monitors in this group

enabled: boolean

Whether this monitor is enabled in the group

monitor_id: string

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

monitoring_only: boolean

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

must_be_healthy: boolean

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

created_at: optional string

The timestamp of when the monitor was added to the group

formatdate-time

updated_at: optional string

The timestamp of when the monitor group member was last updated

formatdate-time

created_at: optional string

The timestamp of when the monitor group was created

formatdate-time

updated_at: optional string

The timestamp of when the monitor group was last updated

formatdate-time

success: true

Whether the API call was successful.

result_info: optional object { count, page, per_page, 2 more }

count: optional number

Total number of results on the current page.

page: optional number

Current page within paginated list of results.

per_page: optional number

Number of results per page.

total_count: optional number

Total results available without any search parameters.

total_pages: optional number

Total number of pages available.

List Monitor Groups

curl https://api.cloudflare.com/client/v4/accounts/$ACCOUNT_ID/load_balancers/monitor_groups \
    -H "Authorization: Bearer $CLOUDFLARE_API_TOKEN"

{
  "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
  }
}