API Reference

Zero Trust

Networks

Copy Markdown

Open in Claude

Open in ChatGPT

Open in Cursor

---

Copy Markdown

View as Markdown

Routes

List tunnel routes

client.zeroTrust.networks.routes.list(RouteListParams { account_id, comment, existed_at, 9 more } params, RequestOptionsoptions?): V4PagePaginationArray<Teamnet { id, comment, created_at, 7 more } >

GET/accounts/{account_id}/teamnet/routes

Get tunnel route

client.zeroTrust.networks.routes.get(stringrouteId, RouteGetParams { account_id } params, RequestOptionsoptions?): Route { id, comment, created_at, 4 more }

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

Create a tunnel route

client.zeroTrust.networks.routes.create(RouteCreateParams { account_id, network, tunnel_id, 2 more } params, RequestOptionsoptions?): Route { id, comment, created_at, 4 more }

POST/accounts/{account_id}/teamnet/routes

Update a tunnel route

client.zeroTrust.networks.routes.edit(stringrouteId, RouteEditParams { account_id, comment, network, 2 more } params, RequestOptionsoptions?): Route { id, comment, created_at, 4 more }

PATCH/accounts/{account_id}/teamnet/routes/{route_id}

Delete a tunnel route

client.zeroTrust.networks.routes.delete(stringrouteId, RouteDeleteParams { account_id } params, RequestOptionsoptions?): Route { id, comment, created_at, 4 more }

DELETE/accounts/{account_id}/teamnet/routes/{route_id}

ModelsExpand Collapse

NetworkRoute { id, comment, created_at, 4 more }

id?: string

UUID of the route.

maxLength36

comment?: string

Optional remark describing the route.

maxLength100

created_at?: string

Timestamp of when the resource was created.

formatdate-time

deleted_at?: string

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

formatdate-time

network?: string

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

tunnel_id?: string

UUID of the tunnel.

formatuuid

maxLength36

virtual_network_id?: string

UUID of the virtual network.

formatuuid

Route { id, comment, created_at, 4 more }

id?: string

UUID of the route.

maxLength36

comment?: string

Optional remark describing the route.

maxLength100

created_at?: string

Timestamp of when the resource was created.

formatdate-time

deleted_at?: string

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

formatdate-time

network?: string

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

tunnel_id?: string

UUID of the tunnel.

formatuuid

maxLength36

virtual_network_id?: string

UUID of the virtual network.

formatuuid

Teamnet { id, comment, created_at, 7 more }

id?: string

UUID of the route.

maxLength36

comment?: string

Optional remark describing the route.

maxLength100

created_at?: string

Timestamp of when the resource was created.

formatdate-time

deleted_at?: string

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

formatdate-time

network?: string

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

tun_type?: "cfd_tunnel" | "warp_connector" | "warp" | 4 more

The type of tunnel.

One of the following:

"cfd_tunnel"

"warp_connector"

"warp"

"magic"

"ip_sec"

"gre"

"cni"

tunnel_id?: string

UUID of the tunnel.

formatuuid

maxLength36

tunnel_name?: string

A user-friendly name for a tunnel.

virtual_network_id?: string

UUID of the virtual network.

formatuuid

virtual_network_name?: string

A user-friendly name for the virtual network.

maxLength256

RoutesIPs

Get tunnel route by IP

client.zeroTrust.networks.routes.ips.get(stringip, IPGetParams { account_id, default_virtual_network_fallback, virtual_network_id } params, RequestOptionsoptions?): Teamnet { id, comment, created_at, 7 more }

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

RoutesNetworks

Create a tunnel route (CIDR Endpoint)

Deprecated

client.zeroTrust.networks.routes.networks.create(stringipNetworkEncoded, NetworkCreateParams { account_id, tunnel_id, comment, virtual_network_id } params, RequestOptionsoptions?): Route { id, comment, created_at, 4 more }

POST/accounts/{account_id}/teamnet/routes/network/{ip_network_encoded}

Update a tunnel route (CIDR Endpoint)

Deprecated

client.zeroTrust.networks.routes.networks.edit(stringipNetworkEncoded, NetworkEditParams { account_id } params, RequestOptionsoptions?): Route { id, comment, created_at, 4 more }

PATCH/accounts/{account_id}/teamnet/routes/network/{ip_network_encoded}

Delete a tunnel route (CIDR Endpoint)

Deprecated

client.zeroTrust.networks.routes.networks.delete(stringipNetworkEncoded, NetworkDeleteParams { account_id, tun_type, tunnel_id, virtual_network_id } params, RequestOptionsoptions?): Route { id, comment, created_at, 4 more }

DELETE/accounts/{account_id}/teamnet/routes/network/{ip_network_encoded}