Search + K

Command Palette

Search for a command to run...

Sign In

List Monitor References

GET /accounts/{account_id}/load_balancers/monitors/{monitor_id}/references
Copy endpoint
https://api.cloudflare.com/client/v4

Get the list of resources that reference the provided monitor.

Parameters

path Path Parameters

Name Type
monitor_id required
type LoadBalancingIdentifier = string
account_id required
type LoadBalancingComponentsSchemasIdentifier = string

Responses

200 application/json

List Monitor References response.

type LoadBalancingMonitorReferencesResponse = interface LoadBalancingApiResponseCommon {
errors: LoadBalancingMessages
type LoadBalancingMessages = { code: number;message: string; }[]
;
messages: LoadBalancingMessages
type LoadBalancingMessages = { code: number;message: string; }[]
;
success: true;
}
& { result?: {
reference_type?: "*" | "referral" | "referrer";
resource_id?: string;
resource_name?: string;
resource_type?: string;
}
[]
; }

Client Errors

4XX application/json

List Monitor References response failure.

type LoadBalancingMonitorReferencesResponse = interface LoadBalancingApiResponseCommon {
errors: LoadBalancingMessages
type LoadBalancingMessages = { code: number;message: string; }[]
;
messages: LoadBalancingMessages
type LoadBalancingMessages = { code: number;message: string; }[]
;
success: true;
}
& { result?: {
reference_type?: "*" | "referral" | "referrer";
resource_id?: string;
resource_name?: string;
resource_type?: string;
}
[]
; }
& interface LoadBalancingApiResponseCommonFailure {
errors: LoadBalancingMessages
type LoadBalancingMessages = { code: number;message: string; }[]
;
messages: LoadBalancingMessages
type LoadBalancingMessages = { code: number;message: string; }[]
;
result: null;
success: false;
}