Get tunnel route by IP

GET /accounts/{account_id}/teamnet/routes/ip/{ip}

Copy endpoint

https://api.cloudflare.com/client/v4

Fetches routes that contain the given IP address.

Parameters

path Path Parameters

Name	Type
`ip` required	type TunnelIp = string
`account_id` required	type TunnelAccountId = string

query Query Parameters

Name	Type
`virtual_network_id`	type TunnelVirtualNetworkId = string
`default_virtual_network_fallback` When the virtual_network_id parameter is not provided the request filter will default search routes that are in the default virtual network for the account. If this parameter is set to false, the search will include routes that do not have a virtual network.	boolean

Responses

200 application/json

Get tunnel route by IP response

type TunnelTeamnetResponseSingle = interface TunnelApiResponseCommon {
errors:

TunnelMessages

type TunnelMessages = { code: number;message: string; }[]

;
messages:

TunnelMessages

type TunnelMessages = { code: number;message: string; }[]

;
result: {} | unknown[] | string;
success: true;
} & { 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

Get tunnel route by IP response failure

type TunnelTeamnetResponseSingle = interface TunnelApiResponseCommon {
errors:

TunnelMessages

type TunnelMessages = { code: number;message: string; }[]

;
messages:

TunnelMessages

type TunnelMessages = { code: number;message: string; }[]

;
result: {} | unknown[] | string;
success: true;
} & { result?:

TunnelTeamnet

; } & interface TunnelApiResponseCommonFailure {
errors:

TunnelMessages

type TunnelMessages = { code: number;message: string; }[]

;
messages:

TunnelMessages

type TunnelMessages = { code: number;message: string; }[]

;
result: null;
success: false;
}