Skip to content
Start here

Virtual 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