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

zero_trust.networks.routes.list(RouteListParams**kwargs) -> SyncV4PagePaginationArray[Teamnet]

GET/accounts/{account_id}/teamnet/routes

Get tunnel route

zero_trust.networks.routes.get(strroute_id, RouteGetParams**kwargs) -> Route

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

Create a tunnel route

zero_trust.networks.routes.create(RouteCreateParams**kwargs) -> Route

POST/accounts/{account_id}/teamnet/routes

Update a tunnel route

zero_trust.networks.routes.edit(strroute_id, RouteEditParams**kwargs) -> Route

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

Delete a tunnel route

zero_trust.networks.routes.delete(strroute_id, RouteDeleteParams**kwargs) -> Route

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

ModelsExpand Collapse

class NetworkRoute: …

id: Optional[str]

UUID of the route.

maxLength36

comment: Optional[str]

Optional remark describing the route.

maxLength100

created_at: Optional[datetime]

Timestamp of when the resource was created.

formatdate-time

deleted_at: Optional[datetime]

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

formatdate-time

network: Optional[str]

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

tunnel_id: Optional[str]

UUID of the tunnel.

formatuuid

maxLength36

virtual_network_id: Optional[str]

UUID of the virtual network.

formatuuid

class Route: …

id: Optional[str]

UUID of the route.

maxLength36

comment: Optional[str]

Optional remark describing the route.

maxLength100

created_at: Optional[datetime]

Timestamp of when the resource was created.

formatdate-time

deleted_at: Optional[datetime]

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

formatdate-time

network: Optional[str]

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

tunnel_id: Optional[str]

UUID of the tunnel.

formatuuid

maxLength36

virtual_network_id: Optional[str]

UUID of the virtual network.

formatuuid

class Teamnet: …

id: Optional[str]

UUID of the route.

maxLength36

comment: Optional[str]

Optional remark describing the route.

maxLength100

created_at: Optional[datetime]

Timestamp of when the resource was created.

formatdate-time

deleted_at: Optional[datetime]

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

formatdate-time

network: Optional[str]

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

tun_type: Optional[Literal["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: Optional[str]

UUID of the tunnel.

formatuuid

maxLength36

tunnel_name: Optional[str]

A user-friendly name for a tunnel.

virtual_network_id: Optional[str]

UUID of the virtual network.

formatuuid

virtual_network_name: Optional[str]

A user-friendly name for the virtual network.

maxLength256

NetworksRoutesIPs

Get tunnel route by IP

zero_trust.networks.routes.ips.get(strip, IPGetParams**kwargs) -> Teamnet

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

NetworksRoutesNetworks

Create a tunnel route (CIDR Endpoint)

Deprecated

zero_trust.networks.routes.networks.create(strip_network_encoded, NetworkCreateParams**kwargs) -> Route

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

Update a tunnel route (CIDR Endpoint)

Deprecated

zero_trust.networks.routes.networks.edit(strip_network_encoded, NetworkEditParams**kwargs) -> Route

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

Delete a tunnel route (CIDR Endpoint)

Deprecated

zero_trust.networks.routes.networks.delete(strip_network_encoded, NetworkDeleteParams**kwargs) -> Route

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

NetworksVirtual Networks

List virtual networks

zero_trust.networks.virtual_networks.list(VirtualNetworkListParams**kwargs) -> SyncSinglePage[VirtualNetwork]

GET/accounts/{account_id}/teamnet/virtual_networks

Get a virtual network

zero_trust.networks.virtual_networks.get(strvirtual_network_id, VirtualNetworkGetParams**kwargs) -> VirtualNetwork

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

Create a virtual network

zero_trust.networks.virtual_networks.create(VirtualNetworkCreateParams**kwargs) -> VirtualNetwork

POST/accounts/{account_id}/teamnet/virtual_networks

Update a virtual network

zero_trust.networks.virtual_networks.edit(strvirtual_network_id, VirtualNetworkEditParams**kwargs) -> VirtualNetwork

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

Delete a virtual network

zero_trust.networks.virtual_networks.delete(strvirtual_network_id, VirtualNetworkDeleteParams**kwargs) -> VirtualNetwork

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

ModelsExpand Collapse

class VirtualNetwork: …

id: str

UUID of the virtual network.

formatuuid

comment: str

Optional remark describing the virtual network.

maxLength256

created_at: datetime

Timestamp of when the resource was created.

formatdate-time

is_default_network: bool

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

name: str

A user-friendly name for the virtual network.

maxLength256

deleted_at: Optional[datetime]

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

formatdate-time

NetworksSubnets

List Subnets

zero_trust.networks.subnets.list(SubnetListParams**kwargs) -> SyncV4PagePaginationArray[Subnet]

GET/accounts/{account_id}/zerotrust/subnets

NetworksSubnetsWARP

Create WARP IP subnet

zero_trust.networks.subnets.warp.create(WARPCreateParams**kwargs) -> Subnet

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

Get WARP IP subnet

zero_trust.networks.subnets.warp.get(strsubnet_id, WARPGetParams**kwargs) -> Subnet

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

Update WARP IP subnet

zero_trust.networks.subnets.warp.edit(strsubnet_id, WARPEditParams**kwargs) -> Subnet

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

Delete WARP IP subnet

zero_trust.networks.subnets.warp.delete(strsubnet_id, WARPDeleteParams**kwargs) -> WARPDeleteResponse

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

ModelsExpand Collapse

class Subnet: …

id: Optional[str]

The UUID of the subnet.

formatuuid

comment: Optional[str]

An optional description of the subnet.

created_at: Optional[datetime]

Timestamp of when the resource was created.

formatdate-time

deleted_at: Optional[datetime]

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

formatdate-time

is_default_network: Optional[bool]

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

name: Optional[str]

A user-friendly name for the subnet.

network: Optional[str]

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

subnet_type: Optional[Literal["cloudflare_source", "warp"]]

The type of subnet.

One of the following:

"cloudflare_source"

"warp"

class WARPDeleteResponse: …

id: Optional[str]

The UUID of the subnet.

formatuuid

comment: Optional[str]

An optional description of the subnet.

created_at: Optional[datetime]

Timestamp of when the resource was created.

formatdate-time

deleted_at: Optional[datetime]

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

formatdate-time

is_default_network: Optional[bool]

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

name: Optional[str]

A user-friendly name for the subnet.

network: Optional[str]

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

subnet_type: Optional[Literal["cloudflare_source", "warp"]]

The type of subnet.

One of the following:

"cloudflare_source"

"warp"

NetworksSubnetsCloudflare Source

Update Cloudflare Source Subnet

zero_trust.networks.subnets.cloudflare_source.update(Literal["v4", "v6"]address_family, CloudflareSourceUpdateParams**kwargs) -> Subnet

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

NetworksHostname Routes

List hostname routes

zero_trust.networks.hostname_routes.list(HostnameRouteListParams**kwargs) -> SyncV4PagePaginationArray[HostnameRoute]

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

Get hostname route

zero_trust.networks.hostname_routes.get(strhostname_route_id, HostnameRouteGetParams**kwargs) -> HostnameRoute

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

Create hostname route

zero_trust.networks.hostname_routes.create(HostnameRouteCreateParams**kwargs) -> HostnameRoute

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

Update hostname route

zero_trust.networks.hostname_routes.edit(strhostname_route_id, HostnameRouteEditParams**kwargs) -> HostnameRoute

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

Delete hostname route

zero_trust.networks.hostname_routes.delete(strhostname_route_id, HostnameRouteDeleteParams**kwargs) -> HostnameRoute

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

ModelsExpand Collapse

class HostnameRoute: …

id: Optional[str]

The hostname route ID.

formatuuid

comment: Optional[str]

An optional description of the hostname route.

created_at: Optional[datetime]

Timestamp of when the resource was created.

formatdate-time

deleted_at: Optional[datetime]

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

formatdate-time

hostname: Optional[str]

The hostname of the route.

tunnel_id: Optional[str]

UUID of the tunnel.

formatuuid

maxLength36

tunnel_name: Optional[str]

A user-friendly name for a tunnel.