Skip to main content
POST
/
api
/
public
/
v1
/
networks
Create a private network
curl --request POST \
  --url https://api.vmarea.com/api/v1/api/public/v1/networks \
  --header 'Content-Type: application/json' \
  --header 'x-api-key: <api-key>' \
  --data '
{
  "name": "<string>",
  "nodeId": "<string>",
  "cidr": "<string>",
  "gateway": "<string>",
  "enableSnat": true,
  "enableDhcp": true
}
'
{
  "success": true,
  "data": {
    "id": "<string>",
    "name": "<string>",
    "cidr": "<string>",
    "gateway": "<string>",
    "enableSnat": true,
    "enableDhcp": true,
    "region": {
      "name": "<string>",
      "country": "<string>",
      "flag": "<string>"
    },
    "attachmentCount": 123,
    "createdAt": "2023-11-07T05:31:56Z",
    "updatedAt": "2023-11-07T05:31:56Z"
  }
}

Authorizations

​
x-api-key
string
header
required

Long-lived API token created at https://vmarea.com/dashboard/settings/api-keys. Tokens are scope-restricted; this spec lists the scope each endpoint requires.

Body

application/json
​
name
string
required
Required string length: 1 - 100
​
nodeId
string
required
Pattern: ^[cC][^\s-]{8,}$
​
cidr
string
required
Pattern: ^(?:(?:25[0-5]|2[0-4]\d|[01]?\d?\d)\.){3}(?:25[0-5]|2[0-4]\d|[01]?\d?\d)\/(?:[1-9]|[12]\d|3[0-2])$
​
gateway
string | null
Pattern: ^(?:(?:25[0-5]|2[0-4]\d|[01]?\d?\d)\.){3}(?:25[0-5]|2[0-4]\d|[01]?\d?\d)$
​
enableSnat
boolean
default:true
​
enableDhcp
boolean
default:true

Response

Default Response

​
success
enum<boolean>
required
Available options:
true
​
data
object
required