List Monitor Group References

client.loadBalancers.monitorGroups.references.get(, , ?): SinglePage<ReferenceGetResponse { reference_type, resource_id, resource_name, resource_type } >

GET/accounts/{account_id}/load_balancers/monitor_groups/{monitor_group_id}/references

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

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

monitorGroupId: string

params: ReferenceGetParams { account_id }

account_id: string

Identifier.

maxLength32

ReturnsExpand Collapse

ReferenceGetResponse { reference_type, resource_id, resource_name, resource_type }

reference_type?: "*" | "referral" | "referrer"

One of the following:

"*"

"referral"

"referrer"

resource_id?: string

resource_name?: string

resource_type?: string

List Monitor Group References

import Cloudflare from 'cloudflare';

const client = new Cloudflare({
  apiToken: process.env['CLOUDFLARE_API_TOKEN'], // This is the default and can be omitted
});

// Automatically fetches more pages as needed.
for await (const referenceGetResponse of client.loadBalancers.monitorGroups.references.get(
  'f1aba936b94213e5b8dca0c0dbf1f9cc',
  { account_id: '023e105f4ecef8ad9ca31a8372d0c353' },
)) {
  console.log(referenceGetResponse.resource_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": [
    {
      "reference_type": "referrer",
      "resource_id": "17b5962d775c646f3f9725cbc7a53df4",
      "resource_name": "primary-dc-1",
      "resource_type": "pool"
    }
  ],
  "success": true
}

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": [
    {
      "reference_type": "referrer",
      "resource_id": "17b5962d775c646f3f9725cbc7a53df4",
      "resource_name": "primary-dc-1",
      "resource_type": "pool"
    }
  ],
  "success": true
}