Skip to content
Start here

WARP Connector

List Warp Connector Tunnels
GET/accounts/{account_id}/warp_connector
Get a Warp Connector Tunnel
GET/accounts/{account_id}/warp_connector/{tunnel_id}
Create a Warp Connector Tunnel
POST/accounts/{account_id}/warp_connector
Update a Warp Connector Tunnel
PATCH/accounts/{account_id}/warp_connector/{tunnel_id}
Delete a Warp Connector Tunnel
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: optional string

UUID of the tunnel.

formatuuid
maxLength36
account_tag: optional string

Cloudflare account ID

maxLength32
Deprecatedconnections: optional array of { id, client_id, client_version, 5 more }
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: optional string

UUID of the Cloudflare Tunnel connection.

formatuuid
maxLength36
client_id: optional string

UUID of the Cloudflare Tunnel connector.

formatuuid
maxLength36
client_version: optional string

The cloudflared version used to establish this connection.

colo_name: optional string

The Cloudflare data center used for this connection.

is_pending_reconnect: optional 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: optional string

Timestamp of when the connection was established.

formatdate-time
origin_ip: optional string

The public IP address of the host running cloudflared.

uuid: optional string

UUID of the Cloudflare Tunnel connection.

formatuuid
maxLength36
conns_active_at: optional 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: optional string

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

formatdate-time
created_at: optional string

Timestamp of when the resource was created.

formatdate-time
deleted_at: optional string

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

formatdate-time
metadata: optional unknown

Metadata associated with the tunnel.

name: optional string

A user-friendly name for a tunnel.

status: optional "inactive" or "degraded" or "healthy" or "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: optional "cfd_tunnel" or "warp_connector" or "warp" or 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: optional string

UUID of the tunnel.

formatuuid
maxLength36
account_tag: optional string

Cloudflare account ID

maxLength32
Deprecatedconnections: optional array of { id, client_id, client_version, 5 more }
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: optional string

UUID of the Cloudflare Tunnel connection.

formatuuid
maxLength36
client_id: optional string

UUID of the Cloudflare Tunnel connector.

formatuuid
maxLength36
client_version: optional string

The cloudflared version used to establish this connection.

colo_name: optional string

The Cloudflare data center used for this connection.

is_pending_reconnect: optional 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: optional string

Timestamp of when the connection was established.

formatdate-time
origin_ip: optional string

The public IP address of the host running cloudflared.

uuid: optional string

UUID of the Cloudflare Tunnel connection.

formatuuid
maxLength36
conns_active_at: optional 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: optional string

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

formatdate-time
created_at: optional string

Timestamp of when the resource was created.

formatdate-time
deleted_at: optional string

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

formatdate-time
metadata: optional unknown

Metadata associated with the tunnel.

name: optional string

A user-friendly name for a tunnel.

status: optional "inactive" or "degraded" or "healthy" or "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: optional "cfd_tunnel" or "warp_connector" or "warp" or 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: optional string

UUID of the tunnel.

formatuuid
maxLength36
account_tag: optional string

Cloudflare account ID

maxLength32
Deprecatedconnections: optional array of { id, client_id, client_version, 5 more }
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: optional string

UUID of the Cloudflare Tunnel connection.

formatuuid
maxLength36
client_id: optional string

UUID of the Cloudflare Tunnel connector.

formatuuid
maxLength36
client_version: optional string

The cloudflared version used to establish this connection.

colo_name: optional string

The Cloudflare data center used for this connection.

is_pending_reconnect: optional 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: optional string

Timestamp of when the connection was established.

formatdate-time
origin_ip: optional string

The public IP address of the host running cloudflared.

uuid: optional string

UUID of the Cloudflare Tunnel connection.

formatuuid
maxLength36
conns_active_at: optional 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: optional string

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

formatdate-time
created_at: optional string

Timestamp of when the resource was created.

formatdate-time
deleted_at: optional string

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

formatdate-time
metadata: optional unknown

Metadata associated with the tunnel.

name: optional string

A user-friendly name for a tunnel.

status: optional "inactive" or "degraded" or "healthy" or "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: optional "cfd_tunnel" or "warp_connector" or "warp" or 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: optional string

UUID of the tunnel.

formatuuid
maxLength36
account_tag: optional string

Cloudflare account ID

maxLength32
Deprecatedconnections: optional array of { id, client_id, client_version, 5 more }
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: optional string

UUID of the Cloudflare Tunnel connection.

formatuuid
maxLength36
client_id: optional string

UUID of the Cloudflare Tunnel connector.

formatuuid
maxLength36
client_version: optional string

The cloudflared version used to establish this connection.

colo_name: optional string

The Cloudflare data center used for this connection.

is_pending_reconnect: optional 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: optional string

Timestamp of when the connection was established.

formatdate-time
origin_ip: optional string

The public IP address of the host running cloudflared.

uuid: optional string

UUID of the Cloudflare Tunnel connection.

formatuuid
maxLength36
conns_active_at: optional 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: optional string

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

formatdate-time
created_at: optional string

Timestamp of when the resource was created.

formatdate-time
deleted_at: optional string

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

formatdate-time
metadata: optional unknown

Metadata associated with the tunnel.

name: optional string

A user-friendly name for a tunnel.

status: optional "inactive" or "degraded" or "healthy" or "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: optional "cfd_tunnel" or "warp_connector" or "warp" or 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: optional string

UUID of the tunnel.

formatuuid
maxLength36
account_tag: optional string

Cloudflare account ID

maxLength32
Deprecatedconnections: optional array of { id, client_id, client_version, 5 more }
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: optional string

UUID of the Cloudflare Tunnel connection.

formatuuid
maxLength36
client_id: optional string

UUID of the Cloudflare Tunnel connector.

formatuuid
maxLength36
client_version: optional string

The cloudflared version used to establish this connection.

colo_name: optional string

The Cloudflare data center used for this connection.

is_pending_reconnect: optional 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: optional string

Timestamp of when the connection was established.

formatdate-time
origin_ip: optional string

The public IP address of the host running cloudflared.

uuid: optional string

UUID of the Cloudflare Tunnel connection.

formatuuid
maxLength36
conns_active_at: optional 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: optional string

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

formatdate-time
created_at: optional string

Timestamp of when the resource was created.

formatdate-time
deleted_at: optional string

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

formatdate-time
metadata: optional unknown

Metadata associated with the tunnel.

name: optional string

A user-friendly name for a tunnel.

status: optional "inactive" or "degraded" or "healthy" or "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: optional "cfd_tunnel" or "warp_connector" or "warp" or 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
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
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: optional string

UUID of the Cloudflare Tunnel connector.

formatuuid
maxLength36
arch: optional string

The cloudflared OS architecture used to establish this connection.

conns: optional array of { id, client_id, client_version, 3 more }

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

id: optional string

UUID of the Cloudflare Tunnel connection.

formatuuid
maxLength36
client_id: optional string

UUID of the Cloudflare Tunnel connector.

formatuuid
maxLength36
client_version: optional string

The cloudflared version used to establish this connection.

colo_name: optional string

The Cloudflare data center used for this connection.

opened_at: optional string

Timestamp of when the connection was established.

formatdate-time
origin_ip: optional string

The public IP address of the host running WARP Connector.

features: optional array of string

Features enabled for the Cloudflare Tunnel.

ha_status: optional "offline" or "passive" or "active"

The HA status of a WARP Connector client.

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

Timestamp of when the tunnel connection was started.

formatdate-time
version: optional string

The cloudflared version used to establish this connection.

WARP ConnectorConnectors

Get WARP Connector Tunnel connector
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: optional string

UUID of the Cloudflare Tunnel connector.

formatuuid
maxLength36
arch: optional string

The cloudflared OS architecture used to establish this connection.

conns: optional array of { id, client_id, client_version, 3 more }

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

id: optional string

UUID of the Cloudflare Tunnel connection.

formatuuid
maxLength36
client_id: optional string

UUID of the Cloudflare Tunnel connector.

formatuuid
maxLength36
client_version: optional string

The cloudflared version used to establish this connection.

colo_name: optional string

The Cloudflare data center used for this connection.

opened_at: optional string

Timestamp of when the connection was established.

formatdate-time
origin_ip: optional string

The public IP address of the host running WARP Connector.

features: optional array of string

Features enabled for the Cloudflare Tunnel.

ha_status: optional "offline" or "passive" or "active"

The HA status of a WARP Connector client.

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

Timestamp of when the tunnel connection was started.

formatdate-time
version: optional string

The cloudflared version used to establish this connection.

WARP ConnectorFailover

Trigger a manual failover for a WARP Connector Tunnel
PUT/accounts/{account_id}/warp_connector/{tunnel_id}/failover
ModelsExpand Collapse
FailoverUpdateResponse = unknown