Cloudflare.ZeroTrustSubnet (Cloudflare v0.5.0)

Copy Markdown View Source

Zero Trust Subnets

List Subnets

GET /accounts/{account_id}/zerotrust/subnets

Lists and filters subnets in an account.

Responses

200 List subnets response

Data is at body["result"]

[
  {
    "comment": "*string*",
    "created_at": "*string*",
    "deleted_at": "*string*",
    "id": "*string*",
    "is_default_network": "*boolean*",
    "name": "*string*",
    "network": "*string*",
    "subnet_type": "*string*"
  }
]
4XX List subnets response failure
{
  "errors": [
    {
      "code": "*integer*",
      "message": "*string*"
    }
  ],
  "messages": [
    {
      "code": "*integer*",
      "message": "*string*"
    }
  ],
  "result": {},
  "result_info": {
    "count": "*number*",
    "page": "*number*",
    "per_page": "*number*",
    "total_count": "*number*"
  },
  "success": "*boolean*"
}

Update Cloudflare Source Subnet

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

Updates the Cloudflare Source subnet of the given address family

Responses

200 Update subnet response

Data is at body["result"]

{
  "comment": "*string*",
  "created_at": "*string*",
  "deleted_at": "*string*",
  "id": "*string*",
  "is_default_network": "*boolean*",
  "name": "*string*",
  "network": "*string*",
  "subnet_type": "*string*"
}
4XX Update subnet response failure
{
  "errors": [
    {
      "code": "*integer*",
      "message": "*string*"
    }
  ],
  "messages": [
    {
      "code": "*integer*",
      "message": "*string*"
    }
  ],
  "result": {},
  "success": "*boolean*"
}

Create WARP IP subnet

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)

Responses

200 Create subnet response

Data is at body["result"]

{
  "comment": "*string*",
  "created_at": "*string*",
  "deleted_at": "*string*",
  "id": "*string*",
  "is_default_network": "*boolean*",
  "name": "*string*",
  "network": "*string*",
  "subnet_type": "*string*"
}
4XX Create subnet response failure
{
  "errors": [
    {
      "code": "*integer*",
      "message": "*string*"
    }
  ],
  "messages": [
    {
      "code": "*integer*",
      "message": "*string*"
    }
  ],
  "result": {},
  "success": "*boolean*"
}

Update WARP IP subnet

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

Updates a WARP IP assignment subnet.

Update constraints:

  • The network field cannot be modified for WARP subnets. Only name, comment, and is_default_network can be updated.
  • IPv6 subnets cannot be updated

Responses

200 Update subnet response

Data is at body["result"]

{
  "comment": "*string*",
  "created_at": "*string*",
  "deleted_at": "*string*",
  "id": "*string*",
  "is_default_network": "*boolean*",
  "name": "*string*",
  "network": "*string*",
  "subnet_type": "*string*"
}
4XX Update subnet response failure
{
  "errors": [
    {
      "code": "*integer*",
      "message": "*string*"
    }
  ],
  "messages": [
    {
      "code": "*integer*",
      "message": "*string*"
    }
  ],
  "result": {},
  "success": "*boolean*"
}

Get WARP IP subnet

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

Get a WARP IP assignment subnet.

Responses

200 Get subnet response

Data is at body["result"]

{
  "comment": "*string*",
  "created_at": "*string*",
  "deleted_at": "*string*",
  "id": "*string*",
  "is_default_network": "*boolean*",
  "name": "*string*",
  "network": "*string*",
  "subnet_type": "*string*"
}
4XX Get subnet response failure
{
  "errors": [
    {
      "code": "*integer*",
      "message": "*string*"
    }
  ],
  "messages": [
    {
      "code": "*integer*",
      "message": "*string*"
    }
  ],
  "result": {},
  "success": "*boolean*"
}

Delete WARP IP subnet

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

Delete a WARP IP assignment subnet. This operation is idempotent - deleting an already-deleted or non-existent subnet will return success with a null result.

Responses

200 Delete subnet response

Data is at body["result"]

{
  "comment": "*string*",
  "created_at": "*string*",
  "deleted_at": "*string*",
  "id": "*string*",
  "is_default_network": "*boolean*",
  "name": "*string*",
  "network": "*string*",
  "subnet_type": "*string*"
}
4XX Delete subnet response failure
{
  "errors": [
    {
      "code": "*integer*",
      "message": "*string*"
    }
  ],
  "messages": [
    {
      "code": "*integer*",
      "message": "*string*"
    }
  ],
  "result": {},
  "success": "*boolean*"
}

Summary

Functions

client(opts \\ [])

create_warp(body, opts \\ [])

delete_warp(subnet_id, opts \\ [])

index(opts \\ [])

path_for(id, opts \\ [])

@spec path_for(term(), [{:action, String.t()}]) :: String.t()

show_warp(subnet_id, opts \\ [])

update_cloudflare_source(address_family, body, opts \\ [])

update_warp(subnet_id, body, opts \\ [])