Networks

Create a hypervisor network

Since 7.1.0
POST/compute/hypervisors/{hypervisorId}/networks

Add a network to the hypervisor. The device bridge names must already exist there; ipBlockGroupId binds a block group to it.

Request

Authorization
Provide your bearer token in the Authorization header when making requests to protected resources.
Example: Authorization: Bearer ********************
Path Params#
hypervisorIdinteger#required

A valid hypervisor ID as shown in VirtFusion.

Example: 1
Body Paramsapplication/json#

The network to create.

object
namestring#required
Length: 3 to 30 characters
bridgestring#required

The device on the hypervisor the servers attach to: a Linux or Open vSwitch bridge, a Libvirt network name, or the physical interface for MacVTap, depending on type. Letters, digits, dot, dash and underscore only, and unique per hypervisor.

Length: 1 to 20 characters
Pattern: ^[A-Za-z0-9_.-]+$
typestring#required

The network type. Each is named as on the hypervisor page, and bridge means something different for each:

TypeMeaning
simpleBridgeBridged. A Linux bridge on the hypervisor, such as br0. VLANs can be tagged on it.
lvBridgeOVSOpen vSwitch Bridged. An Open vSwitch bridge on the hypervisor controlled by Libvirt. VLANs can be tagged on it.
lvNetworkLibvirt Network. A Libvirt network defined on the hypervisor.
lvNetworkBridgeLibvirt Routed. A Libvirt network in routed mode.
lvNatv1NAT v1. A Libvirt NAT network; servers get private addresses and port forwards.
macVTapMacVTap. The physical interface the server attaches to directly, such as eth0.
Allowed values:simpleBridgelvNetworkBridgelvNetworkmacVTaplvNatv1lvBridgeOVS
mtuinteger#nullable

MTU written into each server interface on this network. null leaves the hypervisor's default.

Range: 68 to 9000
ipBlockGroupIdinteger#nullable

IP block group to bind to the network.

Example
{
    "name": "Private",
    "bridge": "br1",
    "type": "simpleBridge",
    "mtu": 9000,
    "ipBlockGroupId": 5
}

Request Code Samples

curl --location --request POST 'https://cp.domain.com/api/v1/compute/hypervisors/1/networks' \
--header 'Authorization: Bearer <token>' \
--header 'Accept: application/json' \
--header 'Content-Type: application/json' \
--data-raw '{
    "name": "Private",
    "bridge": "br1",
    "type": "simpleBridge",
    "mtu": 9000,
    "ipBlockGroupId": 5
}'
wget --quiet --output-document=- \
  --method=POST \
  --header='Authorization: Bearer <token>' \
  --header='Accept: application/json' \
  --header='Content-Type: application/json' \
  --body-data='{
    "name": "Private",
    "bridge": "br1",
    "type": "simpleBridge",
    "mtu": 9000,
    "ipBlockGroupId": 5
}' \
  'https://cp.domain.com/api/v1/compute/hypervisors/1/networks'
http POST 'https://cp.domain.com/api/v1/compute/hypervisors/1/networks' \
  'Authorization: Bearer <token>' \
  'Accept: application/json' \
  'Content-Type: application/json' <<< '{
    "name": "Private",
    "bridge": "br1",
    "type": "simpleBridge",
    "mtu": 9000,
    "ipBlockGroupId": 5
}'
const response = await fetch("https://cp.domain.com/api/v1/compute/hypervisors/1/networks", {
    method: "POST",
    headers: {
        "Authorization": "Bearer <token>",
        "Accept": "application/json",
        "Content-Type": "application/json",
    },
    body: JSON.stringify({
        "name": "Private",
        "bridge": "br1",
        "type": "simpleBridge",
        "mtu": 9000,
        "ipBlockGroupId": 5
    }),
});

const data = await response.json();
console.log(response.status, data);
import axios from "axios";

const response = await axios({
    method: "post",
    url: "https://cp.domain.com/api/v1/compute/hypervisors/1/networks",
    headers: {
        "Authorization": "Bearer <token>",
        "Accept": "application/json",
        "Content-Type": "application/json",
    },
    data: {
        "name": "Private",
        "bridge": "br1",
        "type": "simpleBridge",
        "mtu": 9000,
        "ipBlockGroupId": 5
    },
});

console.log(response.status, response.data);
const https = require("https");

const payload = JSON.stringify({
    "name": "Private",
    "bridge": "br1",
    "type": "simpleBridge",
    "mtu": 9000,
    "ipBlockGroupId": 5
});

const req = https.request({
    hostname: "cp.domain.com",
    path: "/api/v1/compute/hypervisors/1/networks",
    method: "POST",
    headers: {
        "Authorization": "Bearer <token>",
        "Accept": "application/json",
        "Content-Type": "application/json",
        "Content-Length": Buffer.byteLength(payload),
    },
}, (res) => {
    let data = "";
    res.on("data", (chunk) => (data += chunk));
    res.on("end", () => console.log(res.statusCode, JSON.parse(data)));
});

req.on("error", (err) => console.error(err));
req.write(payload);
req.end();
import requests

url = "https://cp.domain.com/api/v1/compute/hypervisors/1/networks"
headers = {
    "Authorization": "Bearer <token>",
    "Accept": "application/json",
    "Content-Type": "application/json",
}
payload = {
    "name": "Private",
    "bridge": "br1",
    "type": "simpleBridge",
    "mtu": 9000,
    "ipBlockGroupId": 5,
}

response = requests.request("POST", url, headers=headers, json=payload)

print(response.status_code)
print(response.json())
import http.client
import json

conn = http.client.HTTPSConnection("cp.domain.com")
headers = {
    "Authorization": "Bearer <token>",
    "Accept": "application/json",
    "Content-Type": "application/json",
}
payload = json.dumps({
    "name": "Private",
    "bridge": "br1",
    "type": "simpleBridge",
    "mtu": 9000,
    "ipBlockGroupId": 5,
})

conn.request("POST", "/api/v1/compute/hypervisors/1/networks", payload, headers)
response = conn.getresponse()

print(response.status)
print(json.loads(response.read()))
<?php

$curl = curl_init();

curl_setopt_array($curl, array(
    CURLOPT_URL => 'https://cp.domain.com/api/v1/compute/hypervisors/1/networks',
    CURLOPT_RETURNTRANSFER => true,
    CURLOPT_ENCODING => '',
    CURLOPT_MAXREDIRS => 10,
    CURLOPT_TIMEOUT => 0,
    CURLOPT_FOLLOWLOCATION => true,
    CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
    CURLOPT_CUSTOMREQUEST => 'POST',
    CURLOPT_POSTFIELDS => json_encode([
        'name' => 'Private',
        'bridge' => 'br1',
        'type' => 'simpleBridge',
        'mtu' => 9000,
        'ipBlockGroupId' => 5,
    ]),
    CURLOPT_HTTPHEADER => array(
        'Authorization: Bearer <token>',
        'Accept: application/json',
        'Content-Type: application/json'
    ),
));

$response = curl_exec($curl);
curl_close($curl);

echo $response;
<?php

require 'vendor/autoload.php';

use GuzzleHttp\Client;

$client = new Client();

$response = $client->request('POST', 'https://cp.domain.com/api/v1/compute/hypervisors/1/networks', [
    'headers' => [
        'Authorization' => 'Bearer <token>',
        'Accept' => 'application/json',
    ],
    'json' => [
        'name' => 'Private',
        'bridge' => 'br1',
        'type' => 'simpleBridge',
        'mtu' => 9000,
        'ipBlockGroupId' => 5,
    ],
]);

echo $response->getStatusCode() . "\n";
echo $response->getBody();
package main

import (
    "fmt"
    "io"
    "net/http"
    "strings"
)

func main() {
    url := "https://cp.domain.com/api/v1/compute/hypervisors/1/networks"
    payload := strings.NewReader(`{
    "name": "Private",
    "bridge": "br1",
    "type": "simpleBridge",
    "mtu": 9000,
    "ipBlockGroupId": 5
}`)
    req, _ := http.NewRequest("POST", url, payload)
    req.Header.Add("Authorization", "Bearer <token>")
    req.Header.Add("Accept", "application/json")
    req.Header.Add("Content-Type", "application/json")

    res, err := http.DefaultClient.Do(req)
    if err != nil {
        panic(err)
    }
    defer res.Body.Close()

    body, _ := io.ReadAll(res.Body)
    fmt.Println(res.StatusCode, string(body))
}
import java.net.URI;
import java.net.http.HttpClient;
import java.net.http.HttpRequest;
import java.net.http.HttpResponse;

public class Main {
    public static void main(String[] args) throws Exception {
        HttpClient client = HttpClient.newHttpClient();

        HttpRequest request = HttpRequest.newBuilder()
            .uri(URI.create("https://cp.domain.com/api/v1/compute/hypervisors/1/networks"))
            .header("Authorization", "Bearer <token>")
            .header("Accept", "application/json")
            .header("Content-Type", "application/json")
            .method("POST", HttpRequest.BodyPublishers.ofString("{\"name\":\"Private\",\"bridge\":\"br1\",\"type\":\"simpleBridge\",\"mtu\":9000,\"ipBlockGroupId\":5}"))
            .build();

        HttpResponse<String> response = client.send(request, HttpResponse.BodyHandlers.ofString());
        System.out.println(response.statusCode());
        System.out.println(response.body());
    }
}
import okhttp3.*;

public class Main {
    public static void main(String[] args) throws Exception {
        OkHttpClient client = new OkHttpClient();

        MediaType json = MediaType.get("application/json");
        RequestBody body = RequestBody.create("{\"name\":\"Private\",\"bridge\":\"br1\",\"type\":\"simpleBridge\",\"mtu\":9000,\"ipBlockGroupId\":5}", json);

        Request request = new Request.Builder()
            .url("https://cp.domain.com/api/v1/compute/hypervisors/1/networks")
            .method("POST", body)
            .addHeader("Authorization", "Bearer <token>")
            .addHeader("Accept", "application/json")
            .build();

        try (Response response = client.newCall(request).execute()) {
            System.out.println(response.code());
            System.out.println(response.body().string());
        }
    }
}
using System.Net.Http;
using System.Net.Http.Headers;
using System.Text;

var client = new HttpClient();
var request = new HttpRequestMessage(new HttpMethod("POST"), "https://cp.domain.com/api/v1/compute/hypervisors/1/networks");
request.Headers.Authorization = new AuthenticationHeaderValue("Bearer", "<token>");
request.Headers.Accept.Add(new MediaTypeWithQualityHeaderValue("application/json"));
request.Content = new StringContent("{\"name\":\"Private\",\"bridge\":\"br1\",\"type\":\"simpleBridge\",\"mtu\":9000,\"ipBlockGroupId\":5}", Encoding.UTF8, "application/json");

var response = await client.SendAsync(request);
Console.WriteLine((int)response.StatusCode);
Console.WriteLine(await response.Content.ReadAsStringAsync());
require "net/http"
require "json"

uri = URI("https://cp.domain.com/api/v1/compute/hypervisors/1/networks")
request = Net::HTTP::Post.new(uri)
request["Authorization"] = "Bearer <token>"
request["Accept"] = "application/json"
request["Content-Type"] = "application/json"
request.body = "{\"name\":\"Private\",\"bridge\":\"br1\",\"type\":\"simpleBridge\",\"mtu\":9000,\"ipBlockGroupId\":5}"

response = Net::HTTP.start(uri.host, uri.port, use_ssl: true) do |http|
  http.request(request)
end

puts response.code
puts JSON.pretty_generate(JSON.parse(response.body))
import Foundation

var request = URLRequest(url: URL(string: "https://cp.domain.com/api/v1/compute/hypervisors/1/networks")!)
request.httpMethod = "POST"
request.setValue("Bearer <token>", forHTTPHeaderField: "Authorization")
request.setValue("application/json", forHTTPHeaderField: "Accept")
request.setValue("application/json", forHTTPHeaderField: "Content-Type")
request.httpBody = "{\"name\":\"Private\",\"bridge\":\"br1\",\"type\":\"simpleBridge\",\"mtu\":9000,\"ipBlockGroupId\":5}".data(using: .utf8)

let task = URLSession.shared.dataTask(with: request) { data, response, error in
    guard let data = data, error == nil else { print(error ?? "request failed"); return }
    print((response as! HTTPURLResponse).statusCode)
    print(String(data: data, encoding: .utf8) ?? "")
}
task.resume()
// Cargo.toml: reqwest = { version = "0.12", features = ["blocking", "json"] }, serde_json = "1"
use reqwest::blocking::Client;

fn main() -> Result<(), Box<dyn std::error::Error>> {
    let client = Client::new();
    let response = client
        .request(reqwest::Method::POST, "https://cp.domain.com/api/v1/compute/hypervisors/1/networks")
        .bearer_auth("<token>")
        .header("Accept", "application/json")
        .header("Content-Type", "application/json")
        .body(r#"{
    "name": "Private",
    "bridge": "br1",
    "type": "simpleBridge",
    "mtu": 9000,
    "ipBlockGroupId": 5
}"#)
        .send()?;

    println!("{}", response.status());
    let json: serde_json::Value = response.json()?;
    println!("{}", serde_json::to_string_pretty(&json)?);
    Ok(())
}
// Cargo.toml: reqwest = { version = "0.12", features = ["json"] }, tokio = { version = "1", features = ["full"] }, serde_json = "1"
use reqwest::Client;

#[tokio::main]
async fn main() -> Result<(), Box<dyn std::error::Error>> {
    let client = Client::new();
    let response = client
        .request(reqwest::Method::POST, "https://cp.domain.com/api/v1/compute/hypervisors/1/networks")
        .bearer_auth("<token>")
        .header("Accept", "application/json")
        .header("Content-Type", "application/json")
        .body(r#"{
    "name": "Private",
    "bridge": "br1",
    "type": "simpleBridge",
    "mtu": 9000,
    "ipBlockGroupId": 5
}"#)
        .send()
        .await?;

    println!("{}", response.status());
    let json: serde_json::Value = response.json().await?;
    println!("{}", serde_json::to_string_pretty(&json)?);
    Ok(())
}
import okhttp3.MediaType.Companion.toMediaType
import okhttp3.OkHttpClient
import okhttp3.Request
import okhttp3.RequestBody.Companion.toRequestBody

fun main() {
    val client = OkHttpClient()
    val body = """{
    "name": "Private",
    "bridge": "br1",
    "type": "simpleBridge",
    "mtu": 9000,
    "ipBlockGroupId": 5
}""".toRequestBody("application/json".toMediaType())
    val request = Request.Builder()
        .url("https://cp.domain.com/api/v1/compute/hypervisors/1/networks")
        .method("POST", body)
        .addHeader("Authorization", "Bearer <token>")
        .addHeader("Accept", "application/json")
        .build()

    client.newCall(request).execute().use { response ->
        println(response.code)
        println(response.body?.string())
    }
}
// pubspec.yaml: http: ^1.2.0
import 'dart:convert';
import 'package:http/http.dart' as http;

Future<void> main() async {
  final request = http.Request('POST', Uri.parse('https://cp.domain.com/api/v1/compute/hypervisors/1/networks'));
  request.headers['Authorization'] = 'Bearer <token>';
  request.headers['Accept'] = 'application/json';
  request.headers['Content-Type'] = 'application/json';
  request.body = r'''{
    "name": "Private",
    "bridge": "br1",
    "type": "simpleBridge",
    "mtu": 9000,
    "ipBlockGroupId": 5
}''';

  final response = await http.Response.fromStream(await request.send());
  print(response.statusCode);
  print(const JsonEncoder.withIndent('  ').convert(jsonDecode(response.body)));
}
#include <stdio.h>
#include <curl/curl.h>

int main(void) {
    CURL *curl = curl_easy_init();
    if (!curl) return 1;

    struct curl_slist *headers = NULL;
    headers = curl_slist_append(headers, "Authorization: Bearer <token>");
    headers = curl_slist_append(headers, "Accept: application/json");
    headers = curl_slist_append(headers, "Content-Type: application/json");

    curl_easy_setopt(curl, CURLOPT_URL, "https://cp.domain.com/api/v1/compute/hypervisors/1/networks");
    curl_easy_setopt(curl, CURLOPT_CUSTOMREQUEST, "POST");
    curl_easy_setopt(curl, CURLOPT_HTTPHEADER, headers);
    curl_easy_setopt(curl, CURLOPT_POSTFIELDS, "{\"name\":\"Private\",\"bridge\":\"br1\",\"type\":\"simpleBridge\",\"mtu\":9000,\"ipBlockGroupId\":5}");

    CURLcode result = curl_easy_perform(curl);
    if (result != CURLE_OK) fprintf(stderr, "%s\n", curl_easy_strerror(result));

    curl_slist_free_all(headers);
    curl_easy_cleanup(curl);
    return result == CURLE_OK ? 0 : 1;
}
$headers = @{
    Authorization = "Bearer <token>"
    Accept        = "application/json"
}

$body = @'
{
    "name": "Private",
    "bridge": "br1",
    "type": "simpleBridge",
    "mtu": 9000,
    "ipBlockGroupId": 5
}
'@

$response = Invoke-RestMethod -Uri "https://cp.domain.com/api/v1/compute/hypervisors/1/networks" -Method POST -Headers $headers -ContentType "application/json" -Body $body
$response | ConvertTo-Json -Depth 10
POST /api/v1/compute/hypervisors/1/networks HTTP/1.1
Host: cp.domain.com
Authorization: Bearer <token>
Accept: application/json
Content-Type: application/json
Content-Length: 116

{
    "name": "Private",
    "bridge": "br1",
    "type": "simpleBridge",
    "mtu": 9000,
    "ipBlockGroupId": 5
}

Responses

201

Created.

#
application/json
object

A network (bridge) on a hypervisor, with the IP block group bound to it and the IP blocks bound directly to it there.

HypervisorNetwork fields
idinteger#
hypervisorIdinteger#
namestring#

The primary network reads as Primary when it has no name of its own.

bridgestring#

The device on the hypervisor the servers attach to: a Linux or Open vSwitch bridge, a Libvirt network name, or the physical interface for MacVTap, depending on type. No spaces, unique per hypervisor.

typestring#

The network type. Each is named as on the hypervisor page, and bridge means something different for each:

TypeMeaning
simpleBridgeBridged. A Linux bridge on the hypervisor, such as br0. VLANs can be tagged on it.
lvBridgeOVSOpen vSwitch Bridged. An Open vSwitch bridge on the hypervisor controlled by Libvirt. VLANs can be tagged on it.
lvNetworkLibvirt Network. A Libvirt network defined on the hypervisor.
lvNetworkBridgeLibvirt Routed. A Libvirt network in routed mode.
lvNatv1NAT v1. A Libvirt NAT network; servers get private addresses and port forwards.
macVTapMacVTap. The physical interface the server attaches to directly, such as eth0.
Allowed values:simpleBridgelvNetworkBridgelvNetworkmacVTaplvNatv1lvBridgeOVS
mtuinteger#nullable
primaryboolean#
defaultboolean#
enabledboolean#
ipBlockGroupobject#nullable
fields
idinteger#
namestring#
ipBlocksarray[object]#
item fields
idinteger#
namestring#
typeinteger#

4 for IPv4, 6 for IPv6.

createdstring <date-time>#
updatedstring <date-time>#
Example
{
    "data": {
        "id": 2,
        "hypervisorId": 1,
        "name": "Private",
        "bridge": "br1",
        "type": "simpleBridge",
        "mtu": 9000,
        "primary": false,
        "default": false,
        "enabled": true,
        "ipBlockGroup": {
            "id": 5,
            "name": "LAN"
        },
        "ipBlocks": [
            {
                "id": 11,
                "name": "Private B",
                "type": 4
            }
        ],
        "created": "2026-03-02T10:14:00+00:00",
        "updated": "2026-03-02T10:14:00+00:00"
    }
}
401

The bearer token is missing, invalid, or expired. The response has no body.

#
No response body.
404

The hypervisor was not found.

#
application/json
msgstring#
Example
{
    "msg": "hypervisor not found"
}
422

Validation failed, the bridge is already used on this hypervisor, the group does not ex…

#
application/json

Validation failed, the bridge is already used on this hypervisor, the group does not exist, or an unknown field was sent.

errorsobject#
Example
{
    "errors": {
        "bridge": [
            "A network with the specified bridge name already exists."
        ]
    }
}
429

Too many requests. Either the token's requests per minute are used up (see the `X-RateL…

#
application/json

Too many requests. Either the token's requests per minute are used up (see the X-RateLimit-* headers) or the calling address has failed authentication 10 times in a minute (the body then includes retry_after_seconds). Retry-After gives the seconds to wait.

object
errorsarray[string]#
retry_after_secondsinteger#

Seconds to wait before retrying. Present on the failed-authentication limit only.

Response headers
Retry-Afterinteger

Seconds to wait before retrying.

X-RateLimit-Limitinteger

The token's requests per minute (token limit only).

X-RateLimit-Remaininginteger

Requests left in the current minute (token limit only).

X-RateLimit-Resetinteger

Unix timestamp at which the minute resets (token limit only).

Examples
{
    "errors": [
        "Too Many Requests"
    ]
}
{
    "errors": [
        "Too many authentication attempts. Try again later."
    ],
    "retry_after_seconds": 42
}