Skip to content
Cloudflare API
Start here
API Reference
Zero Trust
Networks
Subnets
WARP

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

Create a WARP IP assignment subnet. Currently, only IPv4 subnets can be created.

Network constraints:

  • The network must be within one of the following private IP ranges:
    • 10.0.0.0/8 (RFC 1918)
    • 172.16.0.0/12 (RFC 1918)
    • 192.168.0.0/16 (RFC 1918)
    • 100.64.0.0/10 (RFC 6598 - CGNAT)
  • The subnet must have a prefix length of /24 or larger (e.g., /16, /20, /24 are valid; /25, /28 are not)
Security
API Token

The preferred authorization scheme for interacting with the Cloudflare API. Create a token.

Example:Authorization: Bearer Sn3lZJTBX6kkg7OdcBUAxOO963GEIyGQqnFTOFYY
API Email + API Key

The previous authorization scheme for interacting with the Cloudflare API, used in conjunction with a Global API key.

Example:X-Auth-Email: user@example.com

The previous authorization scheme for interacting with the Cloudflare API. When possible, use API tokens instead of Global API keys.

Example:X-Auth-Key: 144c9defac04969c7bfad8efaa8ea194
Accepted Permissions (at least one required)
Cloudflare One Networks Write
ParametersExpand Collapse
params: WARPCreateParams { account_id, name, network, 2 more }
account_id: string

Path param: Cloudflare account ID

maxLength32
name: string

Body param: A user-friendly name for the subnet.

network: string

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

comment?: string

Body param: An optional description of the subnet.

is_default_network?: boolean

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

ReturnsExpand 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"

Create WARP IP subnet

import Cloudflare from 'cloudflare';

const client = new Cloudflare({
  apiToken: process.env['CLOUDFLARE_API_TOKEN'], // This is the default and can be omitted
});

const subnet = await client.zeroTrust.networks.subnets.warp.create({
  account_id: '699d98642c564d2e855e9661899b7252',
  name: 'IPv4 Cloudflare Source IPs',
  network: '100.64.0.0/12',
});

console.log(subnet.id);
{
  "errors": [
    {
      "code": 1000,
      "message": "message",
      "documentation_url": "documentation_url",
      "source": {
        "pointer": "pointer"
      }
    }
  ],
  "messages": [
    {
      "code": 1000,
      "message": "message",
      "documentation_url": "documentation_url",
      "source": {
        "pointer": "pointer"
      }
    }
  ],
  "result": {
    "id": "f70ff985-a4ef-4643-bbbc-4a0ed4fc8415",
    "comment": "example comment",
    "created_at": "2021-01-25T18:22:34.317854Z",
    "deleted_at": "2009-11-10T23:00:00.000000Z",
    "is_default_network": true,
    "name": "IPv4 Cloudflare Source IPs",
    "network": "100.64.0.0/12",
    "subnet_type": "cloudflare_source"
  },
  "success": true
}
Returns Examples
{
  "errors": [
    {
      "code": 1000,
      "message": "message",
      "documentation_url": "documentation_url",
      "source": {
        "pointer": "pointer"
      }
    }
  ],
  "messages": [
    {
      "code": 1000,
      "message": "message",
      "documentation_url": "documentation_url",
      "source": {
        "pointer": "pointer"
      }
    }
  ],
  "result": {
    "id": "f70ff985-a4ef-4643-bbbc-4a0ed4fc8415",
    "comment": "example comment",
    "created_at": "2021-01-25T18:22:34.317854Z",
    "deleted_at": "2009-11-10T23:00:00.000000Z",
    "is_default_network": true,
    "name": "IPv4 Cloudflare Source IPs",
    "network": "100.64.0.0/12",
    "subnet_type": "cloudflare_source"
  },
  "success": true
}