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

WARP Connector

List Warp Connector Tunnels
zero_trust.tunnels.warp_connector.list(WARPConnectorListParams**kwargs) -> SyncV4PagePaginationArray[WARPConnectorListResponse]
GET/accounts/{account_id}/warp_connector
Get a Warp Connector Tunnel
zero_trust.tunnels.warp_connector.get(strtunnel_id, WARPConnectorGetParams**kwargs) -> WARPConnectorGetResponse
GET/accounts/{account_id}/warp_connector/{tunnel_id}
Create a Warp Connector Tunnel
zero_trust.tunnels.warp_connector.create(WARPConnectorCreateParams**kwargs) -> WARPConnectorCreateResponse
POST/accounts/{account_id}/warp_connector
Update a Warp Connector Tunnel
zero_trust.tunnels.warp_connector.edit(strtunnel_id, WARPConnectorEditParams**kwargs) -> WARPConnectorEditResponse
PATCH/accounts/{account_id}/warp_connector/{tunnel_id}
Delete a Warp Connector Tunnel
zero_trust.tunnels.warp_connector.delete(strtunnel_id, WARPConnectorDeleteParams**kwargs) -> WARPConnectorDeleteResponse
DELETE/accounts/{account_id}/warp_connector/{tunnel_id}
ModelsExpand Collapse
class WARPConnectorListResponse: …

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

id: Optional[str]

UUID of the tunnel.

formatuuid
maxLength36
account_tag: Optional[str]

Cloudflare account ID

maxLength32
Deprecatedconnections: Optional[List[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: Optional[str]

UUID of the Cloudflare Tunnel connection.

formatuuid
maxLength36
client_id: Optional[str]

UUID of the Cloudflare Tunnel connector.

formatuuid
maxLength36
client_version: Optional[str]

The cloudflared version used to establish this connection.

colo_name: Optional[str]

The Cloudflare data center used for this connection.

is_pending_reconnect: Optional[bool]

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[datetime]

Timestamp of when the connection was established.

formatdate-time
origin_ip: Optional[str]

The public IP address of the host running cloudflared.

uuid: Optional[str]

UUID of the Cloudflare Tunnel connection.

formatuuid
maxLength36
conns_active_at: Optional[datetime]

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[datetime]

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

formatdate-time
created_at: Optional[datetime]

Timestamp of when the resource was created.

formatdate-time
deleted_at: Optional[datetime]

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

formatdate-time
metadata: Optional[object]

Metadata associated with the tunnel.

name: Optional[str]

A user-friendly name for a tunnel.

status: Optional[Literal["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: Optional[Literal["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"
class WARPConnectorGetResponse: …

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

id: Optional[str]

UUID of the tunnel.

formatuuid
maxLength36
account_tag: Optional[str]

Cloudflare account ID

maxLength32
Deprecatedconnections: Optional[List[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: Optional[str]

UUID of the Cloudflare Tunnel connection.

formatuuid
maxLength36
client_id: Optional[str]

UUID of the Cloudflare Tunnel connector.

formatuuid
maxLength36
client_version: Optional[str]

The cloudflared version used to establish this connection.

colo_name: Optional[str]

The Cloudflare data center used for this connection.

is_pending_reconnect: Optional[bool]

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[datetime]

Timestamp of when the connection was established.

formatdate-time
origin_ip: Optional[str]

The public IP address of the host running cloudflared.

uuid: Optional[str]

UUID of the Cloudflare Tunnel connection.

formatuuid
maxLength36
conns_active_at: Optional[datetime]

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[datetime]

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

formatdate-time
created_at: Optional[datetime]

Timestamp of when the resource was created.

formatdate-time
deleted_at: Optional[datetime]

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

formatdate-time
metadata: Optional[object]

Metadata associated with the tunnel.

name: Optional[str]

A user-friendly name for a tunnel.

status: Optional[Literal["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: Optional[Literal["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"
class WARPConnectorCreateResponse: …

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

id: Optional[str]

UUID of the tunnel.

formatuuid
maxLength36
account_tag: Optional[str]

Cloudflare account ID

maxLength32
Deprecatedconnections: Optional[List[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: Optional[str]

UUID of the Cloudflare Tunnel connection.

formatuuid
maxLength36
client_id: Optional[str]

UUID of the Cloudflare Tunnel connector.

formatuuid
maxLength36
client_version: Optional[str]

The cloudflared version used to establish this connection.

colo_name: Optional[str]

The Cloudflare data center used for this connection.

is_pending_reconnect: Optional[bool]

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[datetime]

Timestamp of when the connection was established.

formatdate-time
origin_ip: Optional[str]

The public IP address of the host running cloudflared.

uuid: Optional[str]

UUID of the Cloudflare Tunnel connection.

formatuuid
maxLength36
conns_active_at: Optional[datetime]

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[datetime]

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

formatdate-time
created_at: Optional[datetime]

Timestamp of when the resource was created.

formatdate-time
deleted_at: Optional[datetime]

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

formatdate-time
metadata: Optional[object]

Metadata associated with the tunnel.

name: Optional[str]

A user-friendly name for a tunnel.

status: Optional[Literal["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: Optional[Literal["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"
class WARPConnectorEditResponse: …

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

id: Optional[str]

UUID of the tunnel.

formatuuid
maxLength36
account_tag: Optional[str]

Cloudflare account ID

maxLength32
Deprecatedconnections: Optional[List[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: Optional[str]

UUID of the Cloudflare Tunnel connection.

formatuuid
maxLength36
client_id: Optional[str]

UUID of the Cloudflare Tunnel connector.

formatuuid
maxLength36
client_version: Optional[str]

The cloudflared version used to establish this connection.

colo_name: Optional[str]

The Cloudflare data center used for this connection.

is_pending_reconnect: Optional[bool]

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[datetime]

Timestamp of when the connection was established.

formatdate-time
origin_ip: Optional[str]

The public IP address of the host running cloudflared.

uuid: Optional[str]

UUID of the Cloudflare Tunnel connection.

formatuuid
maxLength36
conns_active_at: Optional[datetime]

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[datetime]

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

formatdate-time
created_at: Optional[datetime]

Timestamp of when the resource was created.

formatdate-time
deleted_at: Optional[datetime]

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

formatdate-time
metadata: Optional[object]

Metadata associated with the tunnel.

name: Optional[str]

A user-friendly name for a tunnel.

status: Optional[Literal["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: Optional[Literal["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"
class WARPConnectorDeleteResponse: …

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

id: Optional[str]

UUID of the tunnel.

formatuuid
maxLength36
account_tag: Optional[str]

Cloudflare account ID

maxLength32
Deprecatedconnections: Optional[List[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: Optional[str]

UUID of the Cloudflare Tunnel connection.

formatuuid
maxLength36
client_id: Optional[str]

UUID of the Cloudflare Tunnel connector.

formatuuid
maxLength36
client_version: Optional[str]

The cloudflared version used to establish this connection.

colo_name: Optional[str]

The Cloudflare data center used for this connection.

is_pending_reconnect: Optional[bool]

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[datetime]

Timestamp of when the connection was established.

formatdate-time
origin_ip: Optional[str]

The public IP address of the host running cloudflared.

uuid: Optional[str]

UUID of the Cloudflare Tunnel connection.

formatuuid
maxLength36
conns_active_at: Optional[datetime]

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[datetime]

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

formatdate-time
created_at: Optional[datetime]

Timestamp of when the resource was created.

formatdate-time
deleted_at: Optional[datetime]

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

formatdate-time
metadata: Optional[object]

Metadata associated with the tunnel.

name: Optional[str]

A user-friendly name for a tunnel.

status: Optional[Literal["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: Optional[Literal["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
zero_trust.tunnels.warp_connector.token.get(strtunnel_id, TokenGetParams**kwargs) -> TokenGetResponse
GET/accounts/{account_id}/warp_connector/{tunnel_id}/token
ModelsExpand Collapse
str

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

WARP ConnectorConnections

List WARP Connector Tunnel connections
zero_trust.tunnels.warp_connector.connections.get(strtunnel_id, ConnectionGetParams**kwargs) -> SyncSinglePage[ConnectionGetResponse]
GET/accounts/{account_id}/warp_connector/{tunnel_id}/connections
ModelsExpand Collapse
class ConnectionGetResponse: …

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

id: Optional[str]

UUID of the Cloudflare Tunnel connector.

formatuuid
maxLength36
arch: Optional[str]

The cloudflared OS architecture used to establish this connection.

conns: Optional[List[Conn]]

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

id: Optional[str]

UUID of the Cloudflare Tunnel connection.

formatuuid
maxLength36
client_id: Optional[str]

UUID of the Cloudflare Tunnel connector.

formatuuid
maxLength36
client_version: Optional[str]

The cloudflared version used to establish this connection.

colo_name: Optional[str]

The Cloudflare data center used for this connection.

opened_at: Optional[datetime]

Timestamp of when the connection was established.

formatdate-time
origin_ip: Optional[str]

The public IP address of the host running WARP Connector.

features: Optional[List[str]]

Features enabled for the Cloudflare Tunnel.

ha_status: Optional[Literal["offline", "passive", "active"]]

The HA status of a WARP Connector client.

One of the following:
"offline"
"passive"
"active"
run_at: Optional[datetime]

Timestamp of when the tunnel connection was started.

formatdate-time
version: Optional[str]

The cloudflared version used to establish this connection.

WARP ConnectorConnectors

Get WARP Connector Tunnel connector
zero_trust.tunnels.warp_connector.connectors.get(strconnector_id, ConnectorGetParams**kwargs) -> ConnectorGetResponse
GET/accounts/{account_id}/warp_connector/{tunnel_id}/connectors/{connector_id}
ModelsExpand Collapse
class ConnectorGetResponse: …

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

id: Optional[str]

UUID of the Cloudflare Tunnel connector.

formatuuid
maxLength36
arch: Optional[str]

The cloudflared OS architecture used to establish this connection.

conns: Optional[List[Conn]]

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

id: Optional[str]

UUID of the Cloudflare Tunnel connection.

formatuuid
maxLength36
client_id: Optional[str]

UUID of the Cloudflare Tunnel connector.

formatuuid
maxLength36
client_version: Optional[str]

The cloudflared version used to establish this connection.

colo_name: Optional[str]

The Cloudflare data center used for this connection.

opened_at: Optional[datetime]

Timestamp of when the connection was established.

formatdate-time
origin_ip: Optional[str]

The public IP address of the host running WARP Connector.

features: Optional[List[str]]

Features enabled for the Cloudflare Tunnel.

ha_status: Optional[Literal["offline", "passive", "active"]]

The HA status of a WARP Connector client.

One of the following:
"offline"
"passive"
"active"
run_at: Optional[datetime]

Timestamp of when the tunnel connection was started.

formatdate-time
version: Optional[str]

The cloudflared version used to establish this connection.

WARP ConnectorFailover

Trigger a manual failover for a WARP Connector Tunnel
zero_trust.tunnels.warp_connector.failover.update(strtunnel_id, FailoverUpdateParams**kwargs) -> object
PUT/accounts/{account_id}/warp_connector/{tunnel_id}/failover