Search + K

Command Palette

Search for a command to run...

Sign In

List tunnel routes

GET /accounts/{account_id}/teamnet/routes
Copy endpoint
https://api.cloudflare.com/client/v4

Lists and filters private network routes in an account.

Parameters

path Path Parameters

Name Type
account_id required
type TunnelAccountId = string

query Query Parameters

Name Type
comment
type TunnelRouteComment = string
is_deleted
boolean
network_subset
type TunnelIpNetwork = string
network_superset
type TunnelIpNetwork = string
existed_at
type TunnelExistedAt = string
tunnel_id
type TunnelTunnelId = string
route_id
type TunnelRouteId = string
tun_types
type TunnelTunnelTypes = type TunnelTunnelType = "cfd_tunnel" | "warp_connector" | "warp" | "magic" | "ip_sec" | "gre" | "cni"[]
virtual_network_id
type TunnelVirtualNetworkId = string
per_page
type TunnelPerPage = number
page
type TunnelPageNumber = number

Responses

200 application/json

List tunnel routes response

type TunnelTeamnetResponseCollection = type TunnelApiResponseCollection = never & { result?: TunnelTeamnet
interface TunnelTeamnet {
comment?: TunnelRouteComment;
created_at?: TunnelCreatedAt;
deleted_at?: TunnelDeletedAt;
id?: TunnelRouteId;
network?: TunnelIpNetwork;
tun_type?: TunnelTunnelType;
tunnel_id?: TunnelTunnelId;
tunnel_name?: TunnelTunnelName;
virtual_network_id?: TunnelVirtualNetworkIdComputedOptional;
virtual_network_name?: TunnelVirtualNetworkName;
}
[]
; }

Client Errors

4XX application/json

List tunnel routes response failure

type TunnelTeamnetResponseCollection = type TunnelApiResponseCollection = never & { result?: TunnelTeamnet
interface TunnelTeamnet {
comment?: TunnelRouteComment;
created_at?: TunnelCreatedAt;
deleted_at?: TunnelDeletedAt;
id?: TunnelRouteId;
network?: TunnelIpNetwork;
tun_type?: TunnelTunnelType;
tunnel_id?: TunnelTunnelId;
tunnel_name?: TunnelTunnelName;
virtual_network_id?: TunnelVirtualNetworkIdComputedOptional;
virtual_network_name?: TunnelVirtualNetworkName;
}
[]
; }
& interface TunnelApiResponseCommonFailure {
errors: TunnelMessages
type TunnelMessages = { code: number;message: string; }[]
;
messages: TunnelMessages
type TunnelMessages = { code: number;message: string; }[]
;
result: null;
success: false;
}