APIs.io Engineering Platform Cloudflare Tunnel API
The Cloudflare Tunnel API from APIs.io Engineering Platform — 10 operation(s) for cloudflare tunnel.
This API exposes 17 operations across 10 paths, and defines 44 schemas. It is described by OpenAPI 3.0.0, at version 2015-07-09.
Requests are made against 4 base URLs: http://apigateway.{region}.amazonaws.com, https://apigateway.{region}.amazonaws.com, http://apigateway.{region}.amazonaws.com.cn, https://apigateway.{region}.amazonaws.com.cn.
17 operations
10 paths
44 schemas
3 DELETE9 GET2 PATCH3 POST
Metadata
The identity and technical contract details declared by the specification.
Authentication & Security 1
APIs.io Engineering Platform Cloudflare Tunnel API declares
1 security scheme
for authenticating requests.
An API key is passed in the header as Authorization (hmac).
By default, every request must be authenticated.
hmac— Amazon Signature authorization v4
Paths & Operations 17
Across 10 paths, the API surfaces 17 operations — 3 DELETE, 9 GET, 2 PATCH, 3 POST. Each is listed below with its method, path, parameters, and response codes.
Cloudflare Tunnel 17
GET
/accounts/{account_id}/cfd_tunnel
APIs.io Engineering Platform List Cloudflare Tunnels
POST
/accounts/{account_id}/cfd_tunnel
APIs.io Engineering Platform Create a Cloudflare Tunnel
DELETE
/accounts/{account_id}/cfd_tunnel/{tunnel_id}
APIs.io Engineering Platform Delete a Cloudflare Tunnel
GET
/accounts/{account_id}/cfd_tunnel/{tunnel_id}
APIs.io Engineering Platform Get a Cloudflare Tunnel
PATCH
/accounts/{account_id}/cfd_tunnel/{tunnel_id}
APIs.io Engineering Platform Update a Cloudflare Tunnel
DELETE
/accounts/{account_id}/cfd_tunnel/{tunnel_id}/connections
APIs.io Engineering Platform Clean up Cloudflare Tunnel connections
GET
/accounts/{account_id}/cfd_tunnel/{tunnel_id}/connections
APIs.io Engineering Platform List Cloudflare Tunnel connections
GET
/accounts/{account_id}/cfd_tunnel/{tunnel_id}/connectors/{connector_id}
APIs.io Engineering Platform Get Cloudflare Tunnel connector
POST
/accounts/{account_id}/cfd_tunnel/{tunnel_id}/management
APIs.io Engineering Platform Get a Cloudflare Tunnel management token
GET
/accounts/{account_id}/cfd_tunnel/{tunnel_id}/token
APIs.io Engineering Platform Get a Cloudflare Tunnel token
GET
/accounts/{account_id}/tunnels
APIs.io Engineering Platform List All Tunnels
GET
/accounts/{account_id}/warp_connector
APIs.io Engineering Platform List Warp Connector Tunnels
POST
/accounts/{account_id}/warp_connector
APIs.io Engineering Platform Create a Warp Connector Tunnel
DELETE
/accounts/{account_id}/warp_connector/{tunnel_id}
APIs.io Engineering Platform Delete a Warp Connector Tunnel
GET
/accounts/{account_id}/warp_connector/{tunnel_id}
APIs.io Engineering Platform Get a Warp Connector Tunnel
PATCH
/accounts/{account_id}/warp_connector/{tunnel_id}
APIs.io Engineering Platform Update a Warp Connector Tunnel
GET
/accounts/{account_id}/warp_connector/{tunnel_id}/token
APIs.io Engineering Platform Get a Warp Connector Tunnel token
Schemas 44
The contract defines 44 schemas that model the data the API accepts and returns. The most detailed are tunnel_cfd_tunnel (12 properties), tunnel_warp_connector_tunnel (11 properties), tunnel_schemas-connection (8 properties), tunnel_tunnel_client (7 properties). Each schema is shown below with its type and property counts.
tunnel_result_info
object
4 properties
tunnel_cfd_tunnel
object
A Cloudflare Tunnel that connects your origin to Cloudflare's edge.
12 properties
tunnel_run_at
string
Timestamp of when the tunnel connection was started.
tunnel_status
string
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…
tunnel_account_id
string
Cloudflare account ID
tunnel_version
string
The cloudflared version used to establish this connection.
tunnel_tunnel_types
string
The types of tunnels to filter separated by a comma.
tunnel_metadata
object
Metadata associated with the tunnel.
tunnel_features
array
Features enabled for the Cloudflare Tunnel.
tunnel_existed_at
string
If provided, include only tunnels that were created (and not deleted) before this time.
tunnel_api-response-single
tunnel_remote_config
boolean
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.
tunnel_client_id
string
UUID of the Cloudflare Tunnel connector.
tunnel_schemas-connection
object
8 properties
tunnel_per_page
number
Number of results to display.
tunnel_config_version
integer
The version of the remote tunnel configuration. Used internally to sync cloudflared with the Zero Trust dashboard.
tunnel_tunnel_client
object
A client (typically cloudflared) that maintains connections to a Cloudflare data center.
7 properties
tunnel_tunnel_connections_response
tunnel_warp_connector_tunnel
object
A Warp Connector Tunnel that connects your origin to Cloudflare's edge.
11 properties
tunnel_management-resources
string
Management resources the token will have access to.
tunnel_is_pending_reconnect
boolean
Cloudflare continues to track connections for several minutes after they disconnect. This is an optimization to improve latency and reliability of reconnecting…
tunnel_colo_name
string
The Cloudflare data center used for this connection.
tunnel_tunnel_client_response
tunnel_ip
string
tunnel_api-response-common-failure
object
4 properties
4 required
tunnel_conns_inactive_at
string
Timestamp of when the tunnel became inactive (no connections to Cloudflare's edge). If null, the tunnel is active.
tunnel_config_src
string
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 tu…
tunnel_conns_active_at
string
Timestamp of when the tunnel established at least one connection to Cloudflare's edge. If null, the tunnel is inactive.
tunnel_connections
array
The Cloudflare Tunnel connections between your origin and Cloudflare's edge.
tunnel_arch
string
The cloudflared OS architecture used to establish this connection.
tunnel_tunnel_secret
string
Sets the password required to run a locally-managed tunnel. Must be at least 32 bytes and encoded as a base64 string.
tunnel_deleted_at
string
Timestamp of when the resource was deleted. If null, the resource has not been deleted.
tunnel_connection_id
string
UUID of the Cloudflare Tunnel connection.
tunnel_messages
array
tunnel_empty_response
tunnel_api-response-common
object
4 properties
4 required
tunnel_tunnel_id
string
UUID of the tunnel.
tunnel_tunnel_name
string
A user-friendly name for a tunnel.
tunnel_tunnel_type
string
The type of tunnel.
tunnel_tunnel_response_token
tunnel_tunnel-response-single
tunnel_api-response-collection
object
tunnel_tunnel-response-collection
tunnel_created_at
string
Timestamp of when the resource was created.
Specification
The full machine-readable OpenAPI contract behind this narrative.
Source
#Cloudflare Tunnel