Search + K

Command Palette

Search for a command to run...

Sign In

Get Cloudflare Tunnel connector

GET /accounts/{account_id}/cfd_tunnel/{tunnel_id}/connectors/{connector_id}
Copy endpoint
https://api.cloudflare.com/client/v4

Fetches connector and connection details for a Cloudflare Tunnel.

Parameters

path Path Parameters

Name Type
account_id required
type TunnelAccountId = string
tunnel_id required
type TunnelTunnelId = string
connector_id required
type TunnelClientId = string

Responses

200 application/json

Get Cloudflare Tunnel connector response

type TunnelTunnelClientResponse = interface TunnelApiResponseCommon {
errors: TunnelMessages
type TunnelMessages = { code: number;message: string; }[]
;
messages: TunnelMessages
type TunnelMessages = { code: number;message: string; }[]
;
result: {} | unknown[] | string;
success: true;
}
& { result?: TunnelTunnelClient

A client (typically cloudflared) that maintains connections to a Cloudflare data center.

interface TunnelTunnelClient {
arch?: TunnelArch;
config_version?: TunnelConfigVersion;
conns?: TunnelConnections;
features?: TunnelFeatures;
id?: TunnelConnectionId;
run_at?: TunnelRunAt;
version?: TunnelVersion;
}
; }

Client Errors

4XX application/json

Get Cloudflare Tunnel connector response failure

type TunnelTunnelClientResponse = interface TunnelApiResponseCommon {
errors: TunnelMessages
type TunnelMessages = { code: number;message: string; }[]
;
messages: TunnelMessages
type TunnelMessages = { code: number;message: string; }[]
;
result: {} | unknown[] | string;
success: true;
}
& { result?: TunnelTunnelClient

A client (typically cloudflared) that maintains connections to a Cloudflare data center.

interface TunnelTunnelClient {
arch?: TunnelArch;
config_version?: TunnelConfigVersion;
conns?: TunnelConnections;
features?: TunnelFeatures;
id?: TunnelConnectionId;
run_at?: TunnelRunAt;
version?: TunnelVersion;
}
; }
& interface TunnelApiResponseCommonFailure {
errors: TunnelMessages
type TunnelMessages = { code: number;message: string; }[]
;
messages: TunnelMessages
type TunnelMessages = { code: number;message: string; }[]
;
result: null;
success: false;
}