Tunnels
List All Tunnels
ModelsExpand Collapse
Connection { colo_name, is_pending_reconnect, uuid }
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.
TunnelListResponse = CloudflareTunnel { id, account_tag, config_src, 10 more } or { id, account_tag, connections, 8 more } A Cloudflare Tunnel that connects your origin to Cloudflare’s edge.
A Cloudflare Tunnel that connects your origin to Cloudflare’s edge.
CloudflareTunnel { id, account_tag, config_src, 10 more } A Cloudflare Tunnel that connects your origin to Cloudflare’s edge.
A Cloudflare Tunnel that connects your origin to Cloudflare’s edge.
config_src: optional "local" or "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.
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.
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.
The Cloudflare Tunnel connections between your origin and Cloudflare’s edge.
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.
Timestamp of when the tunnel established at least one connection to Cloudflare’s edge. If null, the tunnel is inactive.
Timestamp of when the tunnel became inactive (no connections to Cloudflare’s edge). If null, the tunnel is active.
Timestamp of when the resource was deleted. If null, the resource has not been deleted.
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 "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).
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).
TunnelWARPConnectorTunnel { id, account_tag, connections, 8 more } A Warp Connector Tunnel that connects your origin to Cloudflare’s edge.
A Warp Connector Tunnel that connects your origin to Cloudflare’s edge.
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.
The Cloudflare Tunnel connections between your origin and Cloudflare’s edge.
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.
Timestamp of when the tunnel established at least one connection to Cloudflare’s edge. If null, the tunnel is inactive.
Timestamp of when the tunnel became inactive (no connections to Cloudflare’s edge). If null, the tunnel is active.
Timestamp of when the resource was deleted. If null, the resource has not been deleted.
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).
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).
TunnelsCloudflared
List Cloudflare Tunnels
Get a Cloudflare Tunnel
Create a Cloudflare Tunnel
Update a Cloudflare Tunnel
Delete a Cloudflare Tunnel
TunnelsCloudflaredConfigurations
Get configuration
Put configuration
ModelsExpand Collapse
ConfigurationGetResponse { account_id, config, created_at, 3 more } Cloudflare Tunnel configuration
Cloudflare Tunnel configuration
config: optional { ingress, originRequest } The tunnel configuration and ingress rules.
The tunnel configuration and ingress rules.
ingress: optional array of { hostname, service, originRequest, path } List of public hostname definitions. At least one ingress rule needs to be defined for the tunnel.
List of public hostname definitions. At least one ingress rule needs to be defined for the tunnel.
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’.
originRequest: optional { access, caPool, connectTimeout, 12 more } Configuration parameters for the public hostname specific connection settings between cloudflared and origin server.
Configuration parameters for the public hostname specific connection settings between cloudflared and origin server.
access: optional { audTag, teamName, required } For all L7 requests to this hostname, cloudflared will validate each request’s Cf-Access-Jwt-Assertion request header.
For all L7 requests to this hostname, cloudflared will validate each request’s Cf-Access-Jwt-Assertion request header.
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.
Timeout for establishing a new TCP connection to your origin server. This excludes the time taken to establish TLS, which is controlled by tlsTimeout.
Disables chunked transfer encoding. Useful if you are running a WSGI server.
Attempt to connect to origin using HTTP2. Origin must be configured as https.
Maximum number of idle keepalive connections between Tunnel and your origin. This does not restrict the total number of concurrent connections.
Disable the “happy eyeballs” algorithm for IPv4/IPv6 fallback if your local network has misconfigured one of the protocols.
Disables TLS verification of the certificate presented by your origin. Will allow any certificate from the origin to be accepted.
Hostname that cloudflared should expect from your origin server certificate.
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.
originRequest: optional { access, caPool, connectTimeout, 12 more } Configuration parameters for the public hostname specific connection settings between cloudflared and origin server.
Configuration parameters for the public hostname specific connection settings between cloudflared and origin server.
access: optional { audTag, teamName, required } For all L7 requests to this hostname, cloudflared will validate each request’s Cf-Access-Jwt-Assertion request header.
For all L7 requests to this hostname, cloudflared will validate each request’s Cf-Access-Jwt-Assertion request header.
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.
Timeout for establishing a new TCP connection to your origin server. This excludes the time taken to establish TLS, which is controlled by tlsTimeout.
Disables chunked transfer encoding. Useful if you are running a WSGI server.
Attempt to connect to origin using HTTP2. Origin must be configured as https.
Maximum number of idle keepalive connections between Tunnel and your origin. This does not restrict the total number of concurrent connections.
Disable the “happy eyeballs” algorithm for IPv4/IPv6 fallback if your local network has misconfigured one of the protocols.
Disables TLS verification of the certificate presented by your origin. Will allow any certificate from the origin to be accepted.
Hostname that cloudflared should expect from your origin server certificate.
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.
ConfigurationUpdateResponse { account_id, config, created_at, 3 more } Cloudflare Tunnel configuration
Cloudflare Tunnel configuration
config: optional { ingress, originRequest } The tunnel configuration and ingress rules.
The tunnel configuration and ingress rules.
ingress: optional array of { hostname, service, originRequest, path } List of public hostname definitions. At least one ingress rule needs to be defined for the tunnel.
List of public hostname definitions. At least one ingress rule needs to be defined for the tunnel.
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’.
originRequest: optional { access, caPool, connectTimeout, 12 more } Configuration parameters for the public hostname specific connection settings between cloudflared and origin server.
Configuration parameters for the public hostname specific connection settings between cloudflared and origin server.
access: optional { audTag, teamName, required } For all L7 requests to this hostname, cloudflared will validate each request’s Cf-Access-Jwt-Assertion request header.
For all L7 requests to this hostname, cloudflared will validate each request’s Cf-Access-Jwt-Assertion request header.
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.
Timeout for establishing a new TCP connection to your origin server. This excludes the time taken to establish TLS, which is controlled by tlsTimeout.
Disables chunked transfer encoding. Useful if you are running a WSGI server.
Attempt to connect to origin using HTTP2. Origin must be configured as https.
Maximum number of idle keepalive connections between Tunnel and your origin. This does not restrict the total number of concurrent connections.
Disable the “happy eyeballs” algorithm for IPv4/IPv6 fallback if your local network has misconfigured one of the protocols.
Disables TLS verification of the certificate presented by your origin. Will allow any certificate from the origin to be accepted.
Hostname that cloudflared should expect from your origin server certificate.
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.
originRequest: optional { access, caPool, connectTimeout, 12 more } Configuration parameters for the public hostname specific connection settings between cloudflared and origin server.
Configuration parameters for the public hostname specific connection settings between cloudflared and origin server.
access: optional { audTag, teamName, required } For all L7 requests to this hostname, cloudflared will validate each request’s Cf-Access-Jwt-Assertion request header.
For all L7 requests to this hostname, cloudflared will validate each request’s Cf-Access-Jwt-Assertion request header.
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.
Timeout for establishing a new TCP connection to your origin server. This excludes the time taken to establish TLS, which is controlled by tlsTimeout.
Disables chunked transfer encoding. Useful if you are running a WSGI server.
Attempt to connect to origin using HTTP2. Origin must be configured as https.
Maximum number of idle keepalive connections between Tunnel and your origin. This does not restrict the total number of concurrent connections.
Disable the “happy eyeballs” algorithm for IPv4/IPv6 fallback if your local network has misconfigured one of the protocols.
Disables TLS verification of the certificate presented by your origin. Will allow any certificate from the origin to be accepted.
Hostname that cloudflared should expect from your origin server certificate.
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.
TunnelsCloudflaredConnections
List Cloudflare Tunnel connections
Clean up Cloudflare Tunnel connections
ModelsExpand Collapse
Client { id, arch, config_version, 4 more } A client (typically cloudflared) that maintains connections to a Cloudflare data center.
A client (typically cloudflared) that maintains connections to a Cloudflare data center.
The version of the remote tunnel configuration. Used internally to sync cloudflared with the Zero Trust dashboard.
conns: optional array of { id, client_id, client_version, 5 more } The Cloudflare Tunnel connections between your origin and Cloudflare’s edge.
The Cloudflare Tunnel connections between your origin and Cloudflare’s edge.
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.
TunnelsCloudflaredToken
Get a Cloudflare Tunnel token
TunnelsCloudflaredConnectors
Get Cloudflare Tunnel connector
TunnelsCloudflaredManagement
Get a Cloudflare Tunnel management token
TunnelsWARP Connector
List Warp Connector Tunnels
Get a Warp Connector Tunnel
Create a Warp Connector Tunnel
Update a Warp Connector Tunnel
Delete a Warp Connector Tunnel
ModelsExpand Collapse
WARPConnectorListResponse { id, account_tag, connections, 8 more } A Warp Connector Tunnel that connects your origin to Cloudflare’s edge.
A Warp Connector Tunnel that connects your origin to Cloudflare’s edge.
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.
The Cloudflare Tunnel connections between your origin and Cloudflare’s edge.
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.
Timestamp of when the tunnel established at least one connection to Cloudflare’s edge. If null, the tunnel is inactive.
Timestamp of when the tunnel became inactive (no connections to Cloudflare’s edge). If null, the tunnel is active.
Timestamp of when the resource was deleted. If null, the resource has not been deleted.
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).
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).
WARPConnectorGetResponse { id, account_tag, connections, 8 more } A Warp Connector Tunnel that connects your origin to Cloudflare’s edge.
A Warp Connector Tunnel that connects your origin to Cloudflare’s edge.
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.
The Cloudflare Tunnel connections between your origin and Cloudflare’s edge.
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.
Timestamp of when the tunnel established at least one connection to Cloudflare’s edge. If null, the tunnel is inactive.
Timestamp of when the tunnel became inactive (no connections to Cloudflare’s edge). If null, the tunnel is active.
Timestamp of when the resource was deleted. If null, the resource has not been deleted.
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).
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).
WARPConnectorCreateResponse { id, account_tag, connections, 8 more } A Warp Connector Tunnel that connects your origin to Cloudflare’s edge.
A Warp Connector Tunnel that connects your origin to Cloudflare’s edge.
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.
The Cloudflare Tunnel connections between your origin and Cloudflare’s edge.
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.
Timestamp of when the tunnel established at least one connection to Cloudflare’s edge. If null, the tunnel is inactive.
Timestamp of when the tunnel became inactive (no connections to Cloudflare’s edge). If null, the tunnel is active.
Timestamp of when the resource was deleted. If null, the resource has not been deleted.
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).
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).
WARPConnectorEditResponse { id, account_tag, connections, 8 more } A Warp Connector Tunnel that connects your origin to Cloudflare’s edge.
A Warp Connector Tunnel that connects your origin to Cloudflare’s edge.
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.
The Cloudflare Tunnel connections between your origin and Cloudflare’s edge.
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.
Timestamp of when the tunnel established at least one connection to Cloudflare’s edge. If null, the tunnel is inactive.
Timestamp of when the tunnel became inactive (no connections to Cloudflare’s edge). If null, the tunnel is active.
Timestamp of when the resource was deleted. If null, the resource has not been deleted.
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).
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).
WARPConnectorDeleteResponse { id, account_tag, connections, 8 more } A Warp Connector Tunnel that connects your origin to Cloudflare’s edge.
A Warp Connector Tunnel that connects your origin to Cloudflare’s edge.
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.
The Cloudflare Tunnel connections between your origin and Cloudflare’s edge.
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.
Timestamp of when the tunnel established at least one connection to Cloudflare’s edge. If null, the tunnel is inactive.
Timestamp of when the tunnel became inactive (no connections to Cloudflare’s edge). If null, the tunnel is active.
Timestamp of when the resource was deleted. If null, the resource has not been deleted.
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).
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).
TunnelsWARP ConnectorToken
Get a Warp Connector Tunnel token
TunnelsWARP ConnectorConnections
List WARP Connector Tunnel connections
ModelsExpand Collapse
ConnectionGetResponse { id, arch, conns, 4 more } A WARP Connector client that maintains a connection to a Cloudflare data center.
A WARP Connector client that maintains a connection to a Cloudflare data center.
TunnelsWARP ConnectorConnectors
Get WARP Connector Tunnel connector
ModelsExpand Collapse
ConnectorGetResponse { id, arch, conns, 4 more } A WARP Connector client that maintains a connection to a Cloudflare data center.
A WARP Connector client that maintains a connection to a Cloudflare data center.