List All Tunnels
zero_trust.tunnels.list(TunnelListParams**kwargs) -> SyncV4PagePaginationArray[TunnelListResponse]
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:
API Email + API Key
The previous authorization scheme for interacting with the Cloudflare API, used in conjunction with a Global API key.
Example:
The previous authorization scheme for interacting with the Cloudflare API. When possible, use API tokens instead of Global API keys.
Example:
Accepted Permissions (at least one required)
List All Tunnels
import os
from cloudflare import Cloudflare
client = Cloudflare(
api_token=os.environ.get("CLOUDFLARE_API_TOKEN"), # This is the default and can be omitted
)
page = client.zero_trust.tunnels.list(
account_id="699d98642c564d2e855e9661899b7252",
)
page = page.result[0]
print(page){
"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:00.000000Z",
"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
{
"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:00.000000Z",
"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
}
}