Connections

List Cloudflare Tunnel connections

client.zeroTrust.tunnels.cloudflared.connections.get(, , ?): SinglePage<Client { id, arch, config_version, 4 more } >

GET/accounts/{account_id}/cfd_tunnel/{tunnel_id}/connections

Clean up Cloudflare Tunnel connections

client.zeroTrust.tunnels.cloudflared.connections.delete(, , ?): ConnectionDeleteResponse | null

DELETE/accounts/{account_id}/cfd_tunnel/{tunnel_id}/connections

ModelsExpand Collapse

Client { id, arch, config_version, 4 more }

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

id?: string

UUID of the Cloudflare Tunnel connection.

formatuuid

maxLength36

arch?: string

The cloudflared OS architecture used to establish this connection.

config_version?: number

The version of the remote tunnel configuration. Used internally to sync cloudflared with the Zero Trust dashboard.

conns?: Array<Conn>

The Cloudflare Tunnel connections between your origin and Cloudflare’s edge.

id?: string

UUID of the Cloudflare Tunnel connection.

formatuuid

maxLength36

client_id?: string

UUID of the Cloudflare Tunnel connector.

formatuuid

maxLength36

client_version?: string

The cloudflared version used to establish this connection.

colo_name?: string

The Cloudflare data center used for this connection.

is_pending_reconnect?: boolean

Cloudflare continues to track connections for several minutes after they disconnect. This is an optimization to improve latency and reliability of reconnecting. If true, the connection has disconnected but is still being tracked. If false, the connection is actively serving traffic.

opened_at?: string

Timestamp of when the connection was established.

formatdate-time

origin_ip?: string

The public IP address of the host running cloudflared.

uuid?: string

UUID of the Cloudflare Tunnel connection.

formatuuid

maxLength36

features?: Array<string>

Features enabled for the Cloudflare Tunnel.

run_at?: string

Timestamp of when the tunnel connection was started.

formatdate-time

version?: string

The cloudflared version used to establish this connection.

ConnectionDeleteResponse = unknown