VirtFusion Global API

https://docs.virtfusion.com/api
Admin
VirtFusion Global API is a REST-based administrator API for deploying and managing virtual servers,...
Tokens:1,117,303
Snippets:5,842
Trust Score:7.6
Update:1 week ago
Show doc for...
Tokens:
Raw
### GET media templates with Go net/http

Source: https://docs.virtfusion.com/api/listTemplates

Go example using the net/http package to call the GET /api/v1/media/templates endpoint. Requires an Authorization header with a bearer token and an Accept header of application/json.

```go
package main

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

func main() {
    url := "https://cp.domain.com/api/v1/media/templates?results=20&page=1&distro=AlmaLinux"
    req, _ := http.NewRequest("GET", 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))
}
```

--------------------------------

### GET media templates with cURL, wget, and HTTPie

Source: https://docs.virtfusion.com/api/listTemplates

Command-line examples for the GET /api/v1/media/templates endpoint using cURL, wget, and HTTPie. All require an Authorization header with a bearer token and an Accept header of application/json.

```bash
curl --location --request GET 'https://cp.domain.com/api/v1/media/templates?results=20&page=1&distro=AlmaLinux' \
--header 'Authorization: Bearer <token>' \
--header 'Accept: application/json'
```

```bash
wget --quiet --output-document=- \
  --method=GET \
  --header='Authorization: Bearer <token>' \
  --header='Accept: application/json' \
  'https://cp.domain.com/api/v1/media/templates?results=20&page=1&distro=AlmaLinux'
```

```bash
http GET 'https://cp.domain.com/api/v1/media/templates?results=20&page=1&distro=AlmaLinux' \
  'Authorization: Bearer <token>' \
  'Accept: application/json'
```

--------------------------------

### Go net/http request to GET /connect

Source: https://docs.virtfusion.com/api/testConnection

Use this Go net/http example to test the connection. It sends a GET request with the bearer token and Accept header, then prints the status code and response body.

```go
package main

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

func main() {
    url := "https://cp.domain.com/api/v1/connect"
    req, _ := http.NewRequest("GET", 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))
}
```

--------------------------------

### Retrieve hypervisor group with cURL and Guzzle

Source: https://docs.virtfusion.com/api/getHypervisorGroup

PHP examples using cURL and Guzzle to retrieve a hypervisor group. Both send a GET request with bearer token and Accept headers; the Guzzle example requires the Guzzle client installed via Composer.

```php
<?php

$curl = curl_init();

curl_setopt_array($curl, array(
    CURLOPT_URL => 'https://cp.domain.com/api/v1/compute/hypervisors/groups/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 => 'GET',
    CURLOPT_HTTPHEADER => array(
        'Authorization: Bearer <token>',
        'Accept: application/json'
    ),
));

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

echo $response;
```

```php
<?php

require 'vendor/autoload.php';

use GuzzleHttp\Client;

$client = new Client();

$response = $client->request('GET', 'https://cp.domain.com/api/v1/compute/hypervisors/groups/1', [
    'headers' => [
        'Authorization' => 'Bearer <token>',
        'Accept' => 'application/json',
    ],
]);

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

--------------------------------

### Create package with full configuration

Source: https://docs.virtfusion.com/api/createPackage

Example request body that sets enabled, resource limits, virtualization CPU model, and references template collections and firewall rulesets by ID.

```json
{
    "name": "Medium",
    "enabled": true,
    "memory": 4096,
    "cpuCores": 2,
    "primaryStorage": 80,
    "traffic": 2000,
    "virtualization": {
        "cpuModel": "host-passthrough"
    },
    "templateCollections": [
        2
    ],
    "firewallRulesets": [
        7
    ]
}
```

--------------------------------

### Create Disk with net/http (Go)

Source: https://docs.virtfusion.com/api/createServerDisk

Go example using the standard net/http package to create a disk. It builds a POST request with a JSON payload, sets Authorization, Accept, and Content-Type headers, and prints the status code and response body.

```go
package main

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

func main() {
    url := "https://cp.domain.com/api/v1/servers/1/disks"
    payload := strings.NewReader(`{
    "sizeGb": 100,
    "storagePointId": 12,
    "bus": "virtio-scsi",
    "qos": {
        "readIops": 500
    }
}`)
    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))
}
```

--------------------------------

### GET IP Audit with PHP cURL and Guzzle

Source: https://docs.virtfusion.com/api/listIPAudit

PHP examples using cURL and Guzzle to make a GET request to the IP audit endpoint. The cURL example uses curl_setopt_array; the Guzzle example requires the vendor autoload and prints the status code and body.

```php
<?php

$curl = curl_init();

curl_setopt_array($curl, array(
    CURLOPT_URL => 'https://cp.domain.com/api/v1/connectivity/ipaudit?page=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 => 'GET',
    CURLOPT_HTTPHEADER => array(
        'Authorization: Bearer <token>',
        'Accept: application/json'
    ),
));

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

echo $response;
```

```php
<?php

require 'vendor/autoload.php';

use GuzzleHttp\Client;

$client = new Client();

$response = $client->request('GET', 'https://cp.domain.com/api/v1/connectivity/ipaudit?page=1', [
    'headers' => [
        'Authorization' => 'Bearer <token>',
        'Accept' => 'application/json',
    ],
]);

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

--------------------------------

### Create Hypervisor Network with net/http (Go)

Source: https://docs.virtfusion.com/api/createHypervisorNetwork

Go example using the net/http package to create a hypervisor network. It constructs a POST request with a JSON payload and Bearer token, sends it with http.DefaultClient, and prints the status code and response body.

```go
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))
}
```

--------------------------------

### GET self-service report with Python requests and http.client

Source: https://docs.virtfusion.com/api/getUserSelfServiceReport

Python examples using the requests and http.client libraries to call the self-service report endpoint. Both send a GET request with the required headers and print the status code and JSON response. The requests example uses the requests.request method; the http.client example uses HTTPSConnection.

```python
import requests

url = "https://cp.domain.com/api/v1/selfService/report/byUserExtRelationId/1?period=0&currency=USD&relStr=true"
headers = {
    "Authorization": "Bearer <token>",
    "Accept": "application/json",
}

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

print(response.status_code)
print(response.json())
```

```python
import http.client
import json

conn = http.client.HTTPSConnection("cp.domain.com")
headers = {
    "Authorization": "Bearer <token>",
    "Accept": "application/json",
}

conn.request("GET", "/api/v1/selfService/report/byUserExtRelationId/1?period=0&currency=USD&relStr=true", None, headers)
response = conn.getresponse()

print(response.status)
print(json.loads(response.read()))
```

--------------------------------

### Create server with net/http (Go)

Source: https://docs.virtfusion.com/api/createServer

Go example using the net/http package to create a server. It constructs a POST request with a JSON payload and sets the Authorization, Accept, and Content-Type headers. The response status code and body are printed.

```go
package main

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

func main() {
    url := "https://cp.domain.com/api/v1/servers?dryRun=false"
    payload := strings.NewReader(`{
    "packageId": 1,
    "userId": 1,
    "hypervisorId": 1,
    "ipv4": 1,
    "storage": 20,
    "traffic": 20,
    "memory": 512,
    "cpuCores": 5,
    "networkSpeedInbound": 200,
    "networkSpeedOutbound": 400,
    "storageProfile": 1,
    "networkProfile": 1,
    "firewallRulesets": [
        1,
        2
    ],
    "hypervisorAssetGroups": [
        3,
        4
    ],
    "additionalStorage1Enable": true,
    "additionalStorage2Enable": false,
    "additionalStorage1Profile": 1,
    "additionalStorage2Profile": 2,
    "additionalStorage1Capacity": 10,
    "additionalStorage2Capacity": 20
}`)
    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))
}
```

--------------------------------

### GET self-service report with fetch and axios

Source: https://docs.virtfusion.com/api/getUserSelfServiceReport

JavaScript examples using fetch and axios to call the self-service report endpoint. Both send a GET request with the required Authorization and Accept headers. The fetch example parses the JSON response and logs the status and data; the axios example logs the status and response data.

```javascript
const response = await fetch("https://cp.domain.com/api/v1/selfService/report/byUserExtRelationId/1?period=0&currency=USD&relStr=true", {
    method: "GET",
    headers: {
        "Authorization": "Bearer <token>",
        "Accept": "application/json",
    },
});

const data = await response.json();
console.log(response.status, data);
```

```javascript
import axios from "axios";

const response = await axios({
    method: "get",
    url: "https://cp.domain.com/api/v1/selfService/report/byUserExtRelationId/1?period=0&currency=USD&relStr=true",
    headers: {
        "Authorization": "Bearer <token>",
        "Accept": "application/json",
    },
});

console.log(response.status, response.data);
```

--------------------------------

### Get Resource Pack - Example Response

Source: https://docs.virtfusion.com/api/getResourcePack

Example JSON response for the Get Resource Pack endpoint. Shows the structure with data, limits, used, and usage objects containing server, memory, storage, CPU, and traffic metrics.

```json
{
    "data": {
        "type": "pack",
        "id": 18,
        "pid": 9,
        "label": null,
        "name": "Pack 2 · 2  / 4096 / 250",
        "limits": {
            "total_servers": 2,
            "total_memory": 4096,
            "total_storage": 200,
            "total_cpu": 2,
            "total_traffic": 0,
            "max_memory": 0,
            "max_storage": 0,
            "max_cpu": 0,
            "max_traffic": 0
        },
        "used": {
            "servers": 0,
            "memory": 0,
            "storage": 0,
            "cpu": 0,
            "traffic": 0
        },
        "usage": {
            "servers": {
                "t": 0,
                "u": 0,
                "f": 0,
                "p": 0,
                "l": false
            },
            "memory": {
                "t": 0,
                "u": 0,
                "f": 0,
                "p": 0,
                "l": false
            },
            "storage": {
                "t": 0,
                "u": 0,
                "f": 0,
                "p": 0,
                "l": false
            },
            "cpu": {
                
```

--------------------------------

### Create Disk with HttpClient (C#)

Source: https://docs.virtfusion.com/api/createServerDisk

C# example using System.Net.Http to create a disk. It sends a POST request with a JSON string content, sets Authorization and Accept headers, and prints the status code and response body.

```csharp
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/servers/1/disks");
request.Headers.Authorization = new AuthenticationHeaderValue("Bearer", "<token>");
request.Headers.Accept.Add(new MediaTypeWithQualityHeaderValue("application/json"));
request.Content = new StringContent("{\"sizeGb\":100,\"storagePointId\":12,\"bus\":\"virtio-scsi\",\"qos\":{\"readIops\":500}}", Encoding.UTF8, "application/json");

var response = await client.SendAsync(request);
Console.WriteLine((int)response.StatusCode);
Console.WriteLine(await response.Content.ReadAsStringAsync());
```

--------------------------------

### Create Hypervisor Network with libcurl (C)

Source: https://docs.virtfusion.com/api/createHypervisorNetwork

Use this libcurl example to send a POST request to the hypervisor networks endpoint. It sets the Authorization, Accept, and Content-Type headers, then sends a JSON body with network configuration. The example prints an error to stderr if the request fails and returns a non-zero exit code.

```c
#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;
}
```

Invoke-RestMethod
Copy
```
$headers = @{
    "Authorization" = "Bearer <token>"
    "Accept" = "application/json"
    "Content-Type" = "application/json"
}

$body = @{
    name = "Private"; bridge = "br1"; type = 
```

```powershell
Invoke-RestMethod
Copy
```
$headers = @{
    "Authorization" = "Bearer <token>"
    "Accept" = "application/json"
    "Content-Type" = "application/json"
}

$body = @{
    name = "Private"
    bridge = "br1"
    type = "simpleBridge"
    mtu = 9000
    ipBlockGroupId = 5
} | ConvertTo-Json

$response = Invoke-RestMethod -Uri "https://cp.domain.com/api/v1/compute/hypervisors/1/networks" -Method Post -Headers $headers -Body $body -ContentType "application/json"

Write-Host $response
```
```

--------------------------------

### GET self-service report with PHP cURL and Guzzle

Source: https://docs.virtfusion.com/api/getUserSelfServiceReport

PHP examples using cURL and Guzzle to call the self-service report endpoint. The cURL example sets up a GET request with the required headers and echoes the response. The Guzzle example requires the vendor autoload and uses the Client class to send the request, printing the status code and body.

```php
<?php

$curl = curl_init();

curl_setopt_array($curl, array(
    CURLOPT_URL => 'https://cp.domain.com/api/v1/selfService/report/byUserExtRelationId/1?period=0&currency=USD&relStr=true',
    CURLOPT_RETURNTRANSFER => true,
    CURLOPT_ENCODING => '',
    CURLOPT_MAXREDIRS => 10,
    CURLOPT_TIMEOUT => 0,
    CURLOPT_FOLLOWLOCATION => true,
    CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
    CURLOPT_CUSTOMREQUEST => 'GET',
    CURLOPT_HTTPHEADER => array(
        'Authorization: Bearer <token>',
        'Accept: application/json'
    ),
));

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

echo $response;
```

```php
<?php

require 'vendor/autoload.php';

use GuzzleHttp\Client;

$client = new Client();

$response = $client->request('GET', 'https://cp.domain.com/api/v1/selfService/report/byUserExtRelationId/1?period=0&currency=USD&relStr=true', [
    'headers' => [
        'Authorization' => 'Bearer <token>',
        'Accept' => 'application/json',
    ],
]);

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

--------------------------------

### Create server backup with Go net/http

Source: https://docs.virtfusion.com/api/createServerBackupByServer

Go example using net/http to POST to the backup endpoint. It adds the Authorization and Accept headers, performs the request, and prints the status code and response body.

```go
package main

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

func main() {
    url := "https://cp.domain.com/api/v1/backupManager/backup/server/1"
    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))
}
```

--------------------------------

### HTTP/1.1 GET request example

Source: https://docs.virtfusion.com/api/listHypervisorGroups

Raw HTTP/1.1 GET request to the hypervisor groups endpoint. It includes the Host, Authorization, and Accept headers.

```http
GET /api/v1/compute/hypervisors/groups?results=20&page=1 HTTP/1.1
Host: cp.domain.com
Authorization: Bearer <token>
Accept: application/json

```

--------------------------------

### Create Server Interface with cURL, wget, and HTTPie

Source: https://docs.virtfusion.com/api/createServerInterface

These command-line examples send a POST request to create a server interface. They use cURL, wget, and HTTPie respectively, with the same JSON payload and headers. Replace <token> with your API token.

```bash
curl --location --request POST 'https://cp.domain.com/api/v1/servers/1/interfaces' \
--header 'Authorization: Bearer <token>' \
--header 'Accept: application/json' \
--header 'Content-Type: application/json' \
--data-raw '{
    "hypervisorNetworkId": 2,
    "name": "storage",
    "apply": true
}'
```

```bash
wget --quiet --output-document=- \
  --method=POST \
  --header='Authorization: Bearer <token>' \
  --header='Accept: application/json' \
  --header='Content-Type: application/json' \
  --body-data='{
    "hypervisorNetworkId": 2,
    "name": "storage",
    "apply": true
}' \
  'https://cp.domain.com/api/v1/servers/1/interfaces'
```

```bash
http POST 'https://cp.domain.com/api/v1/servers/1/interfaces' \
  'Authorization: Bearer <token>' \
  'Accept: application/json' \
  'Content-Type: application/json' <<< '{
    "hypervisorNetworkId": 2,
    "name": "storage",
    "apply": true
}'
```

--------------------------------

### GET firewall ruleset with Invoke-RestMethod

Source: https://docs.virtfusion.com/api/getFirewallRuleset

PowerShell example using Invoke-RestMethod to GET the firewall ruleset. Converts the response to JSON with depth 10.

```powershell
$headers = @{
    Authorization = "Bearer <token>"
    Accept        = "application/json"
}

$response = Invoke-RestMethod -Uri "https://cp.domain.com/api/v1/firewall/rulesets/7" -Method GET -Headers $headers
$response | ConvertTo-Json -Depth 10
```

--------------------------------

### Create Disk with HttpClient and OkHttp (Java)

Source: https://docs.virtfusion.com/api/createServerDisk

Java examples for creating a disk. The HttpClient version uses java.net.http.HttpClient with a POST request and a JSON string body; the OkHttp version uses OkHttpClient with a RequestBody. Both set Authorization and Accept headers and print the status code and response body.

```java
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/servers/1/disks"))
            .header("Authorization", "Bearer <token>")
            .header("Accept", "application/json")
            .header("Content-Type", "application/json")
            .method("POST", HttpRequest.BodyPublishers.ofString("{\"sizeGb\":100,\"storagePointId\":12,\"bus\":\"virtio-scsi\",\"qos\":{\"readIops\":500}}"))
            .build();

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

```java
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("{\"sizeGb\":100,\"storagePointId\":12,\"bus\":\"virtio-scsi\",\"qos\":{\"readIops\":500}}", json);

        Request request = new Request.Builder()
            .url("https://cp.domain.com/api/v1/servers/1/disks")
            .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());
        }
    }
}
```

--------------------------------

### 200 Success response example

Source: https://docs.virtfusion.com/api/resetServerPassword

Example of a successful response. The action is queued; poll GET /queue/{queueId} for progress. Contains queueId and expectedPassword.

```json
{
    "data": {
        "queueId": 176,
        "expectedPassword": "l1LMzm2JGhWYdjjn8JkC"
    }
}
```

--------------------------------

### Retrieve a server with Go net/http

Source: https://docs.virtfusion.com/api/getServer

Go example using the net/http package to retrieve a server. It creates a GET request with the Authorization and Accept headers, executes it with the default client, and prints the status code and response body. Panics on error.

```go
package main

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

func main() {
    url := "https://cp.domain.com/api/v1/servers/1?remoteState=false"
    req, _ := http.NewRequest("GET", 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))
}
```

--------------------------------

### PHP cURL and Guzzle GET request for user usage

Source: https://docs.virtfusion.com/api/getUserUsage

Two PHP examples for the same GET request: one using cURL and one using Guzzle. Both require a valid bearer token and send the Accept header. The Guzzle example prints the status code and body.

```php
<?php

$curl = curl_init();

curl_setopt_array($curl, array(
    CURLOPT_URL => 'https://cp.domain.com/api/v1/selfService/usage/byUserExtRelationId/1?period%5B%5D=2025-01-01&range=m&relStr=true',
    CURLOPT_RETURNTRANSFER => true,
    CURLOPT_ENCODING => '',
    CURLOPT_MAXREDIRS => 10,
    CURLOPT_TIMEOUT => 0,
    CURLOPT_FOLLOWLOCATION => true,
    CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
    CURLOPT_CUSTOMREQUEST => 'GET',
    CURLOPT_HTTPHEADER => array(
        'Authorization: Bearer <token>',
        'Accept: application/json'
    ),
));

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

echo $response;
```

```php
<?php

require 'vendor/autoload.php';

use GuzzleHttp\Client;

$client = new Client();

$response = $client->request('GET', 'https://cp.domain.com/api/v1/selfService/usage/byUserExtRelationId/1?period%5B%5D=2025-01-01&range=m&relStr=true', [
    'headers' => [
        'Authorization' => 'Bearer <token>',
        'Accept' => 'application/json',
    ],
]);

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

--------------------------------

### GET /api/v1/media/templates/{id}

Source: https://docs.virtfusion.com/api/getTemplate

This code snippet documents the GET endpoint for retrieving a media template by its ID, including request examples in multiple languages.

```APIDOC
## GET /api/v1/media/templates/{id}

### Description
Retrieves a specific media template by its ID.

### Method
GET

### Endpoint
/api/v1/media/templates/{id}

### Parameters
#### Path Parameters
- **id** (integer) - Required - The ID of the media template to retrieve.

### Request Example
No request body required.

### Response
#### Success Response (200)
- **body** (object) - The media template details.

#### Response Example
No example response body provided in the source.

### Error Handling
No error responses are documented in the source.
```

--------------------------------

### Create server with OkHttp (Kotlin)

Source: https://docs.virtfusion.com/api/createServer

Sends a POST request to https://cp.domain.com/api/v1/servers?dryRun=false with a JSON body describing a new server. Requires an Authorization Bearer token. The body includes package, user, hypervisor, storage, traffic, memory, CPU, network speed, storage/network profiles, firewall rulesets, hypervisor asset groups, and optional additional storage settings.

```kotlin
import okhttp3.MediaType.Companion.toMediaType
import okhttp3.OkHttpClient
import okhttp3.Request
import okhttp3.RequestBody.Companion.toRequestBody

fun main() {
    val client = OkHttpClient()
    val body = """{
    "packageId": 1,
    "userId": 1,
    "hypervisorId": 1,
    "ipv4": 1,
    "storage": 20,
    "traffic": 20,
    "memory": 512,
    "cpuCores": 5,
    "networkSpeedInbound": 200,
    "networkSpeedOutbound": 400,
    "storageProfile": 1,
    "networkProfile": 1,
    "firewallRulesets": [
        1,
        2
    ],
    "hypervisorAssetGroups": [
        3,
        4
    ],
    "additionalStorage1Enable": true,
    "additionalStorage2Enable": false,
    "additionalStorage1Profile": 1,
    "additionalStorage2Profile": 2,
    "additionalStorage1Capacity": 10,
    "additionalStorage2Capacity": 20
}""".toRequestBody("application/json".toMediaType())
    val request = Request.Builder()
        .url("https://cp.domain.com/api/v1/servers?dryRun=false")
        .method("POST", body)
        .addHeader("Authorization", "Bearer <token>")
        .addHeader("Content-Type", "application/json")
        .build()
    val response = client.newCall(request).execute()
    println(response.body?.string()?.let(::println)) // Handle the response here
}
```

```csharp
using System;
using System.Net.Http;
using System.Net.Http.Headers;
using System.Text;

class Program
{
    static async Task Main(string[] args)
    {
        using var client = new HttpClient();
        var request = new HttpRequestMessage(HttpMethod.Post, "https://cp.domain.com/api/v1/servers?dryRun=false");
        request.Headers.Add("Authorization", "Bearer <token>");
        var content = new StringContent("""{
    "packageId": 1,
    "userId": 1,
    "hypervisorId": 1,
    "ipv4": 1,
    "storage": 20,
    "traffic": 20,
    "memory": 512,
    "cpuCores": 5,
    "networkSpeedInbound": 200,
    "networkSpeedOutbound": 400,
    "storageProfile": 1,
    "networkProfile": 1,
    "firewallRulesets": [
        1,
        2
    ],
    "hypervisorAssetGroups": [
        3,
        4
    ],
    "additionalStorage1Enable": true,
    "additionalStorage2Enable": false,
    "additionalStorage1Profile": 1,
    "additionalStorage2Profile": 2,
    "additionalStorage1Capacity": 10,
    "additionalStorage2Capacity": 20
}```
```

```text
HTTP/1.1 200 OK
Content-Type: application/json

{
  "status": "success",
  "message": "Server created successfully",
  "data": {
    "id": 1,
    "packageId": 1,
    "userId": 1,
    "hypervisorId": 1,
    "ipv4": 1,
    "storage": 20,
    "traffic": 20,
    "memory": 512,
    "cpuCores": 5,
    "networkSpeedInbound": 200,
    "networkSpeedOutbound": 400,
    "storageProfile": 1,
    "networkProfile": 1,
    "firewallRulesets": [1, 2],
    "hypervisorAssetGroups": [3, 4],
    "additionalStorage1Enable": true,
    
```

--------------------------------

### Create server backup with cURL, wget, and HTTPie

Source: https://docs.virtfusion.com/api/createServerBackupByServer

Command-line examples for creating a server backup via the Backup Manager endpoint. Use the Authorization header with a bearer token and Accept: application/json. The serverId is 1 in the URL.

```shell
curl --location --request POST 'https://cp.domain.com/api/v1/backupManager/backup/server/1' \
--header 'Authorization: Bearer <token>' \
--header 'Accept: application/json'
```

```shell
wget --quiet --output-document=- \
  --method=POST \
  --header='Authorization: Bearer <token>' \
  --header='Accept: application/json' \
  'https://cp.domain.com/api/v1/backupManager/backup/server/1'
```

```shell
http POST 'https://cp.domain.com/api/v1/backupManager/backup/server/1' \
  'Authorization: Bearer <token>' \
  'Accept: application/json'
```

--------------------------------

### GET /api/v1/servers/user/3 with Invoke-RestMethod

Source: https://docs.virtfusion.com/api/listUserServers

PowerShell example using Invoke-RestMethod to send a GET request to the user servers endpoint. Converts the response to JSON with a depth of 10.

```powershell
$headers = @{
    Authorization = "Bearer <token>"
    Accept        = "application/json"
}

$response = Invoke-RestMethod -Uri "https://cp.domain.com/api/v1/servers/user/3" -Method GET -Headers $headers
$response | ConvertTo-Json -Depth 10
```

--------------------------------

### libcurl GET request for hypervisor metrics

Source: https://docs.virtfusion.com/api/getHypervisorMetrics

C example using libcurl to send a GET request. Requires libcurl development headers. Sets custom headers for authorization and accept, and prints any error to stderr.

```c
#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/metrics");
    curl_easy_setopt(curl, CURLOPT_CUSTOMREQUEST, "GET");
    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;
}
```

--------------------------------

### GET /api/v1/connectivity/ipaudit

Source: https://docs.virtfusion.com/api/listIPAudit

This code snippet documents the GET endpoint for listing IP audit records. It includes the endpoint path, query parameter, and example request.

```APIDOC
## GET /api/v1/connectivity/ipaudit

### Description
Retrieves a paginated list of IP audit records. This endpoint is used to view IP audit information.

### Method
GET

### Endpoint
/api/v1/connectivity/ipaudit

### Parameters
#### Query Parameters
- **page** (integer) - Optional - The page number to retrieve.

### Request Example
```
GET https://cp.domain.com/api/v1/connectivity/ipaudit?page=1
```

### Response
#### Success Response (200)
Returns a list of IP audit records. The response structure is not detailed in the source.

#### Response Example
Not provided in the source.
```

--------------------------------

### Restart server with Go net/http

Source: https://docs.virtfusion.com/api/restartServer

Restart a server using Go's net/http package. The example creates a POST request with the required headers, sends it, and prints the response status and body. Errors cause a panic.

```go
package main

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

func main() {
    url := "https://cp.domain.com/api/v1/servers/69/power/restart"
    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))
}
```

--------------------------------

### PowerShell Invoke-RestMethod GET for hybrid migration destinations

Source: https://docs.virtfusion.com/api/listHybridMigrationDestinations

PowerShell example using Invoke-RestMethod to perform a GET request. Converts the response to JSON with depth 10.

```powershell
$headers = @{
    Authorization = "Bearer <token>"
    Accept        = "application/json"
}

$response = Invoke-RestMethod -Uri "https://cp.domain.com/api/v1/servers/1/migrate/hybrid/destinations?includeDisabled=false" -Method GET -Headers $headers
$response | ConvertTo-Json -Depth 10
```

--------------------------------

### GET /api/v1/servers/{serverId}/migrate/hybrid/destinations

Source: https://docs.virtfusion.com/api/listHybridMigrationDestinations

This snippet documents the GET endpoint for listing hybrid migration destinations for a server. It includes the endpoint path, parameters, and example request.

```APIDOC
## [GET] /api/v1/servers/{serverId}/migrate/hybrid/destinations

### Description
Retrieves the list of hybrid migration destinations for a specified server. The `includeDisabled` query parameter controls whether disabled destinations are included in the response.

### Method
GET

### Endpoint
`/api/v1/servers/{serverId}/migrate/hybrid/destinations`

### Parameters
#### Path Parameters
- **serverId** (integer) - Required - The ID of the server for which to list hybrid migration destinations.

#### Query Parameters
- **includeDisabled** (boolean) - Optional - When set to `false`, disabled destinations are excluded from the response. When `true`, disabled destinations are included.

### Request Example
```
GET https://cp.domain.com/api/v1/servers/1/migrate/hybrid/destinations?includeDisabled=false
```

### Response
#### Success Response (200)
- The response body contains the list of hybrid migration destinations in JSON format.

#### Response Example
```
{
  "destinations": [
    {
      "id": 1,
      "name": "Example Destination"
    }
  ]
}
```
```

--------------------------------

### GET resourcePack with Invoke-RestMethod

Source: https://docs.virtfusion.com/api/getResourcePack

PowerShell example using Invoke-RestMethod to GET the resourcePack endpoint. It sets the Authorization and Accept headers and converts the response to JSON with a depth of 10.

```powershell
$headers = @{
    Authorization = "Bearer <token>"
    Accept        = "application/json"
}

$response = Invoke-RestMethod -Uri "https://cp.domain.com/api/v1/selfService/resourcePack/1?withServers=true" -Method GET -Headers $headers
$response | ConvertTo-Json -Depth 10
```

--------------------------------

### Create Hypervisor Network with HttpClient and OkHttp (Java)

Source: https://docs.virtfusion.com/api/createHypervisorNetwork

Java examples for creating a hypervisor network. The HttpClient version uses java.net.http with a JSON body and Bearer token; the OkHttp version uses OkHttpClient with a RequestBody and executes the call synchronously. Both print the status code and response body.

```java
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());
    }
}
```

```java
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());
        }
    }
}
```

--------------------------------

### PHP cURL and Guzzle GET requests for hypervisor group resources

Source: https://docs.virtfusion.com/api/listHypervisorGroupResources

PHP request samples for listing hypervisor group resources. The cURL example uses curl_setopt_array with CURLOPT_CUSTOMREQUEST 'GET' and prints the raw response. The Guzzle example requires the Guzzle client via vendor/autoload.php and prints the status code and body.

```php
<?php

$curl = curl_init();

curl_setopt_array($curl, array(
    CURLOPT_URL => 'https://cp.domain.com/api/v1/compute/hypervisors/groups/1/resources?results=20&page=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 => 'GET',
    CURLOPT_HTTPHEADER => array(
        'Authorization: Bearer <token>',
        'Accept: application/json'
    ),
));

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

echo $response;
```

```php
<?php

require 'vendor/autoload.php';

use GuzzleHttp\Client;

$client = new Client();

$response = $client->request('GET', 'https://cp.domain.com/api/v1/compute/hypervisors/groups/1/resources?results=20&page=1', [
    'headers' => [
        'Authorization' => 'Bearer <token>',
        'Accept' => 'application/json',
    ],
]);

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

--------------------------------

### Python http.client example to resume migration

Source: https://docs.virtfusion.com/api/resumeLiveMigration

Python http.client example to POST to the resume migration endpoint. Requires a bearer token in the Authorization header.

```python
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({
    "altIPv4": "192.0.2.10",
})

conn.request("POST", "/api/v1/servers/1/migrate/live/resume", payload, headers)
response = conn.getresponse()

print(response.status)
print(json.loads(response.read()))
```

--------------------------------

### GET hypervisor asset with Go net/http

Source: https://docs.virtfusion.com/api/getHypervisorAsset

Go example using the net/http package to GET a hypervisor asset. It creates a request with the bearer token and Accept headers, performs the request, and prints the status code and response body.

```go
package main

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

func main() {
    url := "https://cp.domain.com/api/v1/servers/1/hypervisorAssets/1"
    req, _ := http.NewRequest("GET", 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))
}
```

--------------------------------

### PHP cURL request to GET /connect

Source: https://docs.virtfusion.com/api/testConnection

Use this PHP cURL example to test the connection. It sends a GET request with the bearer token and Accept header, then echoes the response.

```php
<?php

$curl = curl_init();

curl_setopt_array($curl, array(
    CURLOPT_URL => 'https://cp.domain.com/api/v1/connect',
    CURLOPT_RETURNTRANSFER => true,
    CURLOPT_ENCODING => '',
    CURLOPT_MAXREDIRS => 10,
    CURLOPT_TIMEOUT => 0,
    CURLOPT_FOLLOWLOCATION => true,
    CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
    CURLOPT_CUSTOMREQUEST => 'GET',
    CURLOPT_HTTPHEADER => array(
        'Authorization: Bearer <token>',
        'Accept: application/json'
    ),
));

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

echo $response;
```

--------------------------------

### Retrieve packages with cURL, wget, and HTTPie

Source: https://docs.virtfusion.com/api/listPackages

Command-line examples for retrieving packages. Use the Authorization header with a bearer token and Accept: application/json.

```shell
curl --location --request GET 'https://cp.domain.com/api/v1/packages' \
--header 'Authorization: Bearer <token>' \
--header 'Accept: application/json'
```

```shell
wget --quiet --output-document=- \
  --method=GET \
  --header='Authorization: Bearer <token>' \
  --header='Accept: application/json' \
  'https://cp.domain.com/api/v1/packages'
```

```shell
http GET 'https://cp.domain.com/api/v1/packages' \
  'Authorization: Bearer <token>' \
  'Accept: application/json'
```
Tokens:
Raw