Tunnels

List All Tunnels

zero_trust.tunnels.list() -> SyncV4PagePaginationArray[TunnelListResponse]

GET/accounts/{account_id}/tunnels

ModelsExpand Collapse

class 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.

uuid: Optional[str]

UUID of the Cloudflare Tunnel connection.

formatuuid

maxLength36

TunnelListResponse

A Cloudflare Tunnel that connects your origin to Cloudflare's edge.

One of the following:

class CloudflareTunnel: …

A Cloudflare 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

config_src: Optional[Literal["local", "cloudflare"]]

Indicates if this is a locally or remotely configured tunnel. If local, manage the tunnel using a YAML file on the origin machine. If cloudflare, manage the tunnel on the Zero Trust dashboard.

One of the following:

"local"

"cloudflare"

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.

A user-friendly name for a tunnel.

Deprecatedremote_config: Optional[bool]

Use the config_src field instead.

If true, the tunnel can be configured remotely from the Zero Trust dashboard. If false, the tunnel must be configured locally on the origin machine.

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 TunnelWARPConnectorTunnel: …

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

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.

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"

TunnelsCloudflared

List Cloudflare Tunnels

zero_trust.tunnels.cloudflared.list() -> SyncV4PagePaginationArray[CloudflareTunnel]

GET/accounts/{account_id}/cfd_tunnel

Get a Cloudflare Tunnel

zero_trust.tunnels.cloudflared.get(, ) -> CloudflareTunnel

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

Create a Cloudflare Tunnel

zero_trust.tunnels.cloudflared.create() -> CloudflareTunnel

POST/accounts/{account_id}/cfd_tunnel

Update a Cloudflare Tunnel

zero_trust.tunnels.cloudflared.edit(, ) -> CloudflareTunnel

PATCH/accounts/{account_id}/cfd_tunnel/{tunnel_id}

Delete a Cloudflare Tunnel

zero_trust.tunnels.cloudflared.delete(, ) -> CloudflareTunnel

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

TunnelsCloudflaredConfigurations

Get configuration

zero_trust.tunnels.cloudflared.configurations.get(, ) -> ConfigurationGetResponse

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

Put configuration

zero_trust.tunnels.cloudflared.configurations.update(, ) -> ConfigurationUpdateResponse

PUT/accounts/{account_id}/cfd_tunnel/{tunnel_id}/configurations

ModelsExpand Collapse

class ConfigurationGetResponse: …

Cloudflare Tunnel configuration

account_id: Optional[str]

Identifier.

maxLength32

config: Optional[Config]

The tunnel configuration and ingress rules.

ingress: Optional[List[ConfigIngress]]

List of public hostname definitions. At least one ingress rule needs to be defined for the tunnel.

hostname: str

Public hostname for this service.

service: str

Protocol and address of destination server. Supported protocols: http://, https://, unix://, tcp://, ssh://, rdp://, unix+tls://, smb://. Alternatively can return a HTTP status code http_status:[code] e.g. 'http_status:404'.

origin_request: Optional[ConfigIngressOriginRequest]

Configuration parameters for the public hostname specific connection settings between cloudflared and origin server.

access: Optional[ConfigIngressOriginRequestAccess]

For all L7 requests to this hostname, cloudflared will validate each request's Cf-Access-Jwt-Assertion request header.

aud_tag: List[str]

Access applications that are allowed to reach this hostname for this Tunnel. Audience tags can be identified in the dashboard or via the List Access policies API.

team_name: str

required: Optional[bool]

Deny traffic that has not fulfilled Access authorization.

ca_pool: Optional[str]

Path to the certificate authority (CA) for the certificate of your origin. This option should be used only if your certificate is not signed by Cloudflare.

connect_timeout: Optional[int]

Timeout for establishing a new TCP connection to your origin server. This excludes the time taken to establish TLS, which is controlled by tlsTimeout.

disable_chunked_encoding: Optional[bool]

Disables chunked transfer encoding. Useful if you are running a WSGI server.

http2_origin: Optional[bool]

Attempt to connect to origin using HTTP2. Origin must be configured as https.

http_host_header: Optional[str]

Sets the HTTP Host header on requests sent to the local service.

keep_alive_connections: Optional[int]

Maximum number of idle keepalive connections between Tunnel and your origin. This does not restrict the total number of concurrent connections.

keep_alive_timeout: Optional[int]

Timeout after which an idle keepalive connection can be discarded.

match_sn_ito_host: Optional[bool]

Auto configure the Hostname on the origin server certificate.

no_happy_eyeballs: Optional[bool]

Disable the “happy eyeballs” algorithm for IPv4/IPv6 fallback if your local network has misconfigured one of the protocols.

no_tls_verify: Optional[bool]

Disables TLS verification of the certificate presented by your origin. Will allow any certificate from the origin to be accepted.

origin_server_name: Optional[str]

Hostname that cloudflared should expect from your origin server certificate.

proxy_type: Optional[str]

cloudflared starts a proxy server to translate HTTP traffic into TCP when proxying, for example, SSH or RDP. This configures what type of proxy will be started. Valid options are: "" for the regular proxy and "socks" for a SOCKS5 proxy.

tcp_keep_alive: Optional[int]

The timeout after which a TCP keepalive packet is sent on a connection between Tunnel and the origin server.

tls_timeout: Optional[int]

Timeout for completing a TLS handshake to your origin server, if you have chosen to connect Tunnel to an HTTPS server.

path: Optional[str]

Requests with this path route to this public hostname.

origin_request: Optional[ConfigOriginRequest]

Configuration parameters for the public hostname specific connection settings between cloudflared and origin server.

access: Optional[ConfigOriginRequestAccess]

For all L7 requests to this hostname, cloudflared will validate each request's Cf-Access-Jwt-Assertion request header.

aud_tag: List[str]

Access applications that are allowed to reach this hostname for this Tunnel. Audience tags can be identified in the dashboard or via the List Access policies API.

team_name: str

required: Optional[bool]

Deny traffic that has not fulfilled Access authorization.

ca_pool: Optional[str]

Path to the certificate authority (CA) for the certificate of your origin. This option should be used only if your certificate is not signed by Cloudflare.

connect_timeout: Optional[int]

Timeout for establishing a new TCP connection to your origin server. This excludes the time taken to establish TLS, which is controlled by tlsTimeout.

disable_chunked_encoding: Optional[bool]

Disables chunked transfer encoding. Useful if you are running a WSGI server.

http2_origin: Optional[bool]

Attempt to connect to origin using HTTP2. Origin must be configured as https.

http_host_header: Optional[str]

Sets the HTTP Host header on requests sent to the local service.

keep_alive_connections: Optional[int]

Maximum number of idle keepalive connections between Tunnel and your origin. This does not restrict the total number of concurrent connections.

keep_alive_timeout: Optional[int]

Timeout after which an idle keepalive connection can be discarded.

match_sn_ito_host: Optional[bool]

Auto configure the Hostname on the origin server certificate.

no_happy_eyeballs: Optional[bool]

Disable the “happy eyeballs” algorithm for IPv4/IPv6 fallback if your local network has misconfigured one of the protocols.

no_tls_verify: Optional[bool]

Disables TLS verification of the certificate presented by your origin. Will allow any certificate from the origin to be accepted.

origin_server_name: Optional[str]

Hostname that cloudflared should expect from your origin server certificate.

proxy_type: Optional[str]

cloudflared starts a proxy server to translate HTTP traffic into TCP when proxying, for example, SSH or RDP. This configures what type of proxy will be started. Valid options are: "" for the regular proxy and "socks" for a SOCKS5 proxy.

tcp_keep_alive: Optional[int]

The timeout after which a TCP keepalive packet is sent on a connection between Tunnel and the origin server.

tls_timeout: Optional[int]

Timeout for completing a TLS handshake to your origin server, if you have chosen to connect Tunnel to an HTTPS server.

created_at: Optional[datetime]

formatdate-time

source: Optional[Literal["local", "cloudflare"]]

Indicates if this is a locally or remotely configured tunnel. If local, manage the tunnel using a YAML file on the origin machine. If cloudflare, manage the tunnel's configuration on the Zero Trust dashboard.

One of the following:

"local"

"cloudflare"

tunnel_id: Optional[str]

UUID of the tunnel.

formatuuid

maxLength36

version: Optional[int]

The version of the Tunnel Configuration.

class ConfigurationUpdateResponse: …

Cloudflare Tunnel configuration

account_id: Optional[str]

Identifier.

maxLength32

config: Optional[Config]

The tunnel configuration and ingress rules.

ingress: Optional[List[ConfigIngress]]

List of public hostname definitions. At least one ingress rule needs to be defined for the tunnel.

hostname: str

Public hostname for this service.

service: str

Protocol and address of destination server. Supported protocols: http://, https://, unix://, tcp://, ssh://, rdp://, unix+tls://, smb://. Alternatively can return a HTTP status code http_status:[code] e.g. 'http_status:404'.

origin_request: Optional[ConfigIngressOriginRequest]

Configuration parameters for the public hostname specific connection settings between cloudflared and origin server.

access: Optional[ConfigIngressOriginRequestAccess]

For all L7 requests to this hostname, cloudflared will validate each request's Cf-Access-Jwt-Assertion request header.

aud_tag: List[str]

Access applications that are allowed to reach this hostname for this Tunnel. Audience tags can be identified in the dashboard or via the List Access policies API.

team_name: str

required: Optional[bool]

Deny traffic that has not fulfilled Access authorization.

ca_pool: Optional[str]

Path to the certificate authority (CA) for the certificate of your origin. This option should be used only if your certificate is not signed by Cloudflare.

connect_timeout: Optional[int]

Timeout for establishing a new TCP connection to your origin server. This excludes the time taken to establish TLS, which is controlled by tlsTimeout.

disable_chunked_encoding: Optional[bool]

Disables chunked transfer encoding. Useful if you are running a WSGI server.

http2_origin: Optional[bool]

Attempt to connect to origin using HTTP2. Origin must be configured as https.

http_host_header: Optional[str]

Sets the HTTP Host header on requests sent to the local service.

keep_alive_connections: Optional[int]

Maximum number of idle keepalive connections between Tunnel and your origin. This does not restrict the total number of concurrent connections.

keep_alive_timeout: Optional[int]

Timeout after which an idle keepalive connection can be discarded.

match_sn_ito_host: Optional[bool]

Auto configure the Hostname on the origin server certificate.

no_happy_eyeballs: Optional[bool]

Disable the “happy eyeballs” algorithm for IPv4/IPv6 fallback if your local network has misconfigured one of the protocols.

no_tls_verify: Optional[bool]

Disables TLS verification of the certificate presented by your origin. Will allow any certificate from the origin to be accepted.

origin_server_name: Optional[str]

Hostname that cloudflared should expect from your origin server certificate.

proxy_type: Optional[str]

cloudflared starts a proxy server to translate HTTP traffic into TCP when proxying, for example, SSH or RDP. This configures what type of proxy will be started. Valid options are: "" for the regular proxy and "socks" for a SOCKS5 proxy.

tcp_keep_alive: Optional[int]

The timeout after which a TCP keepalive packet is sent on a connection between Tunnel and the origin server.

tls_timeout: Optional[int]

Timeout for completing a TLS handshake to your origin server, if you have chosen to connect Tunnel to an HTTPS server.

path: Optional[str]

Requests with this path route to this public hostname.

origin_request: Optional[ConfigOriginRequest]

Configuration parameters for the public hostname specific connection settings between cloudflared and origin server.

access: Optional[ConfigOriginRequestAccess]

For all L7 requests to this hostname, cloudflared will validate each request's Cf-Access-Jwt-Assertion request header.

aud_tag: List[str]

Access applications that are allowed to reach this hostname for this Tunnel. Audience tags can be identified in the dashboard or via the List Access policies API.

team_name: str

required: Optional[bool]

Deny traffic that has not fulfilled Access authorization.

ca_pool: Optional[str]

Path to the certificate authority (CA) for the certificate of your origin. This option should be used only if your certificate is not signed by Cloudflare.

connect_timeout: Optional[int]

Timeout for establishing a new TCP connection to your origin server. This excludes the time taken to establish TLS, which is controlled by tlsTimeout.

disable_chunked_encoding: Optional[bool]

Disables chunked transfer encoding. Useful if you are running a WSGI server.

http2_origin: Optional[bool]

Attempt to connect to origin using HTTP2. Origin must be configured as https.

http_host_header: Optional[str]

Sets the HTTP Host header on requests sent to the local service.

keep_alive_connections: Optional[int]

Maximum number of idle keepalive connections between Tunnel and your origin. This does not restrict the total number of concurrent connections.

keep_alive_timeout: Optional[int]

Timeout after which an idle keepalive connection can be discarded.

match_sn_ito_host: Optional[bool]

Auto configure the Hostname on the origin server certificate.

no_happy_eyeballs: Optional[bool]

Disable the “happy eyeballs” algorithm for IPv4/IPv6 fallback if your local network has misconfigured one of the protocols.

no_tls_verify: Optional[bool]

Disables TLS verification of the certificate presented by your origin. Will allow any certificate from the origin to be accepted.

origin_server_name: Optional[str]

Hostname that cloudflared should expect from your origin server certificate.

proxy_type: Optional[str]

cloudflared starts a proxy server to translate HTTP traffic into TCP when proxying, for example, SSH or RDP. This configures what type of proxy will be started. Valid options are: "" for the regular proxy and "socks" for a SOCKS5 proxy.

tcp_keep_alive: Optional[int]

The timeout after which a TCP keepalive packet is sent on a connection between Tunnel and the origin server.

tls_timeout: Optional[int]

Timeout for completing a TLS handshake to your origin server, if you have chosen to connect Tunnel to an HTTPS server.

created_at: Optional[datetime]

formatdate-time

source: Optional[Literal["local", "cloudflare"]]

Indicates if this is a locally or remotely configured tunnel. If local, manage the tunnel using a YAML file on the origin machine. If cloudflare, manage the tunnel's configuration on the Zero Trust dashboard.

One of the following:

"local"

"cloudflare"

tunnel_id: Optional[str]

UUID of the tunnel.

formatuuid

maxLength36

version: Optional[int]

The version of the Tunnel Configuration.

TunnelsCloudflaredConnections

List Cloudflare Tunnel connections

zero_trust.tunnels.cloudflared.connections.get(, ) -> SyncSinglePage[Client]

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

Clean up Cloudflare Tunnel connections

zero_trust.tunnels.cloudflared.connections.delete(, ) -> object

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

ModelsExpand Collapse

class Client: …

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

id: Optional[str]

UUID of the Cloudflare Tunnel connection.

formatuuid

maxLength36

arch: Optional[str]

The cloudflared OS architecture used to establish this connection.

config_version: Optional[int]

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

conns: Optional[List[Conn]]

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

features: Optional[List[str]]

Features enabled for the Cloudflare Tunnel.

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.

TunnelsCloudflaredToken

Get a Cloudflare Tunnel token

zero_trust.tunnels.cloudflared.token.get(, ) -> TokenGetResponse

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

ModelsExpand Collapse

str

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

TunnelsCloudflaredConnectors

Get Cloudflare Tunnel connector

zero_trust.tunnels.cloudflared.connectors.get(, ) -> Client

GET/accounts/{account_id}/cfd_tunnel/{tunnel_id}/connectors/{connector_id}

TunnelsCloudflaredManagement

Get a Cloudflare Tunnel management token

zero_trust.tunnels.cloudflared.management.create(, ) -> ManagementCreateResponse

POST/accounts/{account_id}/cfd_tunnel/{tunnel_id}/management

ModelsExpand Collapse

str

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

TunnelsWARP Connector

List Warp Connector Tunnels

zero_trust.tunnels.warp_connector.list() -> SyncV4PagePaginationArray[WARPConnectorListResponse]

GET/accounts/{account_id}/warp_connector

Get a Warp Connector Tunnel

zero_trust.tunnels.warp_connector.get(, ) -> WARPConnectorGetResponse

GET/accounts/{account_id}/warp_connector/{tunnel_id}

Create a Warp Connector Tunnel

zero_trust.tunnels.warp_connector.create() -> WARPConnectorCreateResponse

POST/accounts/{account_id}/warp_connector

Update a Warp Connector Tunnel

zero_trust.tunnels.warp_connector.edit(, ) -> WARPConnectorEditResponse

PATCH/accounts/{account_id}/warp_connector/{tunnel_id}

Delete a Warp Connector Tunnel

zero_trust.tunnels.warp_connector.delete(, ) -> 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.

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.

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.

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.

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.

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"

TunnelsWARP ConnectorToken

Get a Warp Connector Tunnel token

zero_trust.tunnels.warp_connector.token.get(, ) -> 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.

TunnelsWARP ConnectorConnections

List WARP Connector Tunnel connections

zero_trust.tunnels.warp_connector.connections.get(, ) -> 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.

TunnelsWARP ConnectorConnectors

Get WARP Connector Tunnel connector

zero_trust.tunnels.warp_connector.connectors.get(, ) -> 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.

TunnelsWARP ConnectorFailover

Trigger a manual failover for a WARP Connector Tunnel

zero_trust.tunnels.warp_connector.failover.update(, ) -> object

PUT/accounts/{account_id}/warp_connector/{tunnel_id}/failover