Create a virtual network

POST

https://api.cloudflare.com/client/v4/accounts/{account_identifier}/teamnet/virtual_networks

Last modified:2022-12-16 13:48:35

Adds a new virtual network to an account.

Request

Path Params

account_identifier

string

required

Body Params application/json

comment

string

optional

Optional remark describing the virtual network.

Example:

Staging VPC for data science

is_default

boolean

optional

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

Example:

true

name

string

required

A user-friendly name for the virtual network.

Example:

us-east-1-vpc

Example

{
    "comment": "Staging VPC for data science",
    "is_default": true,
    "name": "us-east-1-vpc"
}

Request samples

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

curl --location --request POST 'https://api.cloudflare.com/client/v4/accounts//teamnet/virtual_networks' \
--header 'Content-Type: application/json' \
--data-raw '{
    "comment": "Staging VPC for data science",
    "is_default": true,
    "name": "us-east-1-vpc"
}'

Responses

🟢200Create a virtual network response

application/json

Body

allOf {2}

optional

object (api-response-single)

optional

errors

array [object {2}]

messages

required

Example:

[]

messages

array [object {2}]

messages

required

Example:

[]

result

required

success

enum<boolean>

required

Whether the API call was successful

Allowed value:

true

Example:

true

object

optional

result

object

optional

Example

{
    "errors": [],
    "messages": [],
    "result": {},
    "success": true
}

🟢200Create a virtual network response failure

Modified at 2022-12-16 13:48:35

List virtual networks

Delete a virtual network