Create a tunnel route

POST /accounts/{account_id}/teamnet/routes

Copy endpoint

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

Routes a private network through a Cloudflare Tunnel.

Parameters

path Path Parameters

Name	Type
`account_id` required	type TunnelAccountId = string

Request Body

application/json required

{
comment?:

TunnelRouteComment

Optional remark describing the route.

type TunnelRouteComment = string

;
network:

TunnelIpNetwork

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

type TunnelIpNetwork = string

;
tunnel_id:

TunnelTunnelId

UUID of the tunnel.

type TunnelTunnelId = string

;
virtual_network_id?:

TunnelVirtualNetworkIdComputedOptional

UUID of the virtual network.

type TunnelVirtualNetworkIdComputedOptional = string

;
}

Responses

200 application/json

Create 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

Create 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 TunnelApiResponseCommonFailure {
errors:

TunnelMessages

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

;
messages:

TunnelMessages

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

;
result: null;
success: false;
}