Hypervisors

Regenerate a hypervisor's network filters

Since 7.1.0
POST/compute/hypervisors/{hypervisorId}/networkFilters/regenerate

Push the hypervisor's network filter settings to every server on it, in the background. GET /compute/hypervisors/{hypervisorId} reports progress in settings.networkFilter.lastResult.

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

Request Code Samples

curl --location --request POST 'https://cp.domain.com/api/v1/compute/hypervisors/1/networkFilters/regenerate' \
--header 'Authorization: Bearer <token>' \
--header 'Accept: application/json'
wget --quiet --output-document=- \
  --method=POST \
  --header='Authorization: Bearer <token>' \
  --header='Accept: application/json' \
  'https://cp.domain.com/api/v1/compute/hypervisors/1/networkFilters/regenerate'
http POST 'https://cp.domain.com/api/v1/compute/hypervisors/1/networkFilters/regenerate' \
  'Authorization: Bearer <token>' \
  'Accept: application/json'
const response = await fetch("https://cp.domain.com/api/v1/compute/hypervisors/1/networkFilters/regenerate", {
    method: "POST",
    headers: {
        "Authorization": "Bearer <token>",
        "Accept": "application/json",
    },
});

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/networkFilters/regenerate",
    headers: {
        "Authorization": "Bearer <token>",
        "Accept": "application/json",
    },
});

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

const req = https.request({
    hostname: "cp.domain.com",
    path: "/api/v1/compute/hypervisors/1/networkFilters/regenerate",
    method: "POST",
    headers: {
        "Authorization": "Bearer <token>",
        "Accept": "application/json",
    },
}, (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.end();
import requests

url = "https://cp.domain.com/api/v1/compute/hypervisors/1/networkFilters/regenerate"
headers = {
    "Authorization": "Bearer <token>",
    "Accept": "application/json",
}

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

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",
}

conn.request("POST", "/api/v1/compute/hypervisors/1/networkFilters/regenerate", None, 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/networkFilters/regenerate',
    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_HTTPHEADER => array(
        'Authorization: Bearer <token>',
        'Accept: 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/networkFilters/regenerate', [
    'headers' => [
        'Authorization' => 'Bearer <token>',
        'Accept' => 'application/json',
    ],
]);

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

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

func main() {
    url := "https://cp.domain.com/api/v1/compute/hypervisors/1/networkFilters/regenerate"
    req, _ := http.NewRequest("POST", url, nil)
    req.Header.Add("Authorization", "Bearer <token>")
    req.Header.Add("Accept", "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/networkFilters/regenerate"))
            .header("Authorization", "Bearer <token>")
            .header("Accept", "application/json")
            .method("POST", HttpRequest.BodyPublishers.noBody())
            .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();

        Request request = new Request.Builder()
            .url("https://cp.domain.com/api/v1/compute/hypervisors/1/networkFilters/regenerate")
            .method("POST", null)
            .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/networkFilters/regenerate");
request.Headers.Authorization = new AuthenticationHeaderValue("Bearer", "<token>");
request.Headers.Accept.Add(new MediaTypeWithQualityHeaderValue("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/networkFilters/regenerate")
request = Net::HTTP::Post.new(uri)
request["Authorization"] = "Bearer <token>"
request["Accept"] = "application/json"

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/networkFilters/regenerate")!)
request.httpMethod = "POST"
request.setValue("Bearer <token>", forHTTPHeaderField: "Authorization")
request.setValue("application/json", forHTTPHeaderField: "Accept")

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/networkFilters/regenerate")
        .bearer_auth("<token>")
        .header("Accept", "application/json")
        .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/networkFilters/regenerate")
        .bearer_auth("<token>")
        .header("Accept", "application/json")
        .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

fun main() {
    val client = OkHttpClient()
    val request = Request.Builder()
        .url("https://cp.domain.com/api/v1/compute/hypervisors/1/networkFilters/regenerate")
        .method("POST", null)
        .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/networkFilters/regenerate'));
  request.headers['Authorization'] = 'Bearer <token>';
  request.headers['Accept'] = 'application/json';

  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");

    curl_easy_setopt(curl, CURLOPT_URL, "https://cp.domain.com/api/v1/compute/hypervisors/1/networkFilters/regenerate");
    curl_easy_setopt(curl, CURLOPT_CUSTOMREQUEST, "POST");
    curl_easy_setopt(curl, CURLOPT_HTTPHEADER, headers);

    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"
}

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

Responses

202

The regenerate has started.

#
application/json
object

A hypervisor's native network filter v2 settings. Meaningful when nfType is 10. Changing any of them marks the hypervisor pending until its filters are regenerated.

NetworkFilterSettings fields
componentsarray[string]#nullable

The selected component keys, from GET /compute/networkFilters/components. null selects the recommended set.

managementRangesarray[string]#

CIDRs servers may not reach, the metadata address excepted. Used by mgmt-protect.

metadataAddressstring#nullable

IPv4 address reachable even inside a management range. null means 169.254.169.254.

rateLimitsNetworkFilterRateLimits#nullable

Frames per second per interface; a burst of twice the rate is allowed. A key left out or null inherits. null as a whole inherits everything.

NetworkFilterRateLimits fields
arpinteger#nullable
Range: at least 1
ndinteger#nullable
Range: at least 1
bcastinteger#nullable
Range: at least 1
syninteger#nullable
Range: at least 1
blockedPortsOutNetworkFilterPortList#nullable

Destination ports, each a port or a low-high range in 1 to 65535. Overlapping ranges are merged. On a hypervisor, null and empty lists both mean no ports. On an interface, null means the hypervisor's list and empty lists mean none for that interface.

Example: {"tcp":["25","465","587"],"udp":[]}
NetworkFilterPortList fields
tcparray[string]#
udparray[string]#
blockedPortsInNetworkFilterPortList#nullable

Destination ports, each a port or a low-high range in 1 to 65535. Overlapping ranges are merged. On a hypervisor, null and empty lists both mean no ports. On an interface, null means the hypervisor's list and empty lists mean none for that interface.

Example: {"tcp":["25","465","587"],"udp":[]}
NetworkFilterPortList fields
tcparray[string]#
udparray[string]#
blockOnFailureboolean#

When true, a server's start, build or migration stops if its filter cannot be applied. When false, the default, it goes ahead and the failure is reported in lastResult. Takes effect when the filters are regenerated.

pendingboolean#read-only

A change has been saved, or a filter could not be applied, and the hypervisor's servers have not been regenerated since.

lastResultstring#nullableread-only

What the last regenerate reported, running while one runs, or the latest filter failure a server was started or migrated past.

Example
{
    "data": {
        "components": null,
        "managementRanges": [
            "10.0.0.0/8"
        ],
        "metadataAddress": null,
        "rateLimits": null,
        "blockedPortsOut": {
            "tcp": [
                "25",
                "465",
                "587"
            ],
            "udp": []
        },
        "blockedPortsIn": null,
        "blockOnFailure": false,
        "pending": true,
        "lastResult": "running"
    }
}
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"
}
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
}