API Reference

Zero Trust

Copy Markdown

Open in Claude

Open in ChatGPT

Open in Cursor

---

Copy Markdown

View as Markdown

Networks

NetworksRoutes

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

NetworksRoutesIPs

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}

NetworksRoutesNetworks

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}

NetworksVirtual Networks

List virtual networks

client.zeroTrust.networks.virtualNetworks.list(VirtualNetworkListParams { account_id, id, is_default, 3 more } params, RequestOptionsoptions?): SinglePage<VirtualNetwork { id, comment, created_at, 3 more } >

GET/accounts/{account_id}/teamnet/virtual_networks

Get a virtual network

client.zeroTrust.networks.virtualNetworks.get(stringvirtualNetworkId, VirtualNetworkGetParams { account_id } params, RequestOptionsoptions?): VirtualNetwork { id, comment, created_at, 3 more }

GET/accounts/{account_id}/teamnet/virtual_networks/{virtual_network_id}

Create a virtual network

client.zeroTrust.networks.virtualNetworks.create(VirtualNetworkCreateParams { account_id, name, comment, 2 more } params, RequestOptionsoptions?): VirtualNetwork { id, comment, created_at, 3 more }

POST/accounts/{account_id}/teamnet/virtual_networks

Update a virtual network

client.zeroTrust.networks.virtualNetworks.edit(stringvirtualNetworkId, VirtualNetworkEditParams { account_id, comment, is_default_network, name } params, RequestOptionsoptions?): VirtualNetwork { id, comment, created_at, 3 more }

PATCH/accounts/{account_id}/teamnet/virtual_networks/{virtual_network_id}

Delete a virtual network

client.zeroTrust.networks.virtualNetworks.delete(stringvirtualNetworkId, VirtualNetworkDeleteParams { account_id } params, RequestOptionsoptions?): VirtualNetwork { id, comment, created_at, 3 more }

DELETE/accounts/{account_id}/teamnet/virtual_networks/{virtual_network_id}

ModelsExpand Collapse

VirtualNetwork { 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?: string

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

formatdate-time

NetworksSubnets

List Subnets

client.zeroTrust.networks.subnets.list(SubnetListParams { account_id, address_family, comment, 9 more } params, RequestOptionsoptions?): V4PagePaginationArray<Subnet { id, comment, created_at, 5 more } >

GET/accounts/{account_id}/zerotrust/subnets

NetworksSubnetsWARP

Create WARP IP subnet

client.zeroTrust.networks.subnets.warp.create(WARPCreateParams { account_id, name, network, 2 more } params, RequestOptionsoptions?): Subnet { id, comment, created_at, 5 more }

POST/accounts/{account_id}/zerotrust/subnets/warp

Get WARP IP subnet

client.zeroTrust.networks.subnets.warp.get(stringsubnetId, WARPGetParams { account_id } params, RequestOptionsoptions?): Subnet { id, comment, created_at, 5 more }

GET/accounts/{account_id}/zerotrust/subnets/warp/{subnet_id}

Update WARP IP subnet

client.zeroTrust.networks.subnets.warp.edit(stringsubnetId, WARPEditParams { account_id, comment, is_default_network, 2 more } params, RequestOptionsoptions?): Subnet { id, comment, created_at, 5 more }

PATCH/accounts/{account_id}/zerotrust/subnets/warp/{subnet_id}

Delete WARP IP subnet

client.zeroTrust.networks.subnets.warp.delete(stringsubnetId, WARPDeleteParams { account_id } params, RequestOptionsoptions?): WARPDeleteResponse { id, comment, created_at, 5 more } | null

DELETE/accounts/{account_id}/zerotrust/subnets/warp/{subnet_id}

ModelsExpand Collapse

Subnet { id, comment, created_at, 5 more }

id?: string

The UUID of the subnet.

formatuuid

comment?: string

An optional description of the subnet.

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

is_default_network?: boolean

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

name?: string

A user-friendly name for the subnet.

network?: string

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

subnet_type?: "cloudflare_source" | "warp"

The type of subnet.

One of the following:

"cloudflare_source"

"warp"

WARPDeleteResponse { id, comment, created_at, 5 more }

id?: string

The UUID of the subnet.

formatuuid

comment?: string

An optional description of the subnet.

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

is_default_network?: boolean

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

name?: string

A user-friendly name for the subnet.

network?: string

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

subnet_type?: "cloudflare_source" | "warp"

The type of subnet.

One of the following:

"cloudflare_source"

"warp"

NetworksSubnetsCloudflare Source

Update Cloudflare Source Subnet

client.zeroTrust.networks.subnets.cloudflareSource.update("v4" | "v6"addressFamily, CloudflareSourceUpdateParams { account_id, comment, name, network } params, RequestOptionsoptions?): Subnet { id, comment, created_at, 5 more }

PATCH/accounts/{account_id}/zerotrust/subnets/cloudflare_source/{address_family}

NetworksHostname Routes

List hostname routes

client.zeroTrust.networks.hostnameRoutes.list(HostnameRouteListParams { account_id, id, comment, 6 more } params, RequestOptionsoptions?): V4PagePaginationArray<HostnameRoute { id, comment, created_at, 4 more } >

GET/accounts/{account_id}/zerotrust/routes/hostname

Get hostname route

client.zeroTrust.networks.hostnameRoutes.get(stringhostnameRouteId, HostnameRouteGetParams { account_id } params, RequestOptionsoptions?): HostnameRoute { id, comment, created_at, 4 more }

GET/accounts/{account_id}/zerotrust/routes/hostname/{hostname_route_id}

Create hostname route

client.zeroTrust.networks.hostnameRoutes.create(HostnameRouteCreateParams { account_id, comment, hostname, tunnel_id } params, RequestOptionsoptions?): HostnameRoute { id, comment, created_at, 4 more }

POST/accounts/{account_id}/zerotrust/routes/hostname

Update hostname route

client.zeroTrust.networks.hostnameRoutes.edit(stringhostnameRouteId, HostnameRouteEditParams { account_id, comment, hostname, tunnel_id } params, RequestOptionsoptions?): HostnameRoute { id, comment, created_at, 4 more }

PATCH/accounts/{account_id}/zerotrust/routes/hostname/{hostname_route_id}

Delete hostname route

client.zeroTrust.networks.hostnameRoutes.delete(stringhostnameRouteId, HostnameRouteDeleteParams { account_id } params, RequestOptionsoptions?): HostnameRoute { id, comment, created_at, 4 more }

DELETE/accounts/{account_id}/zerotrust/routes/hostname/{hostname_route_id}

ModelsExpand Collapse

HostnameRoute { id, comment, created_at, 4 more }

id?: string

The hostname route ID.

formatuuid

comment?: string

An optional description of the hostname route.

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

hostname?: string

The hostname of the route.

tunnel_id?: string

UUID of the tunnel.

formatuuid

maxLength36

tunnel_name?: string

A user-friendly name for a tunnel.