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(ctx, params) (*V4PagePaginationArray[Teamnet], error)

GET/accounts/{account_id}/teamnet/routes

Get tunnel route

client.ZeroTrust.Networks.Routes.Get(ctx, routeID, query) (*Route, error)

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

Create a tunnel route

client.ZeroTrust.Networks.Routes.New(ctx, params) (*Route, error)

POST/accounts/{account_id}/teamnet/routes

Update a tunnel route

client.ZeroTrust.Networks.Routes.Edit(ctx, routeID, params) (*Route, error)

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

Delete a tunnel route

client.ZeroTrust.Networks.Routes.Delete(ctx, routeID, body) (*Route, error)

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

ModelsExpand Collapse

type NetworkRoute struct{…}

ID stringoptional

UUID of the route.

maxLength36

Comment stringoptional

Optional remark describing the route.

maxLength100

CreatedAt Timeoptional

Timestamp of when the resource was created.

formatdate-time

DeletedAt Timeoptional

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

formatdate-time

Network stringoptional

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

TunnelID stringoptional

UUID of the tunnel.

formatuuid

maxLength36

VirtualNetworkID stringoptional

UUID of the virtual network.

formatuuid

type Route struct{…}

ID stringoptional

UUID of the route.

maxLength36

Comment stringoptional

Optional remark describing the route.

maxLength100

CreatedAt Timeoptional

Timestamp of when the resource was created.

formatdate-time

DeletedAt Timeoptional

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

formatdate-time

Network stringoptional

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

TunnelID stringoptional

UUID of the tunnel.

formatuuid

maxLength36

VirtualNetworkID stringoptional

UUID of the virtual network.

formatuuid

type Teamnet struct{…}

ID stringoptional

UUID of the route.

maxLength36

Comment stringoptional

Optional remark describing the route.

maxLength100

CreatedAt Timeoptional

Timestamp of when the resource was created.

formatdate-time

DeletedAt Timeoptional

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

formatdate-time

Network stringoptional

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

TunType TeamnetTunTypeoptional

The type of tunnel.

One of the following:

const TeamnetTunTypeCfdTunnel TeamnetTunType = "cfd_tunnel"

const TeamnetTunTypeWARPConnector TeamnetTunType = "warp_connector"

const TeamnetTunTypeWARP TeamnetTunType = "warp"

const TeamnetTunTypeMagic TeamnetTunType = "magic"

const TeamnetTunTypeIPSec TeamnetTunType = "ip_sec"

const TeamnetTunTypeGRE TeamnetTunType = "gre"

const TeamnetTunTypeCNI TeamnetTunType = "cni"

TunnelID stringoptional

UUID of the tunnel.

formatuuid

maxLength36

TunnelName stringoptional

A user-friendly name for a tunnel.

VirtualNetworkID stringoptional

UUID of the virtual network.

formatuuid

VirtualNetworkName stringoptional

A user-friendly name for the virtual network.

maxLength256

NetworksRoutesIPs

Get tunnel route by IP

client.ZeroTrust.Networks.Routes.IPs.Get(ctx, ip, params) (*Teamnet, error)

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

NetworksRoutesNetworks

Create a tunnel route (CIDR Endpoint)

Deprecated

client.ZeroTrust.Networks.Routes.Networks.New(ctx, ipNetworkEncoded, params) (*Route, error)

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

Update a tunnel route (CIDR Endpoint)

Deprecated

client.ZeroTrust.Networks.Routes.Networks.Edit(ctx, ipNetworkEncoded, body) (*Route, error)

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

Delete a tunnel route (CIDR Endpoint)

Deprecated

client.ZeroTrust.Networks.Routes.Networks.Delete(ctx, ipNetworkEncoded, params) (*Route, error)

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

NetworksVirtual Networks

List virtual networks

client.ZeroTrust.Networks.VirtualNetworks.List(ctx, params) (*SinglePage[VirtualNetwork], error)

GET/accounts/{account_id}/teamnet/virtual_networks

Get a virtual network

client.ZeroTrust.Networks.VirtualNetworks.Get(ctx, virtualNetworkID, query) (*VirtualNetwork, error)

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

Create a virtual network

client.ZeroTrust.Networks.VirtualNetworks.New(ctx, params) (*VirtualNetwork, error)

POST/accounts/{account_id}/teamnet/virtual_networks

Update a virtual network

client.ZeroTrust.Networks.VirtualNetworks.Edit(ctx, virtualNetworkID, params) (*VirtualNetwork, error)

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

Delete a virtual network

client.ZeroTrust.Networks.VirtualNetworks.Delete(ctx, virtualNetworkID, body) (*VirtualNetwork, error)

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

ModelsExpand Collapse

type VirtualNetwork struct{…}

ID string

UUID of the virtual network.

formatuuid

Comment string

Optional remark describing the virtual network.

maxLength256

CreatedAt Time

Timestamp of when the resource was created.

formatdate-time

IsDefaultNetwork bool

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

Name string

A user-friendly name for the virtual network.

maxLength256

DeletedAt Timeoptional

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(ctx, params) (*V4PagePaginationArray[Subnet], error)

GET/accounts/{account_id}/zerotrust/subnets

NetworksSubnetsWARP

Create WARP IP subnet

client.ZeroTrust.Networks.Subnets.WARP.New(ctx, params) (*Subnet, error)

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

Get WARP IP subnet

client.ZeroTrust.Networks.Subnets.WARP.Get(ctx, subnetID, query) (*Subnet, error)

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

Update WARP IP subnet

client.ZeroTrust.Networks.Subnets.WARP.Edit(ctx, subnetID, params) (*Subnet, error)

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

Delete WARP IP subnet

client.ZeroTrust.Networks.Subnets.WARP.Delete(ctx, subnetID, body) (*NetworkSubnetWARPDeleteResponse, error)

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

ModelsExpand Collapse

type Subnet struct{…}

ID stringoptional

The UUID of the subnet.

formatuuid

Comment stringoptional

An optional description of the subnet.

CreatedAt Timeoptional

Timestamp of when the resource was created.

formatdate-time

DeletedAt Timeoptional

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

formatdate-time

IsDefaultNetwork booloptional

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

Name stringoptional

A user-friendly name for the subnet.

Network stringoptional

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

SubnetType SubnetSubnetTypeoptional

The type of subnet.

One of the following:

const SubnetSubnetTypeCloudflareSource SubnetSubnetType = "cloudflare_source"

const SubnetSubnetTypeWARP SubnetSubnetType = "warp"

NetworksSubnetsCloudflare Source

Update Cloudflare Source Subnet

client.ZeroTrust.Networks.Subnets.CloudflareSource.Update(ctx, addressFamily, params) (*Subnet, error)

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

NetworksHostname Routes

List hostname routes

client.ZeroTrust.Networks.HostnameRoutes.List(ctx, params) (*V4PagePaginationArray[HostnameRoute], error)

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

Get hostname route

client.ZeroTrust.Networks.HostnameRoutes.Get(ctx, hostnameRouteID, query) (*HostnameRoute, error)

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

Create hostname route

client.ZeroTrust.Networks.HostnameRoutes.New(ctx, params) (*HostnameRoute, error)

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

Update hostname route

client.ZeroTrust.Networks.HostnameRoutes.Edit(ctx, hostnameRouteID, params) (*HostnameRoute, error)

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

Delete hostname route

client.ZeroTrust.Networks.HostnameRoutes.Delete(ctx, hostnameRouteID, body) (*HostnameRoute, error)

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

ModelsExpand Collapse

type HostnameRoute struct{…}

ID stringoptional

The hostname route ID.

formatuuid

Comment stringoptional

An optional description of the hostname route.

CreatedAt Timeoptional

Timestamp of when the resource was created.

formatdate-time

DeletedAt Timeoptional

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

formatdate-time

Hostname stringoptional

The hostname of the route.

TunnelID stringoptional

UUID of the tunnel.

formatuuid

maxLength36

TunnelName stringoptional

A user-friendly name for a tunnel.