List Cloudflare Tunnels

Lists and filters Cloudflare Tunnels in an account.

application/json

Body

result

required

Any of

allOf {2}

array[object (tunnel) {12}]

allOf {2}

One of

array[object (tunnel) {12}]

object

account_tag

string

cf_account_id

optional

Cloudflare account ID

<= 32 characters

Example:

699d98642c564d2e855e9661899b7252

connections

array[object (cloudflare-tunnel_components-schemas-connection) {8}]

connections

optional

The Cloudflare Tunnel connections between your origin and Cloudflare's edge.

conns_active_at

string <date-time> | null

conns_active_at

optional

Timestamp of when the tunnel established at least one connection to Cloudflare's edge. If null, the tunnel is inactive.

Example:

2009-11-10T23:00:00Z

conns_inactive_at

string <date-time> | null

conns_inactive_at

optional

Timestamp of when the tunnel became inactive (no connections to Cloudflare's edge). If null, the tunnel is active.

Example:

2009-11-10T23:00:00Z

created_at

string <date-time>

cloudflare-tunnel_components-schemas-created_at

optional

Timestamp of when the tunnel was created.

Example:

2021-01-25T18:22:34.317854Z

deleted_at

string <date-time> | null

schemas-deleted_at

optional

Timestamp of when the tunnel was deleted. If null, the tunnel has not been deleted.

Example:

2009-11-10T23:00:00Z

string

tunnel_id

read-onlyoptional

UUID of the tunnel.

<= 36 characters

Example:

f70ff985-a4ef-4643-bbbc-4a0ed4fc8415

metadata

object

cloudflare-tunnel_components-schemas-metadata

optional

Metadata associated with the tunnel.

Example:

{}

name

string

tunnel_name

optional

A user-friendly name for the tunnel.

Example:

blog

remote_config

boolean

remote_config

optional

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.

Example:

true

status

string

cloudflare-tunnel_components-schemas-status

optional

The status of the tunnel. Valid values are active, inactive or degraded (active but not all cloudflared instances have 4 connections to Cloudflare's edge).

Example:

active

tun_type

enum<string>

tunnel_type

optional

The type of tunnel.

Allowed value:

cfd_tunnel

Example:

cfd_tunnel

errors

array [object {2}]

messages

required

Example:

[]

code

integer

required

>= 1000

message

string

required

messages

array [object {2}]

messages

required

Example:

[]

code

integer

required

>= 1000

message

string

required

success

enum<boolean>

required

Whether the API call was successful

Allowed value:

true

Example:

true

result_info

object

result_info

optional

count

number

optional

Total number of results for the requested service

Example:

page

number

optional

Current page within paginated list of results

Example:

per_page

number

optional

Number of results per page of results

Example:

total_count

number

optional

Total results available without any search parameters

Example:

2000

Example

{
    "errors": [],
    "messages": [],
    "result": [
        {
            "account_tag": "699d98642c564d2e855e9661899b7252",
            "connections": [
                {
                    "client_id": null,
                    "client_version": "2022.7.1",
                    "colo_name": "DFW",
                    "id": "1bedc50d-42b3-473c-b108-ff3d10c0d925",
                    "is_pending_reconnect": false,
                    "opened_at": "2021-01-25T18:22:34.317854Z",
                    "origin_ip": "85.12.78.6",
                    "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",
            "id": "f70ff985-a4ef-4643-bbbc-4a0ed4fc8415",
            "metadata": {},
            "name": "blog",
            "remote_config": true,
            "status": "active",
            "tun_type": "cfd_tunnel"
        }
    ],
    "success": true,
    "result_info": {
        "count": 1,
        "page": 1,
        "per_page": 20,
        "total_count": 2000
    }
}

List Cloudflare Tunnels

Request

Request samples

Responses