Search + K

Command Palette

Search for a command to run...

Sign In

Get tunnel route

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

Get a private network route in an account.

Parameters

path Path Parameters

Name Type
account_id required
type TunnelAccountId = string
route_id required
type TunnelRouteId = string

Responses

200 application/json

Get a tunnel route response

type TunnelRouteResponseSingle = interface TunnelApiResponseCommon {
errors: TunnelMessages
type TunnelMessages = { code: number;message: string; }[]
;
messages: TunnelMessages
type TunnelMessages = { code: number;message: string; }[]
;
result: {} | unknown[] | string;
success: true;
}
& { result?: TunnelRoute
interface TunnelRoute {
comment?: TunnelRouteComment;
created_at?: TunnelCreatedAt;
deleted_at?: TunnelDeletedAt;
id?: TunnelRouteId;
network?: TunnelIpNetwork;
tunnel_id?: TunnelTunnelId;
virtual_network_id?: TunnelVirtualNetworkId;
}
; }

Client Errors

4XX application/json

Get a tunnel route response failure

type TunnelRouteResponseSingle = interface TunnelApiResponseCommon {
errors: TunnelMessages
type TunnelMessages = { code: number;message: string; }[]
;
messages: TunnelMessages
type TunnelMessages = { code: number;message: string; }[]
;
result: {} | unknown[] | string;
success: true;
}
& { result?: TunnelRoute
interface TunnelRoute {
comment?: TunnelRouteComment;
created_at?: TunnelCreatedAt;
deleted_at?: TunnelDeletedAt;
id?: TunnelRouteId;
network?: TunnelIpNetwork;
tunnel_id?: TunnelTunnelId;
virtual_network_id?: TunnelVirtualNetworkId;
}
; }
& interface TunnelApiResponseCommonFailure {
errors: TunnelMessages
type TunnelMessages = { code: number;message: string; }[]
;
messages: TunnelMessages
type TunnelMessages = { code: number;message: string; }[]
;
result: null;
success: false;
}