Skip to content
Start here

Subnets

List Subnets
client.zeroTrust.networks.subnets.list(SubnetListParams { account_id, address_family, comment, 9 more } params, RequestOptionsoptions?): V4PagePaginationArray<Subnet { id, capacity, comment, 6 more } >
GET/accounts/{account_id}/zerotrust/subnets

SubnetsWARP

Create WARP IP subnet
client.zeroTrust.networks.subnets.warp.create(WARPCreateParams { account_id, name, network, 2 more } params, RequestOptionsoptions?): Subnet { id, capacity, comment, 6 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, capacity, comment, 6 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, capacity, comment, 6 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, capacity, comment, 6 more } | null
DELETE/accounts/{account_id}/zerotrust/subnets/warp/{subnet_id}
ModelsExpand Collapse
Subnet { id, capacity, comment, 6 more }
id?: string

The UUID of the subnet.

formatuuid
capacity?: Capacity { total, used }

IP capacity information for the subnet.

total?: number

Total number of assignable IPs in the subnet.

used?: number

Number of assigned IPs in the subnet.

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" | "initial_resolved_ip" | "warp"

The type of subnet.

One of the following:
"cloudflare_source"
"initial_resolved_ip"
"warp"
WARPDeleteResponse { id, capacity, comment, 6 more }
id?: string

The UUID of the subnet.

formatuuid
capacity?: Capacity { total, used }

IP capacity information for the subnet.

total?: number

Total number of assignable IPs in the subnet.

used?: number

Number of assigned IPs in the subnet.

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" | "initial_resolved_ip" | "warp"

The type of subnet.

One of the following:
"cloudflare_source"
"initial_resolved_ip"
"warp"

SubnetsCloudflare Source

Update Cloudflare Source Subnet
client.zeroTrust.networks.subnets.cloudflareSource.update("v4" | "v6"addressFamily, CloudflareSourceUpdateParams { account_id, comment, name, network } params, RequestOptionsoptions?): Subnet { id, capacity, comment, 6 more }
PATCH/accounts/{account_id}/zerotrust/subnets/cloudflare_source/{address_family}

SubnetsInitial Resolved IP

Get Initial Resolved IP Subnet
client.zeroTrust.networks.subnets.initialResolvedIP.get("v4" | "v6"addressFamily, InitialResolvedIPGetParams { account_id } params, RequestOptionsoptions?): Subnet { id, capacity, comment, 6 more }
GET/accounts/{account_id}/zerotrust/subnets/initial_resolved_ip/{address_family}
Update Initial Resolved IP Subnet
client.zeroTrust.networks.subnets.initialResolvedIP.update("v4" | "v6"addressFamily, InitialResolvedIPUpdateParams { account_id, comment, name, network } params, RequestOptionsoptions?): Subnet { id, capacity, comment, 6 more }
PUT/accounts/{account_id}/zerotrust/subnets/initial_resolved_ip/{address_family}