List Cloudflare Tunnel connections

Fetches connection details for a Cloudflare Tunnel.

application/json

Body

result

required

Any of

allOf {2}

array[object (tunnel_connection) {7}]

allOf {2}

One of

array[object (tunnel_connection) {7}]

object

arch

string

arch

optional

The cloudflared OS architecture used to establish this connection.

Example:

linux_amd64

config_version

integer

config_version

optional

The version of the remote tunnel configuration. Used internally to sync cloudflared with the Zero Trust dashboard.

conns

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

connections

optional

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

features

array[string]

schemas-features

optional

Features enabled for the Cloudflare Tunnel.

string

connection_id

read-onlyoptional

UUID of the Cloudflare Tunnel connection.

<= 36 characters

Example:

1bedc50d-42b3-473c-b108-ff3d10c0d925

run_at

string <date-time>

run_at

optional

Timestamp of when the tunnel connection was started.

Example:

2009-11-10T23:00:00Z

version

string

cloudflare-tunnel_components-schemas-version

optional

The cloudflared version used to establish this connection.

Example:

2022.7.1

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": [
        {
            "arch": "linux_amd64",
            "config_version": 0,
            "conns": [
                {
                    "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"
                }
            ],
            "features": [
                "ha-origin"
            ],
            "id": "1bedc50d-42b3-473c-b108-ff3d10c0d925",
            "run_at": "2009-11-10T23:00:00Z",
            "version": "2022.7.1"
        }
    ],
    "success": true,
    "result_info": {
        "count": 1,
        "page": 1,
        "per_page": 20,
        "total_count": 2000
    }
}

List Cloudflare Tunnel connections

Request

Request samples

Responses