VirtFusion Global API
  • Introduction
  • Schemas
  • Changelog
  • General
    • Test connectionGET
    • Retrieve the Control Server's status ●GET
  • Hypervisors
    • Networks
      • Retrieve a hypervisor's networks ●GET
      • Create a hypervisor network ●POST
      • Retrieve a hypervisor network ●GET
      • Update a hypervisor network ●PUT
      • Delete a hypervisor network ●DELETE
    • IP Blocks
      • Retrieve the IP blocks available on a hypervisor ●GET
      • Bind an IP block to a hypervisor ●POST
      • Set the IP block allocation order on a hypervisor ●PUT
      • Change the network an IP block uses on a hypervisor ●PUT
      • Unbind an IP block from a hypervisor ●DELETE
    • Retrieve hypervisorsGET
    • Retrieve a hypervisorGET
    • Update a hypervisor ●PUT
    • Retrieve metrics ●GET
    • Retrieve a hypervisor's storage points ●GET
  • Hypervisor Groups
    • Retrieve hypervisor groupsGET
    • Retrieve a hypervisor groupGET
    • Retrieve a hypervisor groups resourcesGET
  • Servers
    • Network
      • Firewall
        • Retrieve firewall rulesets ●GET
        • Retrieve a firewall ruleset ●GET
        • Disable firewallPOST
        • Enable firewallPOST
        • Retrieve firewallGET
        • Retrieve a server interface's firewall rules ●GET
        • Add a firewall rule to a server interface ●POST
        • Enable or disable a firewall rule ●PUT
        • Remove a firewall rule ●DELETE
        • Attach a firewall ruleset to a server interface ●POST
        • Apply a server interface's firewall rules now ●POST
      • Traffic
        • Retrieve a server's traffic blocksGET
        • Add a traffic block to a serverPOST
        • Remove a traffic block from a serverDELETE
        • Modify primary traffic allowancePUT
        • Retrieve a server's traffic statisticsGET
      • Add an address to the whitelistPOST
      • Remove an address from the whitelistDELETE
      • Add a quantity of IPv4 addressesPOST
      • Add an array of IPv4 addressesPOST
      • Remove an array of IPv4 addressesDELETE
      • Retrieve a server's network interfaces ●GET
      • Create a server interface ●POST
      • Retrieve a server interface ●GET
      • Update a server interface ●PUT
      • Attach IPv4 addresses to a server interface ●POST
      • Remove IPv4 addresses from a server interface ●DELETE
      • Set the order of a server interface's IPv4 addresses ●PUT
      • Attach an IPv6 subnet to a server interface ●POST
      • Remove IPv6 subnets from a server interface ●DELETE
      • Retrieve a server interface's VLANs ●GET
      • Add a VLAN to a server interface ●POST
      • Update a VLAN on a server interface ●PUT
      • Remove a VLAN from a server interface ●DELETE
    • Power
      • Boot a serverPOST
      • Shutdown a serverPOST
      • Restart a serverPOST
      • Power off a serverPOST
    • Backup Manager
      • Modify a server's Backup Manager accessPUT
      • Restore a server backup ●POST
      • Create a server backup ●POST
    • Migration
      • Hybrid
        • List destinations ●GET
        • Destination availability ●GET
        • Hybrid migration status ●GET
        • Start hybrid migration ●POST
        • Retry failed migration ●POST
        • Cancel failed hybrid migration ●POST
        • Complete migration ●POST
        • Revert migration ●POST
      • Live
        • Live migration status ●GET
        • Start live migration ●POST
        • Cancel failed live migration ●POST
        • Abort migration ●POST
        • Force cancel failed migration ●POST
        • Force data success ●POST
        • Resume migration ●POST
    • Hypervisor Assets
      • Assigned assets ●GET
      • Available assets ●GET
      • Asset details ●GET
      • Attach an asset ●POST
      • Detach an asset ●DELETE
      • Reorder assets ●PUT
    • Elevate
      • Retrieve a server's elevation ●GET
      • Elevate a server ●POST
      • Discard an elevation ●DELETE
      • Commit an elevated drive ●POST
    • Rescue
      • Retrieve a server's rescue state ●GET
      • Start a rescue session ●POST
      • End a rescue session ●DELETE
    • Media
      • Retrieve a server's ISO media ●GET
      • Mount an ISO on a server ●POST
      • Eject a server's ISO ●DELETE
    • Storage
      • Retrieve a server's disks ●GET
      • Add a disk to a server ●POST
      • Retrieve a server disk ●GET
      • Update a server disk ●PUT
      • Delete a server disk ●DELETE
      • Cancel a server disk's queued action ●DELETE
      • Modify storagePUT
    • Retrieve a serverGET
    • Delete a serverDELETE
    • Add, remove or modify a backup plan deprecatedPUT
    • Build a serverPOST
    • Change a server packagePUT
    • Retrieve serversGET
    • Create a serverPOST
    • Modify namePUT
    • Reset a server passwordPOST
    • Retrieve a user's serversGET
    • Retrieve OS templates available to a serverGET
    • Suspend a serverPOST
    • Throttle a server's CPUPUT
    • Unsuspend a serverPOST
    • Retrieve VNC detailsGET
    • Enable or disable VNCPOST
    • Change ownerPUT
    • Modify memoryPUT
    • Modify CPU coresPUT
    • Set custom XMLPOST
  • IP Blocks
    • Retrieve IPv4 from an IP block ●GET
    • Add IPv4 addresses to an IP blockPOST
    • Retrieve IP blocksGET
    • Create an IP block ●POST
    • Retrieve an IP blockGET
    • Update an IP block ●PUT
    • Delete an IP block ●DELETE
    • Retrieve the hypervisors an IP block is bound to ●GET
    • Retrieve IPv6 subnets from an IP block ●GET
    • Generate IPv6 subnets for an IP block ●POST
    • Delete a generated IPv6 subnet ●DELETE
    • Retrieve the IPv6 blacklist of an IP block ●GET
    • Blacklist an IPv6 subnet ●POST
    • Remove an IPv6 subnet from the blacklist ●DELETE
    • Retrieve IP block groups ●GET
    • Create an IP block group ●POST
    • Retrieve an IP block group ●GET
    • Rename an IP block group ●PUT
    • Delete an IP block group ●DELETE
    • Add an IP block to a group ●POST
    • Remove an IP block from a group ●DELETE
    • Retrieve the IP audit log ●GET
    • Export the IP audit log ●GET
    • Reserve/Unreserve an IPv4 address ●PUT
    • Set or clear the MAC address of an IPv4 address ●PUT
  • Reverse DNS
    • Set or clear the reverse DNS of an IPv4 address ●PUT
    • Set or clear the reverse DNS of an IPv6 address ●PUT
    • List reverse DNS zones ●GET
    • Rebuild a reverse DNS zone ●POST
  • Backup Manager
    • Retrieve backups ●GET
    • Create a server backup (Backup Manager path) ●POST
    • Restore a server backup (Backup Manager path) ●POST
    • Retrieve jobs ●GET
    • Retrieve a job ●GET
  • Backups (Deprecated)
    • Retrieve a server's backups deprecatedGET
  • DNS
    • Retrieve a DNS serviceGET
  • Media
    • Retrieve ISOs ●GET
    • Add an ISO to the library ●POST
    • Retrieve an ISOGET
    • Update an ISO ●PUT
    • Delete an ISO ●DELETE
    • Set the users an ISO is assigned to ●PUT
    • Retrieve operating system templates that are available for a packageGET
    • Retrieve templates ●GET
    • Retrieve a template ●GET
  • Packages
    • Retrieve packagesGET
    • Create a package ●POST
    • Retrieve a packageGET
    • Update a package ●PUT
    • Delete a package ●DELETE
    • Duplicate a package ●POST
  • Queue & Tasks
    • Retrieve a queue itemGET
  • SSH Keys
    • Add an SSH key to a user accountPOST
    • Retrieve an SSH keyGET
    • Delete an SSH key from a userDELETE
    • Retrieve a user's SSH keysGET
  • Users
    • External Rel ID & Rel Str
      • Retrieve a userGET
      • Modify a userPUT
      • Delete a userDELETE
      • Generate a set of login tokensPOST
      • Generate a set of login tokens using a server IDPOST
      • Change a user passwordPOST
    • Create a userPOST
  • Self Service
    • External Relational ID
      • Add credit to userPOST
      • Add an hourly group profile to a userPOST
      • Add a resource group profile to a userPOST
      • Add a resource pack to a userPOST
      • Retrieve hourly statisticsGET
      • Modify user accessPUT
      • Remove hourly group profile from a userDELETE
      • Remove resource group profile from a userDELETE
      • Generate a reportGET
      • Set an hourly resource packPUT
      • Retrieve a user's usageGET
    • Cancel credit that was applied to a userDELETE
    • Delete all servers attached to a pack IDDELETE
    • Retrieve a user resource packGET
    • Modify user resource packPUT
    • Delete a user resource packDELETE
    • Retrieve currenciesGET
    • Suspend all servers assigned to a resource packPOST
    • Unsuspend all servers assigned to a resource packPOST
  • PaginationSCHEMA
  • ErrorSCHEMA
  • ErrorMessageSCHEMA
  • ValidationErrorSCHEMA
  • QueueReferenceSCHEMA
  • BackupSCHEMA
  • BackupManagerJobSCHEMA
  • BackupManagerJobStartedSCHEMA
  • HypervisorSCHEMA
  • HypervisorSettingsSCHEMA
  • HypervisorUpdateSCHEMA
  • HypervisorNetworkSCHEMA
  • HypervisorNetworkSummarySCHEMA
  • HypervisorIPBlockSCHEMA
  • IPBlockHypervisorSCHEMA
  • HypervisorAssetSCHEMA
  • HypervisorGroupSCHEMA
  • HypervisorGroupResourcesSCHEMA
  • HypervisorMetricsSCHEMA
  • IPBlockSCHEMA
  • IPBlockCreateSCHEMA
  • IPBlockUpdateSCHEMA
  • IPv4PopulateResultSCHEMA
  • IPv6SubnetEntrySCHEMA
  • IPv6GenerateResultSCHEMA
  • IPBlockBlacklistEntrySCHEMA
  • IPBlockGroupSCHEMA
  • IPAuditEntrySCHEMA
  • ControlStatusSCHEMA
  • IPv4AddressSCHEMA
  • PackageSCHEMA
  • PackageVirtualizationSCHEMA
  • PackageAdditionalDiskSCHEMA
  • PackageSelfServiceSCHEMA
  • PackageVariableChoiceSCHEMA
  • PackageUpdateSCHEMA
  • PackageCreateSCHEMA
  • QueueItemSCHEMA
  • SSHKeySCHEMA
  • ServerSCHEMA
  • ServerSummarySCHEMA
  • ServerInterfaceSCHEMA
  • ServerInterfaceUpdateSCHEMA
  • ServerInterfaceVlanSCHEMA
  • ServerInterfaceIPv4SCHEMA
  • ServerInterfaceIPv6SCHEMA
  • FirewallRulesetsReplaceSCHEMA
  • FirewallRuleSCHEMA
  • FirewallRuleInputSCHEMA
  • FirewallRulesetSCHEMA
  • ServerElevateSCHEMA
  • ServerElevateStartSCHEMA
  • ServerRescueSCHEMA
  • ServerIsoSCHEMA
  • ServerIsoMountedSCHEMA
  • ServerIsoMountSCHEMA
  • ServerDiskSCHEMA
  • ServerDiskInputSCHEMA
  • ServerDiskUpdateSCHEMA
  • HypervisorStoragePointSCHEMA
  • TemplateSCHEMA
  • ISOSCHEMA
  • ISOUpdateSCHEMA
  • ISOCreateSCHEMA
  • ISOUsersSCHEMA
  • TemplateGroupSCHEMA
  • UserSCHEMA
No matches.
An API token is stored in this browser. It is written into the code samples and sent by Try it. Remove it when you are done, or on a shared computer.
Reference

General

Connectivity and token checks.

Endpoints

  • GETTest connection/connectCheck that the token is accepted. Returns an empty array when authentication succeeds, so it is a cheap way to verify credentials and connectivity.
  • GETRetrieve the Control Server's status ●/statusThe Control Server's own state: version, database, cache, scheduled tasks, cron and hypervisor alerts, with one overall flag. 503 when any check fails.
VirtFusion Global APIVersion 1.0.0