--- title: List All Tunnels --- [Skip to content](#_top) [API Reference](https://developers.cloudflare.com/api/go) [Zero Trust](https://developers.cloudflare.com/api/go/resources/zero_trust) [Tunnels](https://developers.cloudflare.com/api/go/resources/zero_trust/subresources/tunnels) Copy Markdown Open in **Claude**Open in **ChatGPT**Open in **Cursor** --- **Copy Markdown****View as Markdown** # List All Tunnels client.ZeroTrust.Tunnels.List(ctx, params) (\*V4PagePaginationArray\[[TunnelListResponse]()], error) GET/accounts/{account\_id}/tunnels Lists and filters all types of Tunnels in an account. ##### Security
API Token The preferred authorization scheme for interacting with the Cloudflare API. Create a token. **Example:**Authorization: Bearer Sn3lZJTBX6kkg7OdcBUAxOO963GEIyGQqnFTOFYY
API Email + API Key The previous authorization scheme for interacting with the Cloudflare API, used in conjunction with a Global API key. **Example:**X-Auth-Email: user@example.com The previous authorization scheme for interacting with the Cloudflare API. When possible, use API tokens instead of Global API keys. **Example:**X-Auth-Key: 144c9defac04969c7bfad8efaa8ea194
##### Accepted Permissions (at least one required) `Cloudflare One Connectors Write``Cloudflare One Connectors Read``Cloudflare One Connector: cloudflared Write``Cloudflare One Connector: cloudflared Read``Cloudflare Tunnel Write``Cloudflare Tunnel Read` ##### ParametersExpand Collapse
params TunnelListParams AccountID param.Field\[string] Path param: Cloudflare account ID maxLength32 Link to this property ExcludePrefix param.Field\[string]Optional Query param Link to this property ExistedAt param.Field\[string]Optional Query param: If provided, include only resources that were created (and not deleted) before this time. URL encoded. formaturl-encoded-date-time Link to this property IncludePrefix param.Field\[string]Optional Query param Link to this property IsDeleted param.Field\[bool]Optional Query param: If true, only include deleted tunnels. If false, exclude deleted tunnels. If empty, all tunnels will be included. Link to this property Name param.Field\[string]Optional Query param: A user-friendly name for the tunnel. Link to this property Page param.Field\[float64]Optional Query param: Page number of paginated results. minimum1 Link to this property PerPage param.Field\[float64]Optional Query param: Number of results to display. maximum1000 minimum1 Link to this property
Status param.Field\[TunnelListParamsStatus]Optional Query param: 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). const TunnelListParamsStatusInactive TunnelListParamsStatus = "inactive" Link to this property const TunnelListParamsStatusDegraded TunnelListParamsStatus = "degraded" Link to this property const TunnelListParamsStatusHealthy TunnelListParamsStatus = "healthy" Link to this property const TunnelListParamsStatusDown TunnelListParamsStatus = "down" Link to this property
Link to this property
TunTypes param.Field\[\[]TunnelListParamsTunType]Optional Query param: The types of tunnels to filter by, separated by commas. const TunnelListParamsTunTypeCfdTunnel TunnelListParamsTunType = "cfd\_tunnel" Link to this property const TunnelListParamsTunTypeWARPConnector TunnelListParamsTunType = "warp\_connector" Link to this property const TunnelListParamsTunTypeWARP TunnelListParamsTunType = "warp" Link to this property const TunnelListParamsTunTypeMagic TunnelListParamsTunType = "magic" Link to this property const TunnelListParamsTunTypeIPSec TunnelListParamsTunType = "ip\_sec" Link to this property const TunnelListParamsTunTypeGRE TunnelListParamsTunType = "gre" Link to this property const TunnelListParamsTunTypeCNI TunnelListParamsTunType = "cni" Link to this property
Link to this property UUID param.Field\[string]Optional Query param: UUID of the tunnel. formatuuid maxLength36 Link to this property WasActiveAt param.Field\[Time]Optional Query param formatdate-time Link to this property WasInactiveAt param.Field\[Time]Optional Query param formatdate-time Link to this property
[Link to this property](<#(resource)%20zero_trust.tunnels%20%3E%20(method)%20list%20%3E%20(params)%20default>) ##### ReturnsExpand Collapse
type TunnelListResponse interface{…} A Cloudflare Tunnel that connects your origin to Cloudflare’s edge. One of the following:
type CloudflareTunnel struct{…} A Cloudflare Tunnel that connects your origin to Cloudflare’s edge. ID stringOptional UUID of the tunnel. formatuuid maxLength36 Link to this property AccountTag stringOptional Cloudflare account ID maxLength32 Link to this property
ConfigSrc CloudflareTunnelConfigSrcOptional 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: const CloudflareTunnelConfigSrcLocal CloudflareTunnelConfigSrc = "local" Link to this property const CloudflareTunnelConfigSrcCloudflare CloudflareTunnelConfigSrc = "cloudflare" Link to this property
Link to this property
DeprecatedConnections \[]CloudflareTunnelConnectionOptional 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 stringOptional UUID of the Cloudflare Tunnel connection. formatuuid maxLength36 Link to this property ClientID stringOptional UUID of the Cloudflare Tunnel connector. formatuuid maxLength36 Link to this property ClientVersion stringOptional The cloudflared version used to establish this connection. Link to this property ColoName stringOptional The Cloudflare data center used for this connection. Link to this property DeprecatedIsPendingReconnect boolOptional This functionality has been removed. The is\_pending\_reconnect field will now always report false. 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. Link to this property OpenedAt TimeOptional Timestamp of when the connection was established. formatdate-time Link to this property OriginIP stringOptional The public IP address of the host running cloudflared. Link to this property UUID stringOptional UUID of the Cloudflare Tunnel connection. formatuuid maxLength36 Link to this property
Link to this property ConnsActiveAt TimeOptional Timestamp of when the tunnel established at least one connection to Cloudflare’s edge. If null, the tunnel is inactive. formatdate-time Link to this property ConnsInactiveAt TimeOptional Timestamp of when the tunnel became inactive (no connections to Cloudflare’s edge). If null, the tunnel is active. formatdate-time Link to this property CreatedAt TimeOptional Timestamp of when the resource was created. formatdate-time Link to this property DeletedAt TimeOptional Timestamp of when the resource was deleted. If null, the resource has not been deleted. formatdate-time Link to this property Metadata unknownOptional Metadata associated with the tunnel. Link to this property Name stringOptional A user-friendly name for a tunnel. Link to this property DeprecatedRemoteConfig boolOptional 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. Link to this property
Status CloudflareTunnelStatusOptional 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: const CloudflareTunnelStatusInactive CloudflareTunnelStatus = "inactive" Link to this property const CloudflareTunnelStatusDegraded CloudflareTunnelStatus = "degraded" Link to this property const CloudflareTunnelStatusHealthy CloudflareTunnelStatus = "healthy" Link to this property const CloudflareTunnelStatusDown CloudflareTunnelStatus = "down" Link to this property
Link to this property
TunType CloudflareTunnelTunTypeOptional The type of tunnel. One of the following: const CloudflareTunnelTunTypeCfdTunnel CloudflareTunnelTunType = "cfd\_tunnel" Link to this property const CloudflareTunnelTunTypeWARPConnector CloudflareTunnelTunType = "warp\_connector" Link to this property const CloudflareTunnelTunTypeWARP CloudflareTunnelTunType = "warp" Link to this property const CloudflareTunnelTunTypeMagic CloudflareTunnelTunType = "magic" Link to this property const CloudflareTunnelTunTypeIPSec CloudflareTunnelTunType = "ip\_sec" Link to this property const CloudflareTunnelTunTypeGRE CloudflareTunnelTunType = "gre" Link to this property const CloudflareTunnelTunTypeCNI CloudflareTunnelTunType = "cni" Link to this property
Link to this property
Link to this property
type TunnelListResponseTunnelWARPConnectorTunnel struct{…} A Mesh node that connects your origin to Cloudflare’s edge. ID stringOptional UUID of the tunnel. formatuuid maxLength36 Link to this property AccountTag stringOptional Cloudflare account ID maxLength32 Link to this property
DeprecatedConnections \[]TunnelListResponseTunnelWARPConnectorTunnelConnectionOptional 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 stringOptional UUID of the Cloudflare Tunnel connection. formatuuid maxLength36 Link to this property ClientID stringOptional UUID of the Cloudflare Tunnel connector. formatuuid maxLength36 Link to this property ClientVersion stringOptional The cloudflared version used to establish this connection. Link to this property ColoName stringOptional The Cloudflare data center used for this connection. Link to this property DeprecatedIsPendingReconnect boolOptional This functionality has been removed. The is\_pending\_reconnect field will now always report false. 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. Link to this property OpenedAt TimeOptional Timestamp of when the connection was established. formatdate-time Link to this property OriginIP stringOptional The public IP address of the host running cloudflared. Link to this property UUID stringOptional UUID of the Cloudflare Tunnel connection. formatuuid maxLength36 Link to this property
Link to this property ConnsActiveAt TimeOptional Timestamp of when the tunnel established at least one connection to Cloudflare’s edge. If null, the tunnel is inactive. formatdate-time Link to this property ConnsInactiveAt TimeOptional Timestamp of when the tunnel became inactive (no connections to Cloudflare’s edge). If null, the tunnel is active. formatdate-time Link to this property CreatedAt TimeOptional Timestamp of when the resource was created. formatdate-time Link to this property DeletedAt TimeOptional Timestamp of when the resource was deleted. If null, the resource has not been deleted. formatdate-time Link to this property Metadata unknownOptional Metadata associated with the tunnel. Link to this property Name stringOptional A user-friendly name for a tunnel. Link to this property
Status TunnelListResponseTunnelWARPConnectorTunnelStatusOptional 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: const TunnelListResponseTunnelWARPConnectorTunnelStatusInactive TunnelListResponseTunnelWARPConnectorTunnelStatus = "inactive" Link to this property const TunnelListResponseTunnelWARPConnectorTunnelStatusDegraded TunnelListResponseTunnelWARPConnectorTunnelStatus = "degraded" Link to this property const TunnelListResponseTunnelWARPConnectorTunnelStatusHealthy TunnelListResponseTunnelWARPConnectorTunnelStatus = "healthy" Link to this property const TunnelListResponseTunnelWARPConnectorTunnelStatusDown TunnelListResponseTunnelWARPConnectorTunnelStatus = "down" Link to this property
Link to this property
TunType TunnelListResponseTunnelWARPConnectorTunnelTunTypeOptional The type of tunnel. One of the following: const TunnelListResponseTunnelWARPConnectorTunnelTunTypeCfdTunnel TunnelListResponseTunnelWARPConnectorTunnelTunType = "cfd\_tunnel" Link to this property const TunnelListResponseTunnelWARPConnectorTunnelTunTypeWARPConnector TunnelListResponseTunnelWARPConnectorTunnelTunType = "warp\_connector" Link to this property const TunnelListResponseTunnelWARPConnectorTunnelTunTypeWARP TunnelListResponseTunnelWARPConnectorTunnelTunType = "warp" Link to this property const TunnelListResponseTunnelWARPConnectorTunnelTunTypeMagic TunnelListResponseTunnelWARPConnectorTunnelTunType = "magic" Link to this property const TunnelListResponseTunnelWARPConnectorTunnelTunTypeIPSec TunnelListResponseTunnelWARPConnectorTunnelTunType = "ip\_sec" Link to this property const TunnelListResponseTunnelWARPConnectorTunnelTunTypeGRE TunnelListResponseTunnelWARPConnectorTunnelTunType = "gre" Link to this property const TunnelListResponseTunnelWARPConnectorTunnelTunTypeCNI TunnelListResponseTunnelWARPConnectorTunnelTunType = "cni" Link to this property
Link to this property
Link to this property
[Link to this property](<#(resource)%20zero_trust.tunnels%20%3E%20(model)%20TunnelListResponse%20%3E%20(schema)>) ### List All Tunnels Go HTTPTypeScriptPythonGoTerraform ``` package main import ( "context" "fmt" "github.com/cloudflare/cloudflare-go" "github.com/cloudflare/cloudflare-go/option" "github.com/cloudflare/cloudflare-go/zero_trust" ) func main() { client := cloudflare.NewClient( option.WithAPIToken("Sn3lZJTBX6kkg7OdcBUAxOO963GEIyGQqnFTOFYY"), ) page, err := client.ZeroTrust.Tunnels.List(context.TODO(), zero_trust.TunnelListParams{ AccountID: cloudflare.F("699d98642c564d2e855e9661899b7252"), }) if err != nil { panic(err.Error()) } fmt.Printf("%+v\n", page) } ``` 200 example ``` { "errors": [ { "code": 1000, "message": "message", "documentation_url": "documentation_url", "source": { "pointer": "pointer" } } ], "messages": [ { "code": 1000, "message": "message", "documentation_url": "documentation_url", "source": { "pointer": "pointer" } } ], "result": [ { "id": "f70ff985-a4ef-4643-bbbc-4a0ed4fc8415", "account_tag": "699d98642c564d2e855e9661899b7252", "config_src": "cloudflare", "connections": [ { "id": "1bedc50d-42b3-473c-b108-ff3d10c0d925", "client_id": "1bedc50d-42b3-473c-b108-ff3d10c0d925", "client_version": "2022.7.1", "colo_name": "DFW", "is_pending_reconnect": false, "opened_at": "2021-01-25T18:22:34.317854Z", "origin_ip": "10.1.0.137", "uuid": "1bedc50d-42b3-473c-b108-ff3d10c0d925" } ], "conns_active_at": "2009-11-10T23:00:00Z", "conns_inactive_at": "2009-11-10T23:00:00Z", "created_at": "2021-01-25T18:22:34.317854Z", "deleted_at": "2009-11-10T23:00:00Z", "metadata": {}, "name": "blog", "remote_config": true, "status": "healthy", "tun_type": "cfd_tunnel" } ], "success": true, "result_info": { "count": 1, "page": 1, "per_page": 20, "total_count": 2000 } } ``` ##### Returns Examples 200 example ``` { "errors": [ { "code": 1000, "message": "message", "documentation_url": "documentation_url", "source": { "pointer": "pointer" } } ], "messages": [ { "code": 1000, "message": "message", "documentation_url": "documentation_url", "source": { "pointer": "pointer" } } ], "result": [ { "id": "f70ff985-a4ef-4643-bbbc-4a0ed4fc8415", "account_tag": "699d98642c564d2e855e9661899b7252", "config_src": "cloudflare", "connections": [ { "id": "1bedc50d-42b3-473c-b108-ff3d10c0d925", "client_id": "1bedc50d-42b3-473c-b108-ff3d10c0d925", "client_version": "2022.7.1", "colo_name": "DFW", "is_pending_reconnect": false, "opened_at": "2021-01-25T18:22:34.317854Z", "origin_ip": "10.1.0.137", "uuid": "1bedc50d-42b3-473c-b108-ff3d10c0d925" } ], "conns_active_at": "2009-11-10T23:00:00Z", "conns_inactive_at": "2009-11-10T23:00:00Z", "created_at": "2021-01-25T18:22:34.317854Z", "deleted_at": "2009-11-10T23:00:00Z", "metadata": {}, "name": "blog", "remote_config": true, "status": "healthy", "tun_type": "cfd_tunnel" } ], "success": true, "result_info": { "count": 1, "page": 1, "per_page": 20, "total_count": 2000 } } ```