List tunnel routes

Lists and filters private network routes in an account.

application/json

Body

result

required

Any of

allOf {2}

array[object (teamnet) {7}]

allOf {2}

One of

array[object (teamnet) {7}]

object

comment

string

schemas-comment

required

Optional remark describing the route.

Example:

Example comment for this route.

created_at

required

Timestamp of when the route was created.

deleted_at

string <date-time> | null

read-onlyoptional

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

Example:

2021-01-25T18:22:34.317854Z

network

string

ip_network

required

The private IPv4 or IPv6 range connected by the route, in CIDR notation.

Example:

172.16.0.0/16

tunnel_id

schemas-tunnel_id

required

UUID of the Cloudflare Tunnel serving the route.

tunnel_name

schemas-tunnel_name

optional

The user-friendly name of the Cloudflare Tunnel serving the route.

virtual_network_id

optional

UUID of the Tunnel Virtual Network this route belongs to. If no virtual networks are configured, the route is assigned to the default virtual network of the account.

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": [
        {
            "comment": "Example comment for this route.",
            "created_at": null,
            "deleted_at": "2021-01-25T18:22:34.317854Z",
            "network": "172.16.0.0/16",
            "tunnel_id": null,
            "tunnel_name": null,
            "virtual_network_id": null
        }
    ],
    "success": true,
    "result_info": {
        "count": 1,
        "page": 1,
        "per_page": 20,
        "total_count": 2000
    }
}

Request

Request samples

Responses