List Monitor Group References

client.LoadBalancers.MonitorGroups.References.Get(ctx, monitorGroupID, query) (*SinglePage[MonitorGroupReferenceGetResponse], error)

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

query MonitorGroupReferenceGetParams

AccountID param.Field[string]

Identifier.

maxLength32

ReturnsExpand Collapse

type MonitorGroupReferenceGetResponse struct{…}

ReferenceType MonitorGroupReferenceGetResponseReferenceTypeOptional

One of the following:

const MonitorGroupReferenceGetResponseReferenceTypeStar MonitorGroupReferenceGetResponseReferenceType = "*"

const MonitorGroupReferenceGetResponseReferenceTypeReferral MonitorGroupReferenceGetResponseReferenceType = "referral"

const MonitorGroupReferenceGetResponseReferenceTypeReferrer MonitorGroupReferenceGetResponseReferenceType = "referrer"

ResourceID stringOptional

ResourceName stringOptional

ResourceType stringOptional

List Monitor Group References

package main

import (
  "context"
  "fmt"

  "github.com/cloudflare/cloudflare-go"
  "github.com/cloudflare/cloudflare-go/load_balancers"
  "github.com/cloudflare/cloudflare-go/option"
)

func main() {
  client := cloudflare.NewClient(
    option.WithAPIToken("Sn3lZJTBX6kkg7OdcBUAxOO963GEIyGQqnFTOFYY"),
  )
  page, err := client.LoadBalancers.MonitorGroups.References.Get(
    context.TODO(),
    "f1aba936b94213e5b8dca0c0dbf1f9cc",
    load_balancers.MonitorGroupReferenceGetParams{
      AccountID: cloudflare.F("023e105f4ecef8ad9ca31a8372d0c353"),
    },
  )
  if err != nil {
    panic(err.Error())
  }
  fmt.Printf("%+v\n", page)
}

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