Skip to content
Cloudflare API
Start here
API Reference
Zero Trust
Tunnels

WARP Connector

List Warp Connector Tunnels
client.zeroTrust.tunnels.warpConnector.list(WARPConnectorListParams { account_id, exclude_prefix, existed_at, 9 more } params, RequestOptionsoptions?): V4PagePaginationArray<WARPConnectorListResponse { id, account_tag, connections, 8 more } >
GET/accounts/{account_id}/warp_connector
Get a Warp Connector Tunnel
client.zeroTrust.tunnels.warpConnector.get(stringtunnelId, WARPConnectorGetParams { account_id } params, RequestOptionsoptions?): WARPConnectorGetResponse { id, account_tag, connections, 8 more }
GET/accounts/{account_id}/warp_connector/{tunnel_id}
Create a Warp Connector Tunnel
client.zeroTrust.tunnels.warpConnector.create(WARPConnectorCreateParams { account_id, name, ha } params, RequestOptionsoptions?): WARPConnectorCreateResponse { id, account_tag, connections, 8 more }
POST/accounts/{account_id}/warp_connector
Update a Warp Connector Tunnel
client.zeroTrust.tunnels.warpConnector.edit(stringtunnelId, WARPConnectorEditParams { account_id, name, tunnel_secret } params, RequestOptionsoptions?): WARPConnectorEditResponse { id, account_tag, connections, 8 more }
PATCH/accounts/{account_id}/warp_connector/{tunnel_id}
Delete a Warp Connector Tunnel
client.zeroTrust.tunnels.warpConnector.delete(stringtunnelId, WARPConnectorDeleteParams { account_id } params, RequestOptionsoptions?): WARPConnectorDeleteResponse { id, account_tag, connections, 8 more }
DELETE/accounts/{account_id}/warp_connector/{tunnel_id}
ModelsExpand Collapse
WARPConnectorListResponse { id, account_tag, connections, 8 more }

A Warp Connector Tunnel that connects your origin to Cloudflare’s edge.

id?: string

UUID of the tunnel.

formatuuid
maxLength36
account_tag?: string

Cloudflare account ID

maxLength32
Deprecatedconnections?: Array<Connection>
This field will start returning an empty array. To fetch the connections of a given tunnel, please use the dedicated endpoint `/accounts/{account_id}/{tunnel_type}/{tunnel_id}/connections`

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
conns_active_at?: string

Timestamp of when the tunnel established at least one connection to Cloudflare’s edge. If null, the tunnel is inactive.

formatdate-time
conns_inactive_at?: string

Timestamp of when the tunnel became inactive (no connections to Cloudflare’s edge). If null, the tunnel is active.

formatdate-time
created_at?: string

Timestamp of when the resource was created.

formatdate-time
deleted_at?: string

Timestamp of when the resource was deleted. If null, the resource has not been deleted.

formatdate-time
metadata?: unknown

Metadata associated with the tunnel.

name?: string

A user-friendly name for a tunnel.

status?: "inactive" | "degraded" | "healthy" | "down"

The status of the tunnel. Valid values are inactive (tunnel has never been run), degraded (tunnel is active and able to serve traffic but in an unhealthy state), healthy (tunnel is active and able to serve traffic), or down (tunnel can not serve traffic as it has no connections to the Cloudflare Edge).

One of the following:
"inactive"
"degraded"
"healthy"
"down"
tun_type?: "cfd_tunnel" | "warp_connector" | "warp" | 4 more

The type of tunnel.

One of the following:
"cfd_tunnel"
"warp_connector"
"warp"
"magic"
"ip_sec"
"gre"
"cni"
WARPConnectorGetResponse { id, account_tag, connections, 8 more }

A Warp Connector Tunnel that connects your origin to Cloudflare’s edge.

id?: string

UUID of the tunnel.

formatuuid
maxLength36
account_tag?: string

Cloudflare account ID

maxLength32
Deprecatedconnections?: Array<Connection>
This field will start returning an empty array. To fetch the connections of a given tunnel, please use the dedicated endpoint `/accounts/{account_id}/{tunnel_type}/{tunnel_id}/connections`

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
conns_active_at?: string

Timestamp of when the tunnel established at least one connection to Cloudflare’s edge. If null, the tunnel is inactive.

formatdate-time
conns_inactive_at?: string

Timestamp of when the tunnel became inactive (no connections to Cloudflare’s edge). If null, the tunnel is active.

formatdate-time
created_at?: string

Timestamp of when the resource was created.

formatdate-time
deleted_at?: string

Timestamp of when the resource was deleted. If null, the resource has not been deleted.

formatdate-time
metadata?: unknown

Metadata associated with the tunnel.

name?: string

A user-friendly name for a tunnel.

status?: "inactive" | "degraded" | "healthy" | "down"

The status of the tunnel. Valid values are inactive (tunnel has never been run), degraded (tunnel is active and able to serve traffic but in an unhealthy state), healthy (tunnel is active and able to serve traffic), or down (tunnel can not serve traffic as it has no connections to the Cloudflare Edge).

One of the following:
"inactive"
"degraded"
"healthy"
"down"
tun_type?: "cfd_tunnel" | "warp_connector" | "warp" | 4 more

The type of tunnel.

One of the following:
"cfd_tunnel"
"warp_connector"
"warp"
"magic"
"ip_sec"
"gre"
"cni"
WARPConnectorCreateResponse { id, account_tag, connections, 8 more }

A Warp Connector Tunnel that connects your origin to Cloudflare’s edge.

id?: string

UUID of the tunnel.

formatuuid
maxLength36
account_tag?: string

Cloudflare account ID

maxLength32
Deprecatedconnections?: Array<Connection>
This field will start returning an empty array. To fetch the connections of a given tunnel, please use the dedicated endpoint `/accounts/{account_id}/{tunnel_type}/{tunnel_id}/connections`

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
conns_active_at?: string

Timestamp of when the tunnel established at least one connection to Cloudflare’s edge. If null, the tunnel is inactive.

formatdate-time
conns_inactive_at?: string

Timestamp of when the tunnel became inactive (no connections to Cloudflare’s edge). If null, the tunnel is active.

formatdate-time
created_at?: string

Timestamp of when the resource was created.

formatdate-time
deleted_at?: string

Timestamp of when the resource was deleted. If null, the resource has not been deleted.

formatdate-time
metadata?: unknown

Metadata associated with the tunnel.

name?: string

A user-friendly name for a tunnel.

status?: "inactive" | "degraded" | "healthy" | "down"

The status of the tunnel. Valid values are inactive (tunnel has never been run), degraded (tunnel is active and able to serve traffic but in an unhealthy state), healthy (tunnel is active and able to serve traffic), or down (tunnel can not serve traffic as it has no connections to the Cloudflare Edge).

One of the following:
"inactive"
"degraded"
"healthy"
"down"
tun_type?: "cfd_tunnel" | "warp_connector" | "warp" | 4 more

The type of tunnel.

One of the following:
"cfd_tunnel"
"warp_connector"
"warp"
"magic"
"ip_sec"
"gre"
"cni"
WARPConnectorEditResponse { id, account_tag, connections, 8 more }

A Warp Connector Tunnel that connects your origin to Cloudflare’s edge.

id?: string

UUID of the tunnel.

formatuuid
maxLength36
account_tag?: string

Cloudflare account ID

maxLength32
Deprecatedconnections?: Array<Connection>
This field will start returning an empty array. To fetch the connections of a given tunnel, please use the dedicated endpoint `/accounts/{account_id}/{tunnel_type}/{tunnel_id}/connections`

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
conns_active_at?: string

Timestamp of when the tunnel established at least one connection to Cloudflare’s edge. If null, the tunnel is inactive.

formatdate-time
conns_inactive_at?: string

Timestamp of when the tunnel became inactive (no connections to Cloudflare’s edge). If null, the tunnel is active.

formatdate-time
created_at?: string

Timestamp of when the resource was created.

formatdate-time
deleted_at?: string

Timestamp of when the resource was deleted. If null, the resource has not been deleted.

formatdate-time
metadata?: unknown

Metadata associated with the tunnel.

name?: string

A user-friendly name for a tunnel.

status?: "inactive" | "degraded" | "healthy" | "down"

The status of the tunnel. Valid values are inactive (tunnel has never been run), degraded (tunnel is active and able to serve traffic but in an unhealthy state), healthy (tunnel is active and able to serve traffic), or down (tunnel can not serve traffic as it has no connections to the Cloudflare Edge).

One of the following:
"inactive"
"degraded"
"healthy"
"down"
tun_type?: "cfd_tunnel" | "warp_connector" | "warp" | 4 more

The type of tunnel.

One of the following:
"cfd_tunnel"
"warp_connector"
"warp"
"magic"
"ip_sec"
"gre"
"cni"
WARPConnectorDeleteResponse { id, account_tag, connections, 8 more }

A Warp Connector Tunnel that connects your origin to Cloudflare’s edge.

id?: string

UUID of the tunnel.

formatuuid
maxLength36
account_tag?: string

Cloudflare account ID

maxLength32
Deprecatedconnections?: Array<Connection>
This field will start returning an empty array. To fetch the connections of a given tunnel, please use the dedicated endpoint `/accounts/{account_id}/{tunnel_type}/{tunnel_id}/connections`

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
conns_active_at?: string

Timestamp of when the tunnel established at least one connection to Cloudflare’s edge. If null, the tunnel is inactive.

formatdate-time
conns_inactive_at?: string

Timestamp of when the tunnel became inactive (no connections to Cloudflare’s edge). If null, the tunnel is active.

formatdate-time
created_at?: string

Timestamp of when the resource was created.

formatdate-time
deleted_at?: string

Timestamp of when the resource was deleted. If null, the resource has not been deleted.

formatdate-time
metadata?: unknown

Metadata associated with the tunnel.

name?: string

A user-friendly name for a tunnel.

status?: "inactive" | "degraded" | "healthy" | "down"

The status of the tunnel. Valid values are inactive (tunnel has never been run), degraded (tunnel is active and able to serve traffic but in an unhealthy state), healthy (tunnel is active and able to serve traffic), or down (tunnel can not serve traffic as it has no connections to the Cloudflare Edge).

One of the following:
"inactive"
"degraded"
"healthy"
"down"
tun_type?: "cfd_tunnel" | "warp_connector" | "warp" | 4 more

The type of tunnel.

One of the following:
"cfd_tunnel"
"warp_connector"
"warp"
"magic"
"ip_sec"
"gre"
"cni"

WARP ConnectorToken

Get a Warp Connector Tunnel token
client.zeroTrust.tunnels.warpConnector.token.get(stringtunnelId, TokenGetParams { account_id } params, RequestOptionsoptions?): TokenGetResponse
GET/accounts/{account_id}/warp_connector/{tunnel_id}/token
ModelsExpand Collapse
TokenGetResponse = string

The Tunnel Token is used as a mechanism to authenticate the operation of a tunnel.

WARP ConnectorConnections

List WARP Connector Tunnel connections
client.zeroTrust.tunnels.warpConnector.connections.get(stringtunnelId, ConnectionGetParams { account_id } params, RequestOptionsoptions?): SinglePage<ConnectionGetResponse { id, arch, conns, 4 more } >
GET/accounts/{account_id}/warp_connector/{tunnel_id}/connections
ModelsExpand Collapse
ConnectionGetResponse { id, arch, conns, 4 more }

A WARP Connector client that maintains a connection to a Cloudflare data center.

id?: string

UUID of the Cloudflare Tunnel connector.

formatuuid
maxLength36
arch?: string

The cloudflared OS architecture used to establish this connection.

conns?: Array<Conn>

The WARP Connector 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.

opened_at?: string

Timestamp of when the connection was established.

formatdate-time
origin_ip?: string

The public IP address of the host running WARP Connector.

features?: Array<string>

Features enabled for the Cloudflare Tunnel.

ha_status?: "offline" | "passive" | "active"

The HA status of a WARP Connector client.

One of the following:
"offline"
"passive"
"active"
run_at?: string

Timestamp of when the tunnel connection was started.

formatdate-time
version?: string

The cloudflared version used to establish this connection.

WARP ConnectorConnectors

Get WARP Connector Tunnel connector
client.zeroTrust.tunnels.warpConnector.connectors.get(stringtunnelId, stringconnectorId, ConnectorGetParams { account_id } params, RequestOptionsoptions?): ConnectorGetResponse { id, arch, conns, 4 more }
GET/accounts/{account_id}/warp_connector/{tunnel_id}/connectors/{connector_id}
ModelsExpand Collapse
ConnectorGetResponse { id, arch, conns, 4 more }

A WARP Connector client that maintains a connection to a Cloudflare data center.

id?: string

UUID of the Cloudflare Tunnel connector.

formatuuid
maxLength36
arch?: string

The cloudflared OS architecture used to establish this connection.

conns?: Array<Conn>

The WARP Connector 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.

opened_at?: string

Timestamp of when the connection was established.

formatdate-time
origin_ip?: string

The public IP address of the host running WARP Connector.

features?: Array<string>

Features enabled for the Cloudflare Tunnel.

ha_status?: "offline" | "passive" | "active"

The HA status of a WARP Connector client.

One of the following:
"offline"
"passive"
"active"
run_at?: string

Timestamp of when the tunnel connection was started.

formatdate-time
version?: string

The cloudflared version used to establish this connection.

WARP ConnectorFailover

Trigger a manual failover for a WARP Connector Tunnel
client.zeroTrust.tunnels.warpConnector.failover.update(stringtunnelId, FailoverUpdateParams { account_id, client_id } params, RequestOptionsoptions?): FailoverUpdateResponse | null
PUT/accounts/{account_id}/warp_connector/{tunnel_id}/failover
ModelsExpand Collapse
FailoverUpdateResponse = unknown