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
}
'import requests
url = "https://api.vmarea.com/api/v1/api/public/v1/networks"
payload = {
"name": "<string>",
"nodeId": "<string>",
"cidr": "<string>",
"gateway": "<string>",
"enableSnat": True,
"enableDhcp": True
}
headers = {
"x-api-key": "<api-key>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {'x-api-key': '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({
name: '<string>',
nodeId: '<string>',
cidr: '<string>',
gateway: '<string>',
enableSnat: true,
enableDhcp: true
})
};
fetch('https://api.vmarea.com/api/v1/api/public/v1/networks', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api.vmarea.com/api/v1/api/public/v1/networks",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'name' => '<string>',
'nodeId' => '<string>',
'cidr' => '<string>',
'gateway' => '<string>',
'enableSnat' => true,
'enableDhcp' => true
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json",
"x-api-key: <api-key>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://api.vmarea.com/api/v1/api/public/v1/networks"
payload := strings.NewReader("{\n \"name\": \"<string>\",\n \"nodeId\": \"<string>\",\n \"cidr\": \"<string>\",\n \"gateway\": \"<string>\",\n \"enableSnat\": true,\n \"enableDhcp\": true\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("x-api-key", "<api-key>")
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.post("https://api.vmarea.com/api/v1/api/public/v1/networks")
.header("x-api-key", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"name\": \"<string>\",\n \"nodeId\": \"<string>\",\n \"cidr\": \"<string>\",\n \"gateway\": \"<string>\",\n \"enableSnat\": true,\n \"enableDhcp\": true\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.vmarea.com/api/v1/api/public/v1/networks")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["x-api-key"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"name\": \"<string>\",\n \"nodeId\": \"<string>\",\n \"cidr\": \"<string>\",\n \"gateway\": \"<string>\",\n \"enableSnat\": true,\n \"enableDhcp\": true\n}"
response = http.request(request)
puts response.read_body{
"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"
}
}{
"success": false,
"error": "<string>"
}{
"success": false,
"error": "<string>"
}{
"success": false,
"error": "<string>"
}{
"success": false,
"error": "<string>"
}{
"success": false,
"error": "<string>"
}Networks
Create a private network
Provisions a new SDN zone + VNet on the chosen Proxmox node. Rolls back the DB row if the upstream provisioning call fails.
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
}
'import requests
url = "https://api.vmarea.com/api/v1/api/public/v1/networks"
payload = {
"name": "<string>",
"nodeId": "<string>",
"cidr": "<string>",
"gateway": "<string>",
"enableSnat": True,
"enableDhcp": True
}
headers = {
"x-api-key": "<api-key>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {'x-api-key': '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({
name: '<string>',
nodeId: '<string>',
cidr: '<string>',
gateway: '<string>',
enableSnat: true,
enableDhcp: true
})
};
fetch('https://api.vmarea.com/api/v1/api/public/v1/networks', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api.vmarea.com/api/v1/api/public/v1/networks",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'name' => '<string>',
'nodeId' => '<string>',
'cidr' => '<string>',
'gateway' => '<string>',
'enableSnat' => true,
'enableDhcp' => true
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json",
"x-api-key: <api-key>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://api.vmarea.com/api/v1/api/public/v1/networks"
payload := strings.NewReader("{\n \"name\": \"<string>\",\n \"nodeId\": \"<string>\",\n \"cidr\": \"<string>\",\n \"gateway\": \"<string>\",\n \"enableSnat\": true,\n \"enableDhcp\": true\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("x-api-key", "<api-key>")
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.post("https://api.vmarea.com/api/v1/api/public/v1/networks")
.header("x-api-key", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"name\": \"<string>\",\n \"nodeId\": \"<string>\",\n \"cidr\": \"<string>\",\n \"gateway\": \"<string>\",\n \"enableSnat\": true,\n \"enableDhcp\": true\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.vmarea.com/api/v1/api/public/v1/networks")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["x-api-key"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"name\": \"<string>\",\n \"nodeId\": \"<string>\",\n \"cidr\": \"<string>\",\n \"gateway\": \"<string>\",\n \"enableSnat\": true,\n \"enableDhcp\": true\n}"
response = http.request(request)
puts response.read_body{
"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"
}
}{
"success": false,
"error": "<string>"
}{
"success": false,
"error": "<string>"
}{
"success": false,
"error": "<string>"
}{
"success": false,
"error": "<string>"
}{
"success": false,
"error": "<string>"
}Authorizations
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
Required string length:
1 - 100Pattern:
^[cC][^\s-]{8,}$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])$Pattern:
^(?:(?:25[0-5]|2[0-4]\d|[01]?\d?\d)\.){3}(?:25[0-5]|2[0-4]\d|[01]?\d?\d)$⌘I