Skip to content
Start here

Networks

NetworksRoutes

List tunnel routes
GET/accounts/{account_id}/teamnet/routes
Get tunnel route
GET/accounts/{account_id}/teamnet/routes/{route_id}
Create a tunnel route
POST/accounts/{account_id}/teamnet/routes
Update a tunnel route
PATCH/accounts/{account_id}/teamnet/routes/{route_id}
Delete a tunnel route
DELETE/accounts/{account_id}/teamnet/routes/{route_id}
ModelsExpand Collapse
NetworkRoute = object { id, comment, created_at, 4 more }
id: optional string

UUID of the route.

maxLength36
comment: optional string

Optional remark describing the route.

maxLength100
created_at: optional string

Timestamp of when the resource was created.

formatdate-time
deleted_at: optional string

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

formatdate-time
network: optional string

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

tunnel_id: optional string

UUID of the tunnel.

formatuuid
maxLength36
virtual_network_id: optional string

UUID of the virtual network.

formatuuid
Route = object { id, comment, created_at, 4 more }
id: optional string

UUID of the route.

maxLength36
comment: optional string

Optional remark describing the route.

maxLength100
created_at: optional string

Timestamp of when the resource was created.

formatdate-time
deleted_at: optional string

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

formatdate-time
network: optional string

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

tunnel_id: optional string

UUID of the tunnel.

formatuuid
maxLength36
virtual_network_id: optional string

UUID of the virtual network.

formatuuid
Teamnet = object { id, comment, created_at, 7 more }
id: optional string

UUID of the route.

maxLength36
comment: optional string

Optional remark describing the route.

maxLength100
created_at: optional string

Timestamp of when the resource was created.

formatdate-time
deleted_at: optional string

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

formatdate-time
network: optional string

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

tun_type: optional "cfd_tunnel" or "warp_connector" or "warp" or 4 more

The type of tunnel.

One of the following:
"cfd_tunnel"
"warp_connector"
"warp"
"magic"
"ip_sec"
"gre"
"cni"
tunnel_id: optional string

UUID of the tunnel.

formatuuid
maxLength36
tunnel_name: optional string

A user-friendly name for a tunnel.

virtual_network_id: optional string

UUID of the virtual network.

formatuuid
virtual_network_name: optional string

A user-friendly name for the virtual network.

maxLength256

NetworksRoutesIPs

Get tunnel route by IP
GET/accounts/{account_id}/teamnet/routes/ip/{ip}

NetworksRoutesNetworks

Create a tunnel route (CIDR Endpoint)
Deprecated
POST/accounts/{account_id}/teamnet/routes/network/{ip_network_encoded}
Update a tunnel route (CIDR Endpoint)
Deprecated
PATCH/accounts/{account_id}/teamnet/routes/network/{ip_network_encoded}
Delete a tunnel route (CIDR Endpoint)
Deprecated
DELETE/accounts/{account_id}/teamnet/routes/network/{ip_network_encoded}

NetworksVirtual Networks

List virtual networks
GET/accounts/{account_id}/teamnet/virtual_networks
Get a virtual network
GET/accounts/{account_id}/teamnet/virtual_networks/{virtual_network_id}
Create a virtual network
POST/accounts/{account_id}/teamnet/virtual_networks
Update a virtual network
PATCH/accounts/{account_id}/teamnet/virtual_networks/{virtual_network_id}
Delete a virtual network
DELETE/accounts/{account_id}/teamnet/virtual_networks/{virtual_network_id}
ModelsExpand Collapse
VirtualNetwork = object { id, comment, created_at, 3 more }
id: string

UUID of the virtual network.

formatuuid
comment: string

Optional remark describing the virtual network.

maxLength256
created_at: string

Timestamp of when the resource was created.

formatdate-time
is_default_network: boolean

If true, this virtual network is the default for the account.

name: string

A user-friendly name for the virtual network.

maxLength256
deleted_at: optional string

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

formatdate-time

NetworksSubnets

List Subnets
GET/accounts/{account_id}/zerotrust/subnets

NetworksSubnetsWARP

Create WARP IP subnet
POST/accounts/{account_id}/zerotrust/subnets/warp
Get WARP IP subnet
GET/accounts/{account_id}/zerotrust/subnets/warp/{subnet_id}
Update WARP IP subnet
PATCH/accounts/{account_id}/zerotrust/subnets/warp/{subnet_id}
Delete WARP IP subnet
DELETE/accounts/{account_id}/zerotrust/subnets/warp/{subnet_id}
ModelsExpand Collapse
Subnet = object { id, comment, created_at, 5 more }
id: optional string

The UUID of the subnet.

formatuuid
comment: optional string

An optional description of the subnet.

created_at: optional string

Timestamp of when the resource was created.

formatdate-time
deleted_at: optional string

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

formatdate-time
is_default_network: optional boolean

If true, this is the default subnet for the account. There can only be one default subnet per account.

name: optional string

A user-friendly name for the subnet.

network: optional string

The private IPv4 or IPv6 range defining the subnet, in CIDR notation.

subnet_type: optional "cloudflare_source" or "warp"

The type of subnet.

One of the following:
"cloudflare_source"
"warp"
WARPDeleteResponse = object { id, comment, created_at, 5 more }
id: optional string

The UUID of the subnet.

formatuuid
comment: optional string

An optional description of the subnet.

created_at: optional string

Timestamp of when the resource was created.

formatdate-time
deleted_at: optional string

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

formatdate-time
is_default_network: optional boolean

If true, this is the default subnet for the account. There can only be one default subnet per account.

name: optional string

A user-friendly name for the subnet.

network: optional string

The private IPv4 or IPv6 range defining the subnet, in CIDR notation.

subnet_type: optional "cloudflare_source" or "warp"

The type of subnet.

One of the following:
"cloudflare_source"
"warp"

NetworksSubnetsCloudflare Source

Update Cloudflare Source Subnet
PATCH/accounts/{account_id}/zerotrust/subnets/cloudflare_source/{address_family}

NetworksHostname Routes

List hostname routes
GET/accounts/{account_id}/zerotrust/routes/hostname
Get hostname route
GET/accounts/{account_id}/zerotrust/routes/hostname/{hostname_route_id}
Create hostname route
POST/accounts/{account_id}/zerotrust/routes/hostname
Update hostname route
PATCH/accounts/{account_id}/zerotrust/routes/hostname/{hostname_route_id}
Delete hostname route
DELETE/accounts/{account_id}/zerotrust/routes/hostname/{hostname_route_id}
ModelsExpand Collapse
HostnameRoute = object { id, comment, created_at, 4 more }
id: optional string

The hostname route ID.

formatuuid
comment: optional string

An optional description of the hostname route.

created_at: optional string

Timestamp of when the resource was created.

formatdate-time
deleted_at: optional string

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

formatdate-time
hostname: optional string

The hostname of the route.

tunnel_id: optional string

UUID of the tunnel.

formatuuid
maxLength36
tunnel_name: optional string

A user-friendly name for a tunnel.