VirtFusion Global API
  1. Hypervisors
VirtFusion Global API
  • General
    • Test connection
      GET
  • Hypervisors
    • Retrieve hypervisors
      GET
    • Retrive a Hypervisor
      GET
  • Hypervisor Groups
    • Retrieve hypervisor groups
      GET
    • Retrieve a hypervisor group
      GET
    • Retrieve a hypervisor groups resources
      GET
  • Servers
    • Network
      • Firewall
        • Disable firewall
        • Enable firewall
        • Retrieve firewall
        • Apply firewall rulesets
      • Add an address to the whitelist
      • Remove an address from the whitelist
      • Add a quantity of IPv4 addresses
      • Add an array of IPv4 addresses
      • Remove an array of IPv4 addresses
    • Power
      • Boot a server
      • Shutdown a server
      • Restart a server
      • Poweroff a server
    • Traffic
      • Add a traffic block to a server
      • Remove a traffic block from a server
      • Retrieve a servers traffic blocks
    • Retrieve a server
      GET
    • Add, remove or modify a backup plan
      PUT
    • Build a server
      POST
    • Change a server package
      PUT
    • Create a server
      POST
    • Delete a server
      DELETE
    • Retrieve servers
      GET
    • Modify a server name
      PUT
    • Reset a server password
      POST
    • Retrieve a users servers
      GET
    • Retrieve OS templates available to a server
      GET
    • Suspend a server
      POST
    • Throttle a servers CPU
      PUT
    • Retrieve a servers traffic statistics
      GET
    • Unsuspend a server
      POST
    • Enable or disable VNC for a server
      POST
    • Change Owner
      PUT
    • Modify primary traffic allowance
      PUT
  • IP Blocks
    • Add an IPv4 range to an IP block
    • Retrieve IP blocks
    • Retrieve an IP block
  • Backups
    • Retrieve a server backups
  • DNS
    • Retrieve a DNS service
  • Media
    • Retrieve an ISO
    • Retrieve operating system templates that are available for a package
  • Packages
    • Retrieve packages
    • Retrieve a packge
  • Queue & Tasks
    • Retrieve a queue item
  • SSH Keys
    • Add an SSH key to a user account
    • Delete an SSH key from a user
    • Retrieve a users SSH keys
    • Retrieve an SSH key
  • Users
    • External Relational ID
      • Delete a user
      • Generate a set of login tokens
      • Generate a set of loging tokens using a server ID
      • Modify a user
      • Change a user passowrd
      • Retrieve a user
    • Create a user
  • Self Service
    • External Relational ID
      • Add credit to user
      • Add an hourly group profile to a user
      • Add a resource group profile to a user
      • Add a resource pack to a user
      • Retrieve hourly statistics
      • Modify user access
      • Remove hourly group profile from a user
      • Remove resource group from a user
      • Generate a report
      • Set an hourly resource pack
      • Retrieve a users usage
    • Cancel credit that was applied to a user
    • Delete all servers attached to a pack ID
    • Delete a user resource pack
    • Retrieve a user resource pack
    • Modify user resource pack
    • Retrieve currencies
    • Suspend all servers assigned to a reosurce pack
    • Unsuspend all servers assigned to a reosurce pack
  1. Hypervisors

Retrieve hypervisors

Developing
GET
/compute/hypervisors

Request

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

Request samples

Shell
JavaScript
Java
Swift
Go
PHP
Python
HTTP
C
C#
Objective-C
Ruby
OCaml
Dart
R
Request Request Example
Shell
JavaScript
Java
Swift
curl --location --request GET '/compute/hypervisors?results=20'

Responses

🟢200Success
application/json
Body

Example
{
    "current_page": 1,
    "data": [
        {
            "id": 1,
            "commissioned": 3,
            "ip": "192.168.4.10",
            "ipAlt": null,
            "hostname": null,
            "port": 8892,
            "sshPort": 22,
            "name": "PHV 1 (RED)",
            "maintenance": false,
            "enabled": 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"
            },
            "encryptedToken": "eyJpdiI6Ik1Ua29ZSGp0QThxWVZhellzL2VTU3c9PSIsInZhbHVlIjoiNzc1eGdMMzFPUFpFZVpIbytzMDc1NzRsUHRJVnFTWFpKWS9WamJIaVJVMVZkSFZjZVM1YVB3bnlQeGt4eEhVamhrWGF4SnNqQVFES010Y3owUmJneTR4a05oRkp1R08xVXI1eHcvQ3NsbW5qU0dpUWhZbnFUMWYrTHM5L2NoZmhUQm9nRnV4b2Y0dENGLy9vanVDMnkwTG1mNXBYM1JVcE5TNWRCSGkvZS9qVEFsSWx5WXdXOU1wajIwam1DV1d4aUNXMUNGMThFNXI5THM4VWFmYnRFNkx3VHFaV3o3M0VVaEZXSHo0TVdKc0xSemJYVExUWEVlZHM0ZVNoUkk0ZEI2QnAySlVESVU2R0JDcWJMeG9YRUhIM0Vad2w2VHNGcFQ3R1BkbU1TbzU3V2JzbEJFNlUvSW90eGxNZkdqRjVmMGx6TTRIWEttYVA0Ti9JQkEwQURrWTRPL2k4VFJsNjhFTHh3UW1wSGMzUkxibEtDeDdlK2tOekQxVkh0bzhsWXY1RkxxaWRkSFBEQlNvM1l2akxqNitickp1TzR0ekhTbmdVSG5VUE5tMGh1WFJuejhscFpSS2dLcE1ZaS9NUlRKdnNUS0wzYWlDYjB1MVJhcmk4OEJoZURNQ3JROE5WcTZTdzV0Si9UeDhwMTFLK3lZV0NDdzB5b2NBZFhsM0hYMDJPMHlXS1g1MmxhNWdrOTRTSDJHbWNvODNuOUswMHJpYTVBL0YwRW9BVndsMllIdW95ZjBhZXdLUTRSR0xBelBVekViTCtKaG8wSGxPR1NOWmNSaXpxQ1hBUVdsdE9HMUhtc2YrRU14WkhOaUVVeWhXRlB2amtRRXkxZjY0cm85ekxVYWE1QU5zdlJDK2N6YmZrNHNOWk4xSTZXbUhxYklLTmgraTZFWHM9IiwibWFjIjoiOTY2ZmJkNzJkNzZmNmZmYTQzM2U4NDQzMDdhYTAzOWZhNTM0M2I1MDQyYWUwYzQ1ZGIyZTRlOGEwM2M0MTRhYiIsInRhZyI6IiJ9",
            "maxServers": 0,
            "maxCpu": 4,
            "maxMemory": 6004,
            "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"
                }
            ],
            "storage": [],
            "created": "2024-03-12T22:37:15+00:00",
            "updated": "2024-05-10T11:27:52+00:00"
        },
        {
            "id": 2,
            "commissioned": 3,
            "ip": "192.168.4.9",
            "ipAlt": null,
            "hostname": null,
            "port": 8892,
            "sshPort": 22,
            "name": "PHV 2 (BLUE)",
            "maintenance": false,
            "enabled": 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"
            },
            "encryptedToken": "eyJpdiI6IjgyR2FZZmJwalVDYUxBR2hMdXdTNmc9PSIsInZhbHVlIjoiSFA1Tm44VzdZMUdZSXNZSTNUdmF5dGo5WjIrZEJlU04xQlVIOEZnUzc3dFZRY0ltc3pLdTZ2SFdkUXlQWUF5UEVaZUE3dXVKQXV6ajZvUTZiY0lBQmlnVllvRDZMSDBYK0ZMV0d5dzRTZlYwaDFRcllsNEdGaTljQnpnbEg5Umt6SmdBZ3ZQL0RneTZEUHhKanFGZU9hSWtvR29lYVlLdzk5NTJNZE1hbExSaWtuMkE4cTVaSGxSbWlJZ3pHejhFWnFxbEltNUcrSXVIdE4rQW9ET2R0M0MrK0RHOXNhOFFuVEw1R2k4eEpDNmZiNWJPVS9NL2xrVk40eG93NzQxaTRFN0pBR0FEL2JTclIvd2xWM3JkbnltZGhrc0xkUzV0SGtKNVoyU2JFY2M0S3dyVXEzS256b1ZHOVRvSWlmNm9OT0d6TktEWUduaVBHT2VHaFpqakU2SjFhU2lqTUZPeVdRN3dWSjhnakVQYkFiVmpCK05ja3BVU3FxakNjUUEzRHl3WUZweFJuQ0FBVkR2eTcxLzVVR2ZPNHU2bDJGRTJ6bVkrZ201akZXT0JIeHByK2VQVmMwUEJ5aDM0TWI0RmViakprM0phVXRVMFUvU1Y5M0FCRTBORm1aNWtGUklRbW51Y010NWIzUE02Vno3SkU2MVk4WTUwRy9QUndTZEgwWmRiLzhiV0w1c0ZsNkRMZkNycUlabWQrQ0F5cnYxamgxcWZjNjk3NXlMZHNMdnZqZkhKdG1sY2VLVmFPUTI3OTJ4UVdGLzF4SE83Y0N5dEhNNUhSQWhoZ29uUXMvR3dGeHVUMlRjc3dYZkVrYVVUMWZVQjhZOVRBT1RXYk84bFpqbGZ5RGQ2Rncvb2lQbVh0djBnSHUwSWJKbnAzQmQrL1VIK1JOK2N4NE09IiwibWFjIjoiNGUyNTIxYTIyNDBjZmRiYmEzNmQ5NTc4MGZmMTU4ZjgwN2Q2OTQzYzFhYTgxODVmYzkyMmU3YWNiOGRmNWZjZSIsInRhZyI6IiJ9",
            "maxServers": 0,
            "maxCpu": 28,
            "maxMemory": 10000,
            "networks": [
                {
                    "id": 2,
                    "type": "simpleBridge",
                    "bridge": "br0",
                    "primary": true,
                    "default": true,
                    "created": "2024-03-16T19:31:43+00:00",
                    "updated": "2024-03-16T19:32:46+00:00"
                }
            ],
            "storage": [],
            "created": "2024-03-16T19:31:43+00:00",
            "updated": "2024-04-26T16:41:51+00:00"
        },
        {
            "id": 3,
            "commissioned": 3,
            "ip": "192.168.4.12",
            "ipAlt": null,
            "hostname": null,
            "port": 8892,
            "sshPort": 22,
            "name": "BHV 9",
            "maintenance": false,
            "enabled": 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"
            },
            "encryptedToken": "eyJpdiI6IlZ6MFN4dnlvQm9DTXNsaDM3YWg1aUE9PSIsInZhbHVlIjoiamlrbEhzRlY5d0RRaUxMYkZIUEV2UHh5eVJVMHEwOGQ2QkVIS0tydW82Um15bGFPVHJQbmUzMDMvbGxyZkEyR0MwT1JUR3ZNaDUvZWE5UFYwOExOU2xKNDhUa2g5VnNqQ2NoamptNnp3dmY0VVhzSXEwTEsxWDRwMDdtMyttdmp2UVRHOFJsb3Q3VkpKWEw0N3JmelAxNWZGWTVRQ1lCWHFpM3N5anFnaDNlcVFWazV6ci9Fem9xQTYrYXpNeUw0a3Jobm85aFRweCsxQVNoOWJrVktveWczYm5CL3VyNVhqWHlFbEpRYUtINzhwMCtEN3N4aEEwdTQ0YzdSbVhqQk9BTDVkN3F0aDFHWngwQU1iNDJKT1BRT25LYjZacklPM1llL2hQRWJab1l5QVdTQUtiVkZXcXROZC9xOWxLdzROTUprRkUxWkNjY2l3TnIzYXk5YiswNkhIQTlKejI3YXhPc2xXRklETmtYRkNNWlIzT1RHZkZTVGMvY1lra2JaemNQcW8vUEFLbEROS3dJQkorSVNUeTJESzZtV2tUV0Q0Nk5QVWRvUnJUbWhkVFlwZmphNXZXanFUTi9SbnVacTJXUzhYZW8zby95RG9jVWJDT25UMHU3dVZSN1UrS3RxRFhlM3diYkhxL1g3OXZIdmwzUzhCZmpjN3ZpMkhlRlNSMmNPMzduektWRGpYOFQ2UktIQjdnaEVoZy95MmZYK0c1dTZOemZ0VXpxbHpneVlndkp0anNuN2Y4bXlScXhoWFQrai9yL2wrWWhLNGlGWGVhc09iSEQrRzYrOThCY1czUTdnd0pOTFdSZ05uNUU5QUZPVmtHOENBRDljOFN1UjBteUdacmZYZWdtM2RodXg4dEx5cExGZVZ0TTNrQTVVTFlTZU0vZ28xLzA9IiwibWFjIjoiNzdmZTc5MDI2NjY3OTc2NzhmMjJiMWY3ZGNjNGI4YmNkZTNiNzE0MmNlODdkYzNlNzIxNDU5NmVlMjJmODNhYSIsInRhZyI6IiJ9",
            "maxServers": 0,
            "maxCpu": 64,
            "maxMemory": 27913,
            "networks": [
                {
                    "id": 3,
                    "type": "simpleBridge",
                    "bridge": "br0",
                    "primary": true,
                    "default": true,
                    "created": "2024-03-29T20:10:22+00:00",
                    "updated": "2024-04-09T11:32:14+00:00"
                }
            ],
            "storage": [],
            "created": "2024-03-29T20:10:22+00:00",
            "updated": "2024-04-16T10:44:21+00:00"
        },
        {
            "id": 4,
            "commissioned": 3,
            "ip": "192.168.4.11",
            "ipAlt": null,
            "hostname": null,
            "port": 8892,
            "sshPort": 22,
            "name": "BHV 8",
            "maintenance": false,
            "enabled": 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"
            },
            "encryptedToken": "eyJpdiI6ImpjS3JqNWhlOHl6Rm5RUk80WkRVQkE9PSIsInZhbHVlIjoiUXNSVEhXMWhJM2hrZ2gza3hBVGtQUjJMenp4bThNL2d0ajYyUGNTQ2s2TjMxZEZ3ZVJVYzQxbUhjSXZMd2greWY5MEl3ajFLK3RrL1BpSzdZbCtzRkpObisvNktxanpZZzBORFpHRUdnN2t3cmN2YXJBbnhQbWRkQ0FUVkozQTVwanlYZHJxVlF2Y3VBOWVBb21FdytUT3Z0cUdrMTU0V3YxM0w1VUh2NER4VkpESngvK0kwNmp6eHFVSDloSWxEd2t4aHV4UnM2c1kyRFRjTDJ5TXJ0dFZPRjZNL3YxKzFpODlzRHFtak5PRm1pVDFBdHJwNGhqNEZiV05Fd1c2OWlkeWxuTWdUT1Z1STE4MjFIMnBoaDA1WWhmSitFMFdnZGdqZ0lZSlBzODd5Y3hDVzNCYWFwSHlHV1hDU0lXZDJKS3RsYWN4VU9EUmJqeTM3Vy9RSXFKTGxkRnZlMnhjWm5mekRrd0VZVjEzeVFhMDFGazJKbXNOVTdCUzdTcW9PbzFsdkEzZE9nK0k4dW5ndXB6OTJDbUFWZk5hU1JveExMSGFzMnNsQzFUSzRDSHVaQkkvR2JseFFwT1BDTWcvZjlqaU5IdDJPMnRTRjJrVmxuYjJzeDRBT2NTNjl5V2hVc3c3UC9ucG11UFozZjErOFovcXVZQlJHSkt0RWJrcVFvY2NyMDdDZ0JFOE5SVklJa0loSVIvSStwVWh6b0twV1NLT0tOaXF3N1EvQkJUTmhYRit3eFR2VGxMc3NMSDVSUWtyMlZCck43ZkFYVXMrVEpoVXhHSVJlN2pMOENnL1R4SzVIeHkrWkVWKzlhRmN5RWdmK1IzaGpJZ0VtbUMvTzJvRnI2TW93RmpyNXlITXB3TGpteGZ6NmZpUEh4NlNVMytsd0hsS0kxRDA9IiwibWFjIjoiNWFkMTQ4YmQ1MGJjMTE3N2QzN2JhOGJkOTM1NzBlNjIzYjFkM2UyMjkxYjI3OWJmMTkxMmVmYjcxNzEwZTNkNCIsInRhZyI6IiJ9",
            "maxServers": 0,
            "maxCpu": 16,
            "maxMemory": 27913,
            "networks": [
                {
                    "id": 4,
                    "type": "macVTap",
                    "bridge": "eth0",
                    "primary": true,
                    "default": true,
                    "created": "2024-03-29T20:10:42+00:00",
                    "updated": "2024-03-29T20:10:42+00:00"
                }
            ],
            "storage": [],
            "created": "2024-03-29T20:10:42+00:00",
            "updated": "2024-04-16T10:44:21+00:00"
        },
        {
            "id": 6,
            "commissioned": 3,
            "ip": "192.168.4.2",
            "ipAlt": "123.123.123.121",
            "hostname": null,
            "port": 8892,
            "sshPort": 22,
            "name": "BHV 1",
            "maintenance": false,
            "enabled": true,
            "nfType": 4,
            "group": {
                "id": 2,
                "name": "Test",
                "description": null,
                "default": false,
                "enabled": true,
                "distributionType": 13,
                "created": "2024-10-08T13:23:28+00:00",
                "updated": "2024-10-08T13:23:42+00:00"
            },
            "encryptedToken": "eyJpdiI6ImQ0M1hybkc5bDJaQ2IrakJFUGZ0MEE9PSIsInZhbHVlIjoiNW1ETjRDeGMxZDlDOWx3M1ZmRkFBZG84dGRwbEZVRVlwc0JJT202UXhHekJ0cS9wNWpIUjJiUzJhaG0ySCs4aHpLakF2RnNJTjVPZ09hN0ttcEg4bkJrdjRqd2pxNHlPcTBaNnBDZ2VwTllUNzNnRTdBUlVHM245VDVhWkxhYkZ5MnRmQXZJMjZkQWxkV3BmbVdZNWt0clR2UlNGTEZES0kzaksyd2xmZFJITlRRMU0yUkp2WkNRU0lYUlRkWWF3NWxxY1cyUFo1WFByczZIak4wMnl4VmdSbUs0b0RjVWNacmZmcDM1VTgyWlo1OGYydnBXVGNOdHZIRXA3YnNIZFIzTXJiUmorcVExc216R3VyeTQ0U2JTeDZZbzlBcHN2MFNyczlNZGZPM1M5K2FuUVQrNVc1UHVuTEZUSC8yMi9FWHVOYUphblNPVnZsQ2RhVGdrSE5zczlyTEF6QTM5cTBrci8yRy9DM204NWJxOUZBZjdhTmRFZnc1UWcwVUM1L3dveGpvb2tleEd2eVF0amlSN2VRYzdlS3kzQUtMRVk2WkFma25aVjN5OWRURDZFN3JnWU5UVDRkTjRWc0Rib1JIdXAwSlZQTVViWHJTNlIrbFBvb1M0MHVOOEU4VGlBdGZ4dVI0V1BwS3dnempYSC94bmRXdHdET2FEUGZHVXptNzFQQjM3UnRwbWtSQW1wY2xscGxTTmRvZzJpQ0pEWXdoYWRGTk03aytWbGJyVUh3ZGliVWN1NGVEM1lRNjFVV3oxYkNOL0NJUFUycVlQQ212S0NsYitIK2p5QkxwdUk2bk4vL0l6QktraCtqR2lnYkYzNU1IazBPVG42RGlCVkVBV2JKcGI4My9lNDl4N29vQUNJempjaGtlQU1tVWlHZDBDUFkwVU1lTmM9IiwibWFjIjoiMTk1MWEwNGQyYzdiOGM5ZTQ4NDBjZWI2N2JjYTJjYmFhNThhOGUyMDE1MTdiZDdmN2E2YjE4MjZmZjk1OTcxYiIsInRhZyI6IiJ9",
            "maxServers": 0,
            "maxCpu": 128,
            "maxMemory": 29419,
            "networks": [
                {
                    "id": 6,
                    "type": "simpleBridge",
                    "bridge": "br0",
                    "primary": true,
                    "default": true,
                    "created": "2024-03-30T09:53:38+00:00",
                    "updated": "2025-01-15T13:31:56+00:00"
                },
                {
                    "id": 17,
                    "type": "lvBridgeOVS",
                    "bridge": "bhv1",
                    "primary": false,
                    "default": false,
                    "created": "2024-05-17T11:25:57+00:00",
                    "updated": "2024-05-17T11:25:57+00:00"
                }
            ],
            "storage": [],
            "created": "2024-03-30T09:53:38+00:00",
            "updated": "2024-12-06T21:25:54+00:00"
        }
    ],
    "first_page_url": "https://192.168.3.11/api/v1/compute/hypervisors?results=5&page=1",
    "from": 1,
    "last_page": 3,
    "last_page_url": "https://192.168.3.11/api/v1/compute/hypervisors?results=5&page=3",
    "links": [
        {
            "url": null,
            "label": "« Previous",
            "active": false
        },
        {
            "url": "https://192.168.3.11/api/v1/compute/hypervisors?results=5&page=1",
            "label": "1",
            "active": true
        },
        {
            "url": "https://192.168.3.11/api/v1/compute/hypervisors?results=5&page=2",
            "label": "2",
            "active": false
        },
        {
            "url": "https://192.168.3.11/api/v1/compute/hypervisors?results=5&page=3",
            "label": "3",
            "active": false
        },
        {
            "url": "https://192.168.3.11/api/v1/compute/hypervisors?results=5&page=2",
            "label": "Next »",
            "active": false
        }
    ],
    "next_page_url": "https://192.168.3.11/api/v1/compute/hypervisors?results=5&page=2",
    "path": "https://192.168.3.11/api/v1/compute/hypervisors",
    "per_page": 5,
    "prev_page_url": null,
    "to": 5,
    "total": 14
}
🟠401401
Modified at 2025-01-20 21:49:10
Previous
Test connection
Next
Retrive a Hypervisor
Built with