Hypervisors

Update a hypervisor

Since 7.1.0
PUT/compute/hypervisors/{hypervisorId}

Change a hypervisor's settings. Send only the fields to change; unknown fields are rejected. Where the hypervisor is reached is not writable here. Nothing is pushed to the hypervisor.

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#

Any subset of the hypervisor's properties.

namestring#
Length: 3 to 150 characters
maintenanceboolean#
enabledboolean#
prohibitboolean#
groupIdinteger#

Must be an existing hypervisor group.

maxServersinteger#
Range: 0 to 9999
maxCpuinteger#
Range: 0 to 9999
maxMemoryinteger#

In MB.

Range: 0 to 99999999
nfTypeinteger#

The network filter (firewall) implementation for servers on the hypervisor.

ValueMeaning
0None
1Libvirt
2Native standard
3Native performance, IPv4
4Native performance, IPv4 and IPv6
5Native privacy (experimental)
Allowed values:012345
licenseTypeinteger#

The licence the hypervisor runs under, as on the hypervisor page.

ValueMeaning
1Unlimited servers
21 server
32 servers
43 servers
54 servers
65 servers
735 servers
Allowed values:1234567
diskTypestring#
Allowed values:inheritqcow2raw
diskCacheTypestring#
Allowed values:inheritnonewritethroughwritebackdirectsyncunsafe
backupStorageTypeinteger#

Which backup storage the hypervisor may use.

ValueMeaning
1None
2Directly assigned storage only
3Group assigned storage only
4Group and directly assigned storage
Allowed values:1234
cpuModelstring#nullable
Length: at most 55 characters
defaultCpustring#

inherit or a libvirt CPU model name from the Control Server's list.

defaultMachineTypestring#
Allowed values:inheritq35pc
exposeVncDetailsinteger#
Allowed values:012
trafficCountDirectioninteger#

Which direction counts towards the allowance.

ValueMeaning
0Inherit from the hypervisor, then the global setting
1Inbound and outbound
2Inbound only
3Outbound only
Allowed values:0123
trafficLimitActioninteger#nullable

What happens when the allowance is reached.

ValueMeaning
1Nothing
2Throttle the network
nullInherit
Allowed values:12null
trafficLimitThrottleIninteger#nullable
Range: at least 0
trafficLimitThrottleOutinteger#nullable
Range: at least 0
trafficLimitNotification1integer#nullable
Allowed values:050607080null
trafficLimitNotification2integer#nullable
Allowed values:0859095null
forceIpv6boolean#
vncListenTypeinteger#
Allowed values:12
timezonestring#
displayNamestring#nullable
Length: 3 to 150 characters
cpuSetstring#nullable

libvirt cpuset syntax, e.g. 0-7,^3; null clears.

Length: at most 1300 characters
diskDriverIointeger#

Default disk driver IO mode for servers on the hypervisor.

ValueMeaning
0Inherit
1threads
2native
3io_uring
4Libvirt default
Allowed values:01234
configobject#

Any subset of the hyperv and cpuflags keys shown in HypervisorSettings. Flags accept true/false; spinlocksValue an integer of at least 4095; vendorIdValue 1 to 12 characters of letters, digits, space, dot, dash or underscore.

fields
hypervobject#
cpuflagsobject#
Examples
{
    "maintenance": true,
    "prohibit": true
}
{
    "maxServers": 50,
    "maxMemory": 262144,
    "diskType": "raw",
    "defaultCpu": "host-passthrough",
    "trafficLimitAction": 2,
    "trafficLimitThrottleIn": 100000
}
{
    "config": {
        "hyperv": {
            "relaxed": true,
            "vapic": true,
            "spinlocks": true,
            "spinlocksValue": 8191
        }
    }
}

Request Code Samples

Showing the Take a hypervisor out of scheduling before draining it example from Body Params.
curl --location --request PUT 'https://cp.domain.com/api/v1/compute/hypervisors/1' \
--header 'Authorization: Bearer <token>' \
--header 'Accept: application/json' \
--header 'Content-Type: application/json' \
--data-raw '{
    "maintenance": true,
    "prohibit": true
}'
wget --quiet --output-document=- \
  --method=PUT \
  --header='Authorization: Bearer <token>' \
  --header='Accept: application/json' \
  --header='Content-Type: application/json' \
  --body-data='{
    "maintenance": true,
    "prohibit": true
}' \
  'https://cp.domain.com/api/v1/compute/hypervisors/1'
http PUT 'https://cp.domain.com/api/v1/compute/hypervisors/1' \
  'Authorization: Bearer <token>' \
  'Accept: application/json' \
  'Content-Type: application/json' <<< '{
    "maintenance": true,
    "prohibit": true
}'
const response = await fetch("https://cp.domain.com/api/v1/compute/hypervisors/1", {
    method: "PUT",
    headers: {
        "Authorization": "Bearer <token>",
        "Accept": "application/json",
        "Content-Type": "application/json",
    },
    body: JSON.stringify({
        "maintenance": true,
        "prohibit": true
    }),
});

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

const response = await axios({
    method: "put",
    url: "https://cp.domain.com/api/v1/compute/hypervisors/1",
    headers: {
        "Authorization": "Bearer <token>",
        "Accept": "application/json",
        "Content-Type": "application/json",
    },
    data: {
        "maintenance": true,
        "prohibit": true
    },
});

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

const payload = JSON.stringify({
    "maintenance": true,
    "prohibit": true
});

const req = https.request({
    hostname: "cp.domain.com",
    path: "/api/v1/compute/hypervisors/1",
    method: "PUT",
    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"
headers = {
    "Authorization": "Bearer <token>",
    "Accept": "application/json",
    "Content-Type": "application/json",
}
payload = {
    "maintenance": True,
    "prohibit": True,
}

response = requests.request("PUT", 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({
    "maintenance": True,
    "prohibit": True,
})

conn.request("PUT", "/api/v1/compute/hypervisors/1", 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',
    CURLOPT_RETURNTRANSFER => true,
    CURLOPT_ENCODING => '',
    CURLOPT_MAXREDIRS => 10,
    CURLOPT_TIMEOUT => 0,
    CURLOPT_FOLLOWLOCATION => true,
    CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
    CURLOPT_CUSTOMREQUEST => 'PUT',
    CURLOPT_POSTFIELDS => json_encode([
        'maintenance' => true,
        'prohibit' => true,
    ]),
    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('PUT', 'https://cp.domain.com/api/v1/compute/hypervisors/1', [
    'headers' => [
        'Authorization' => 'Bearer <token>',
        'Accept' => 'application/json',
    ],
    'json' => [
        'maintenance' => true,
        'prohibit' => true,
    ],
]);

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"
    payload := strings.NewReader(`{
    "maintenance": true,
    "prohibit": true
}`)
    req, _ := http.NewRequest("PUT", 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"))
            .header("Authorization", "Bearer <token>")
            .header("Accept", "application/json")
            .header("Content-Type", "application/json")
            .method("PUT", HttpRequest.BodyPublishers.ofString("{\"maintenance\":true,\"prohibit\":true}"))
            .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("{\"maintenance\":true,\"prohibit\":true}", json);

        Request request = new Request.Builder()
            .url("https://cp.domain.com/api/v1/compute/hypervisors/1")
            .method("PUT", 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("PUT"), "https://cp.domain.com/api/v1/compute/hypervisors/1");
request.Headers.Authorization = new AuthenticationHeaderValue("Bearer", "<token>");
request.Headers.Accept.Add(new MediaTypeWithQualityHeaderValue("application/json"));
request.Content = new StringContent("{\"maintenance\":true,\"prohibit\":true}", 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")
request = Net::HTTP::Put.new(uri)
request["Authorization"] = "Bearer <token>"
request["Accept"] = "application/json"
request["Content-Type"] = "application/json"
request.body = "{\"maintenance\":true,\"prohibit\":true}"

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")!)
request.httpMethod = "PUT"
request.setValue("Bearer <token>", forHTTPHeaderField: "Authorization")
request.setValue("application/json", forHTTPHeaderField: "Accept")
request.setValue("application/json", forHTTPHeaderField: "Content-Type")
request.httpBody = "{\"maintenance\":true,\"prohibit\":true}".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::PUT, "https://cp.domain.com/api/v1/compute/hypervisors/1")
        .bearer_auth("<token>")
        .header("Accept", "application/json")
        .header("Content-Type", "application/json")
        .body(r#"{
    "maintenance": true,
    "prohibit": true
}"#)
        .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::PUT, "https://cp.domain.com/api/v1/compute/hypervisors/1")
        .bearer_auth("<token>")
        .header("Accept", "application/json")
        .header("Content-Type", "application/json")
        .body(r#"{
    "maintenance": true,
    "prohibit": true
}"#)
        .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 = """{
    "maintenance": true,
    "prohibit": true
}""".toRequestBody("application/json".toMediaType())
    val request = Request.Builder()
        .url("https://cp.domain.com/api/v1/compute/hypervisors/1")
        .method("PUT", 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('PUT', Uri.parse('https://cp.domain.com/api/v1/compute/hypervisors/1'));
  request.headers['Authorization'] = 'Bearer <token>';
  request.headers['Accept'] = 'application/json';
  request.headers['Content-Type'] = 'application/json';
  request.body = r'''{
    "maintenance": true,
    "prohibit": true
}''';

  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");
    curl_easy_setopt(curl, CURLOPT_CUSTOMREQUEST, "PUT");
    curl_easy_setopt(curl, CURLOPT_HTTPHEADER, headers);
    curl_easy_setopt(curl, CURLOPT_POSTFIELDS, "{\"maintenance\":true,\"prohibit\":true}");

    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 = @'
{
    "maintenance": true,
    "prohibit": true
}
'@

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

{
    "maintenance": true,
    "prohibit": true
}
curl --location --request PUT 'https://cp.domain.com/api/v1/compute/hypervisors/1' \
--header 'Authorization: Bearer <token>' \
--header 'Accept: application/json' \
--header 'Content-Type: application/json' \
--data-raw '{
    "maxServers": 50,
    "maxMemory": 262144,
    "diskType": "raw",
    "defaultCpu": "host-passthrough",
    "trafficLimitAction": 2,
    "trafficLimitThrottleIn": 100000
}'
wget --quiet --output-document=- \
  --method=PUT \
  --header='Authorization: Bearer <token>' \
  --header='Accept: application/json' \
  --header='Content-Type: application/json' \
  --body-data='{
    "maxServers": 50,
    "maxMemory": 262144,
    "diskType": "raw",
    "defaultCpu": "host-passthrough",
    "trafficLimitAction": 2,
    "trafficLimitThrottleIn": 100000
}' \
  'https://cp.domain.com/api/v1/compute/hypervisors/1'
http PUT 'https://cp.domain.com/api/v1/compute/hypervisors/1' \
  'Authorization: Bearer <token>' \
  'Accept: application/json' \
  'Content-Type: application/json' <<< '{
    "maxServers": 50,
    "maxMemory": 262144,
    "diskType": "raw",
    "defaultCpu": "host-passthrough",
    "trafficLimitAction": 2,
    "trafficLimitThrottleIn": 100000
}'
const response = await fetch("https://cp.domain.com/api/v1/compute/hypervisors/1", {
    method: "PUT",
    headers: {
        "Authorization": "Bearer <token>",
        "Accept": "application/json",
        "Content-Type": "application/json",
    },
    body: JSON.stringify({
        "maxServers": 50,
        "maxMemory": 262144,
        "diskType": "raw",
        "defaultCpu": "host-passthrough",
        "trafficLimitAction": 2,
        "trafficLimitThrottleIn": 100000
    }),
});

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

const response = await axios({
    method: "put",
    url: "https://cp.domain.com/api/v1/compute/hypervisors/1",
    headers: {
        "Authorization": "Bearer <token>",
        "Accept": "application/json",
        "Content-Type": "application/json",
    },
    data: {
        "maxServers": 50,
        "maxMemory": 262144,
        "diskType": "raw",
        "defaultCpu": "host-passthrough",
        "trafficLimitAction": 2,
        "trafficLimitThrottleIn": 100000
    },
});

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

const payload = JSON.stringify({
    "maxServers": 50,
    "maxMemory": 262144,
    "diskType": "raw",
    "defaultCpu": "host-passthrough",
    "trafficLimitAction": 2,
    "trafficLimitThrottleIn": 100000
});

const req = https.request({
    hostname: "cp.domain.com",
    path: "/api/v1/compute/hypervisors/1",
    method: "PUT",
    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"
headers = {
    "Authorization": "Bearer <token>",
    "Accept": "application/json",
    "Content-Type": "application/json",
}
payload = {
    "maxServers": 50,
    "maxMemory": 262144,
    "diskType": "raw",
    "defaultCpu": "host-passthrough",
    "trafficLimitAction": 2,
    "trafficLimitThrottleIn": 100000,
}

response = requests.request("PUT", 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({
    "maxServers": 50,
    "maxMemory": 262144,
    "diskType": "raw",
    "defaultCpu": "host-passthrough",
    "trafficLimitAction": 2,
    "trafficLimitThrottleIn": 100000,
})

conn.request("PUT", "/api/v1/compute/hypervisors/1", 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',
    CURLOPT_RETURNTRANSFER => true,
    CURLOPT_ENCODING => '',
    CURLOPT_MAXREDIRS => 10,
    CURLOPT_TIMEOUT => 0,
    CURLOPT_FOLLOWLOCATION => true,
    CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
    CURLOPT_CUSTOMREQUEST => 'PUT',
    CURLOPT_POSTFIELDS => json_encode([
        'maxServers' => 50,
        'maxMemory' => 262144,
        'diskType' => 'raw',
        'defaultCpu' => 'host-passthrough',
        'trafficLimitAction' => 2,
        'trafficLimitThrottleIn' => 100000,
    ]),
    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('PUT', 'https://cp.domain.com/api/v1/compute/hypervisors/1', [
    'headers' => [
        'Authorization' => 'Bearer <token>',
        'Accept' => 'application/json',
    ],
    'json' => [
        'maxServers' => 50,
        'maxMemory' => 262144,
        'diskType' => 'raw',
        'defaultCpu' => 'host-passthrough',
        'trafficLimitAction' => 2,
        'trafficLimitThrottleIn' => 100000,
    ],
]);

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"
    payload := strings.NewReader(`{
    "maxServers": 50,
    "maxMemory": 262144,
    "diskType": "raw",
    "defaultCpu": "host-passthrough",
    "trafficLimitAction": 2,
    "trafficLimitThrottleIn": 100000
}`)
    req, _ := http.NewRequest("PUT", 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"))
            .header("Authorization", "Bearer <token>")
            .header("Accept", "application/json")
            .header("Content-Type", "application/json")
            .method("PUT", HttpRequest.BodyPublishers.ofString("{\"maxServers\":50,\"maxMemory\":262144,\"diskType\":\"raw\",\"defaultCpu\":\"host-passthrough\",\"trafficLimitAction\":2,\"trafficLimitThrottleIn\":100000}"))
            .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("{\"maxServers\":50,\"maxMemory\":262144,\"diskType\":\"raw\",\"defaultCpu\":\"host-passthrough\",\"trafficLimitAction\":2,\"trafficLimitThrottleIn\":100000}", json);

        Request request = new Request.Builder()
            .url("https://cp.domain.com/api/v1/compute/hypervisors/1")
            .method("PUT", 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("PUT"), "https://cp.domain.com/api/v1/compute/hypervisors/1");
request.Headers.Authorization = new AuthenticationHeaderValue("Bearer", "<token>");
request.Headers.Accept.Add(new MediaTypeWithQualityHeaderValue("application/json"));
request.Content = new StringContent("{\"maxServers\":50,\"maxMemory\":262144,\"diskType\":\"raw\",\"defaultCpu\":\"host-passthrough\",\"trafficLimitAction\":2,\"trafficLimitThrottleIn\":100000}", 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")
request = Net::HTTP::Put.new(uri)
request["Authorization"] = "Bearer <token>"
request["Accept"] = "application/json"
request["Content-Type"] = "application/json"
request.body = "{\"maxServers\":50,\"maxMemory\":262144,\"diskType\":\"raw\",\"defaultCpu\":\"host-passthrough\",\"trafficLimitAction\":2,\"trafficLimitThrottleIn\":100000}"

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")!)
request.httpMethod = "PUT"
request.setValue("Bearer <token>", forHTTPHeaderField: "Authorization")
request.setValue("application/json", forHTTPHeaderField: "Accept")
request.setValue("application/json", forHTTPHeaderField: "Content-Type")
request.httpBody = "{\"maxServers\":50,\"maxMemory\":262144,\"diskType\":\"raw\",\"defaultCpu\":\"host-passthrough\",\"trafficLimitAction\":2,\"trafficLimitThrottleIn\":100000}".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::PUT, "https://cp.domain.com/api/v1/compute/hypervisors/1")
        .bearer_auth("<token>")
        .header("Accept", "application/json")
        .header("Content-Type", "application/json")
        .body(r#"{
    "maxServers": 50,
    "maxMemory": 262144,
    "diskType": "raw",
    "defaultCpu": "host-passthrough",
    "trafficLimitAction": 2,
    "trafficLimitThrottleIn": 100000
}"#)
        .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::PUT, "https://cp.domain.com/api/v1/compute/hypervisors/1")
        .bearer_auth("<token>")
        .header("Accept", "application/json")
        .header("Content-Type", "application/json")
        .body(r#"{
    "maxServers": 50,
    "maxMemory": 262144,
    "diskType": "raw",
    "defaultCpu": "host-passthrough",
    "trafficLimitAction": 2,
    "trafficLimitThrottleIn": 100000
}"#)
        .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 = """{
    "maxServers": 50,
    "maxMemory": 262144,
    "diskType": "raw",
    "defaultCpu": "host-passthrough",
    "trafficLimitAction": 2,
    "trafficLimitThrottleIn": 100000
}""".toRequestBody("application/json".toMediaType())
    val request = Request.Builder()
        .url("https://cp.domain.com/api/v1/compute/hypervisors/1")
        .method("PUT", 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('PUT', Uri.parse('https://cp.domain.com/api/v1/compute/hypervisors/1'));
  request.headers['Authorization'] = 'Bearer <token>';
  request.headers['Accept'] = 'application/json';
  request.headers['Content-Type'] = 'application/json';
  request.body = r'''{
    "maxServers": 50,
    "maxMemory": 262144,
    "diskType": "raw",
    "defaultCpu": "host-passthrough",
    "trafficLimitAction": 2,
    "trafficLimitThrottleIn": 100000
}''';

  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");
    curl_easy_setopt(curl, CURLOPT_CUSTOMREQUEST, "PUT");
    curl_easy_setopt(curl, CURLOPT_HTTPHEADER, headers);
    curl_easy_setopt(curl, CURLOPT_POSTFIELDS, "{\"maxServers\":50,\"maxMemory\":262144,\"diskType\":\"raw\",\"defaultCpu\":\"host-passthrough\",\"trafficLimitAction\":2,\"trafficLimitThrottleIn\":100000}");

    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 = @'
{
    "maxServers": 50,
    "maxMemory": 262144,
    "diskType": "raw",
    "defaultCpu": "host-passthrough",
    "trafficLimitAction": 2,
    "trafficLimitThrottleIn": 100000
}
'@

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

{
    "maxServers": 50,
    "maxMemory": 262144,
    "diskType": "raw",
    "defaultCpu": "host-passthrough",
    "trafficLimitAction": 2,
    "trafficLimitThrottleIn": 100000
}
curl --location --request PUT 'https://cp.domain.com/api/v1/compute/hypervisors/1' \
--header 'Authorization: Bearer <token>' \
--header 'Accept: application/json' \
--header 'Content-Type: application/json' \
--data-raw '{
    "config": {
        "hyperv": {
            "relaxed": true,
            "vapic": true,
            "spinlocks": true,
            "spinlocksValue": 8191
        }
    }
}'
wget --quiet --output-document=- \
  --method=PUT \
  --header='Authorization: Bearer <token>' \
  --header='Accept: application/json' \
  --header='Content-Type: application/json' \
  --body-data='{
    "config": {
        "hyperv": {
            "relaxed": true,
            "vapic": true,
            "spinlocks": true,
            "spinlocksValue": 8191
        }
    }
}' \
  'https://cp.domain.com/api/v1/compute/hypervisors/1'
http PUT 'https://cp.domain.com/api/v1/compute/hypervisors/1' \
  'Authorization: Bearer <token>' \
  'Accept: application/json' \
  'Content-Type: application/json' <<< '{
    "config": {
        "hyperv": {
            "relaxed": true,
            "vapic": true,
            "spinlocks": true,
            "spinlocksValue": 8191
        }
    }
}'
const response = await fetch("https://cp.domain.com/api/v1/compute/hypervisors/1", {
    method: "PUT",
    headers: {
        "Authorization": "Bearer <token>",
        "Accept": "application/json",
        "Content-Type": "application/json",
    },
    body: JSON.stringify({
        "config": {
            "hyperv": {
                "relaxed": true,
                "vapic": true,
                "spinlocks": true,
                "spinlocksValue": 8191
            }
        }
    }),
});

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

const response = await axios({
    method: "put",
    url: "https://cp.domain.com/api/v1/compute/hypervisors/1",
    headers: {
        "Authorization": "Bearer <token>",
        "Accept": "application/json",
        "Content-Type": "application/json",
    },
    data: {
        "config": {
            "hyperv": {
                "relaxed": true,
                "vapic": true,
                "spinlocks": true,
                "spinlocksValue": 8191
            }
        }
    },
});

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

const payload = JSON.stringify({
    "config": {
        "hyperv": {
            "relaxed": true,
            "vapic": true,
            "spinlocks": true,
            "spinlocksValue": 8191
        }
    }
});

const req = https.request({
    hostname: "cp.domain.com",
    path: "/api/v1/compute/hypervisors/1",
    method: "PUT",
    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"
headers = {
    "Authorization": "Bearer <token>",
    "Accept": "application/json",
    "Content-Type": "application/json",
}
payload = {
    "config": {
        "hyperv": {
            "relaxed": True,
            "vapic": True,
            "spinlocks": True,
            "spinlocksValue": 8191,
        },
    },
}

response = requests.request("PUT", 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({
    "config": {
        "hyperv": {
            "relaxed": True,
            "vapic": True,
            "spinlocks": True,
            "spinlocksValue": 8191,
        },
    },
})

conn.request("PUT", "/api/v1/compute/hypervisors/1", 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',
    CURLOPT_RETURNTRANSFER => true,
    CURLOPT_ENCODING => '',
    CURLOPT_MAXREDIRS => 10,
    CURLOPT_TIMEOUT => 0,
    CURLOPT_FOLLOWLOCATION => true,
    CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
    CURLOPT_CUSTOMREQUEST => 'PUT',
    CURLOPT_POSTFIELDS => json_encode([
        'config' => [
            'hyperv' => [
                'relaxed' => true,
                'vapic' => true,
                'spinlocks' => true,
                'spinlocksValue' => 8191,
            ],
        ],
    ]),
    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('PUT', 'https://cp.domain.com/api/v1/compute/hypervisors/1', [
    'headers' => [
        'Authorization' => 'Bearer <token>',
        'Accept' => 'application/json',
    ],
    'json' => [
        'config' => [
            'hyperv' => [
                'relaxed' => true,
                'vapic' => true,
                'spinlocks' => true,
                'spinlocksValue' => 8191,
            ],
        ],
    ],
]);

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"
    payload := strings.NewReader(`{
    "config": {
        "hyperv": {
            "relaxed": true,
            "vapic": true,
            "spinlocks": true,
            "spinlocksValue": 8191
        }
    }
}`)
    req, _ := http.NewRequest("PUT", 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"))
            .header("Authorization", "Bearer <token>")
            .header("Accept", "application/json")
            .header("Content-Type", "application/json")
            .method("PUT", HttpRequest.BodyPublishers.ofString("{\"config\":{\"hyperv\":{\"relaxed\":true,\"vapic\":true,\"spinlocks\":true,\"spinlocksValue\":8191}}}"))
            .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("{\"config\":{\"hyperv\":{\"relaxed\":true,\"vapic\":true,\"spinlocks\":true,\"spinlocksValue\":8191}}}", json);

        Request request = new Request.Builder()
            .url("https://cp.domain.com/api/v1/compute/hypervisors/1")
            .method("PUT", 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("PUT"), "https://cp.domain.com/api/v1/compute/hypervisors/1");
request.Headers.Authorization = new AuthenticationHeaderValue("Bearer", "<token>");
request.Headers.Accept.Add(new MediaTypeWithQualityHeaderValue("application/json"));
request.Content = new StringContent("{\"config\":{\"hyperv\":{\"relaxed\":true,\"vapic\":true,\"spinlocks\":true,\"spinlocksValue\":8191}}}", 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")
request = Net::HTTP::Put.new(uri)
request["Authorization"] = "Bearer <token>"
request["Accept"] = "application/json"
request["Content-Type"] = "application/json"
request.body = "{\"config\":{\"hyperv\":{\"relaxed\":true,\"vapic\":true,\"spinlocks\":true,\"spinlocksValue\":8191}}}"

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")!)
request.httpMethod = "PUT"
request.setValue("Bearer <token>", forHTTPHeaderField: "Authorization")
request.setValue("application/json", forHTTPHeaderField: "Accept")
request.setValue("application/json", forHTTPHeaderField: "Content-Type")
request.httpBody = "{\"config\":{\"hyperv\":{\"relaxed\":true,\"vapic\":true,\"spinlocks\":true,\"spinlocksValue\":8191}}}".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::PUT, "https://cp.domain.com/api/v1/compute/hypervisors/1")
        .bearer_auth("<token>")
        .header("Accept", "application/json")
        .header("Content-Type", "application/json")
        .body(r#"{
    "config": {
        "hyperv": {
            "relaxed": true,
            "vapic": true,
            "spinlocks": true,
            "spinlocksValue": 8191
        }
    }
}"#)
        .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::PUT, "https://cp.domain.com/api/v1/compute/hypervisors/1")
        .bearer_auth("<token>")
        .header("Accept", "application/json")
        .header("Content-Type", "application/json")
        .body(r#"{
    "config": {
        "hyperv": {
            "relaxed": true,
            "vapic": true,
            "spinlocks": true,
            "spinlocksValue": 8191
        }
    }
}"#)
        .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 = """{
    "config": {
        "hyperv": {
            "relaxed": true,
            "vapic": true,
            "spinlocks": true,
            "spinlocksValue": 8191
        }
    }
}""".toRequestBody("application/json".toMediaType())
    val request = Request.Builder()
        .url("https://cp.domain.com/api/v1/compute/hypervisors/1")
        .method("PUT", 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('PUT', Uri.parse('https://cp.domain.com/api/v1/compute/hypervisors/1'));
  request.headers['Authorization'] = 'Bearer <token>';
  request.headers['Accept'] = 'application/json';
  request.headers['Content-Type'] = 'application/json';
  request.body = r'''{
    "config": {
        "hyperv": {
            "relaxed": true,
            "vapic": true,
            "spinlocks": true,
            "spinlocksValue": 8191
        }
    }
}''';

  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");
    curl_easy_setopt(curl, CURLOPT_CUSTOMREQUEST, "PUT");
    curl_easy_setopt(curl, CURLOPT_HTTPHEADER, headers);
    curl_easy_setopt(curl, CURLOPT_POSTFIELDS, "{\"config\":{\"hyperv\":{\"relaxed\":true,\"vapic\":true,\"spinlocks\":true,\"spinlocksValue\":8191}}}");

    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 = @'
{
    "config": {
        "hyperv": {
            "relaxed": true,
            "vapic": true,
            "spinlocks": true,
            "spinlocksValue": 8191
        }
    }
}
'@

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

{
    "config": {
        "hyperv": {
            "relaxed": true,
            "vapic": true,
            "spinlocks": true,
            "spinlocksValue": 8191
        }
    }
}

Responses

200

The updated hypervisor, as GET /compute/hypervisors/{hypervisorId} returns it.

#
application/json
object

A hypervisor as configured in VirtFusion.

Hypervisor fields
idinteger#
commissionedinteger#
ipstring#
ipAltstring#nullable
hostnamestring#nullable
portinteger#
sshPortinteger#
namestring#
maintenanceboolean#
enabledboolean#
nfTypeinteger#

The network filter (firewall) implementation for servers on the hypervisor.

ValueMeaning
0None
1Libvirt
2Native standard
3Native performance, IPv4
4Native performance, IPv4 and IPv6
5Native privacy (experimental)
groupobject#
fields
descriptionstring#nullable
idinteger#
namestring#
defaultboolean#
enabledboolean#
distributionTypeinteger#
createdstring <date-time>#
updatedstring <date-time>#
maxServersinteger#
maxCpuinteger#
maxMemoryinteger#
networksarray[object]#
item fields
typestring#
idinteger#
bridgestring#
primaryboolean#
defaultboolean#
createdstring <date-time>#
updatedstring <date-time>#
storagearray[any]#
createdstring <date-time>#
updatedstring <date-time>#
prohibitboolean#

When true the scheduler will not place new servers on the hypervisor.

Since 7.1.0

The remaining writable properties, under the names PUT /compute/hypervisors/{hypervisorId} accepts. Only on GET /compute/hypervisors/{hypervisorId}, not in the paged list.

Since 7.1.0
Example
{
    "data": {
        "id": 1,
        "commissioned": 3,
        "ip": "192.168.4.10",
        "ipAlt": null,
        "hostname": null,
        "port": 8892,
        "sshPort": 22,
        "name": "PHV 1 (RED)",
        "maintenance": true,
        "enabled": true,
        "prohibit": true,
        "nfType": 4,
        "group": {
            "id": 1,
            "name": "Default",
            "description": "Default hypervisor group",
            "default": true,
            "enabled": true,
            "distributionType": 5,
            "created": "2024-03-12T22:21:32+00:00",
            "updated": "2024-04-12T20:56:04+00:00"
        },
        "maxServers": 0,
        "maxCpu": 4,
        "maxMemory": 6004,
        "created": "2024-03-12T22:37:15+00:00",
        "updated": "2026-10-06T09:12:40+00:00",
        "networks": [
            {
                "id": 1,
                "type": "simpleBridge",
                "bridge": "br0",
                "primary": true,
                "default": true,
                "created": "2024-03-12T22:37:15+00:00",
                "updated": "2024-03-12T22:37:40+00:00"
            }
        ],
        "settings": {
            "groupId": 1,
            "licenseType": 1,
            "diskType": "inherit",
            "diskCacheType": "inherit",
            "diskDriverIo": 0,
            "backupStorageType": 1,
            "cpuModel": null,
            "cpuSet": null,
            "defaultCpu": "inherit",
            "defaultMachineType": "inherit",
            "exposeVncDetails": 0,
            "forceIpv6": false,
            "vncListenType": 1,
            "timezone": "Europe/London",
            "displayName": null,
            "trafficCountDirection": 0,
            "trafficLimitAction": null,
            "trafficLimitThrottleIn": null,
            "trafficLimitThrottleOut": null,
            "trafficLimitNotification1": null,
            "trafficLimitNotification2": null,
            "config": {
                "hyperv": {
                    "passthrough": false,
                    "relaxed": false,
                    "vapic": false,
                    "spinlocks": false,
                    "vpindex": false,
                    "runtime": false,
                    "synic": false,
                    "stimer": false,
                    "reset": false,
                    "vendorId": false,
                    "frequencies": false,
                    "reenlightenment": false,
                    "tlbflush": false,
                    "ipi": false,
                    "evmcs": false,
                    "vendorIdValue": "KVM VM",
                    "spinlocksValue": "8191",
                    "clockEnabled": false
                },
                "cpuflags": {
                    "topoext": true,
                    "svm": true,
                    "vmx": true
                }
            }
        }
    }
}
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

A field failed validation, an unknown field was sent, or the body had no fields. Nothin…

#
application/json

A field failed validation, an unknown field was sent, or the body had no fields. Nothing was written.

errorsobject#
Examples
{
    "errors": {
        "maxCpu": [
            "The max cpu field must be between 0 and 9999."
        ]
    }
}
{
    "errors": {
        "maintenence": [
            "unknown field"
        ]
    }
}
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
}