VirtFusion Global API
  1. Servers
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. Servers

Retrieve servers

Developing
GET
/servers

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 '/servers?type=simple&results=20&hypervisorId'

Responses

🟢200Success
application/json
Body

Example
{
    "current_page": 1,
    "data": [
        {
            "id": 5,
            "uuid": "1fb4b391-b360-40e7-8fe1-5b024c7508ac",
            "name": "Avaricious Trade",
            "commissioned": 3,
            "owner": 1,
            "hypervisorId": 7,
            "suspended": false,
            "protected": false,
            "updated": "2024-04-02T10:15:10+00:00",
            "created": "2024-03-30T14:41:27+00:00"
        },
        {
            "id": 8,
            "uuid": "82c37680-bf8f-4712-854f-31428933703f",
            "name": "PDNS",
            "commissioned": 3,
            "owner": 1,
            "hypervisorId": 3,
            "suspended": false,
            "protected": false,
            "updated": "2024-04-13T22:02:04+00:00",
            "created": "2024-04-09T11:33:43+00:00"
        },
        {
            "id": 9,
            "uuid": "5de5a89b-b707-41bf-a051-7af1a4e67795",
            "name": "server 1",
            "commissioned": 2,
            "owner": 3,
            "hypervisorId": 6,
            "suspended": false,
            "protected": false,
            "updated": "2025-01-20T14:13:50+00:00",
            "created": "2024-04-11T17:22:19+00:00"
        },
        {
            "id": 10,
            "uuid": "71178184-7554-406f-80b8-0c1d7ffcfd49",
            "name": "Respectful Exit",
            "commissioned": 3,
            "owner": 1,
            "hypervisorId": 6,
            "suspended": false,
            "protected": false,
            "updated": "2024-05-13T08:16:00+00:00",
            "created": "2024-04-23T11:50:58+00:00"
        },
        {
            "id": 11,
            "uuid": "ffed8ddb-c758-41ff-8380-abb1377dfb38",
            "name": "Ubuntu Test",
            "commissioned": 0,
            "owner": 1,
            "hypervisorId": 7,
            "suspended": false,
            "protected": false,
            "updated": "2024-05-02T18:33:20+00:00",
            "created": "2024-04-25T20:18:57+00:00"
        },
        {
            "id": 19,
            "uuid": "c77ce40f-0226-43ca-b000-c9b7fe143dc7",
            "name": "Metallic National",
            "commissioned": 3,
            "owner": 1,
            "hypervisorId": 2,
            "suspended": false,
            "protected": false,
            "updated": "2024-05-02T18:34:27+00:00",
            "created": "2024-05-02T10:36:37+00:00"
        },
        {
            "id": 20,
            "uuid": "785aaddd-b08b-448b-9486-baf29cd3c0f8",
            "name": "Rubbery Daughter",
            "commissioned": 3,
            "owner": 1,
            "hypervisorId": 7,
            "suspended": false,
            "protected": false,
            "updated": "2024-10-07T21:32:34+00:00",
            "created": "2024-05-03T10:05:41+00:00"
        },
        {
            "id": 22,
            "uuid": "5a7e3d49-0fdf-4cfa-bb14-864f3ca0e79a",
            "name": "Frightening Clock",
            "commissioned": 3,
            "owner": 1,
            "hypervisorId": 7,
            "suspended": false,
            "protected": false,
            "updated": "2024-06-08T08:30:15+00:00",
            "created": "2024-05-03T10:35:36+00:00"
        },
        {
            "id": 23,
            "uuid": "b1f6efb6-22a1-4d0a-b043-17d0ccfce4b2",
            "name": "Backup Test",
            "commissioned": 3,
            "owner": 1,
            "hypervisorId": 6,
            "suspended": false,
            "protected": false,
            "updated": "2024-05-14T15:29:37+00:00",
            "created": "2024-05-04T07:30:10+00:00"
        },
        {
            "id": 26,
            "uuid": "5c681c72-6828-4fa3-8011-ced2502384e6",
            "name": "Ceph Test 1",
            "commissioned": 3,
            "owner": 1,
            "hypervisorId": 13,
            "suspended": false,
            "protected": false,
            "updated": "2024-05-14T11:42:08+00:00",
            "created": "2024-05-14T10:57:56+00:00"
        },
        {
            "id": 27,
            "uuid": "8cb75e06-caae-47f5-9bf2-3ea1d341d10e",
            "name": "OVS BHV 6",
            "commissioned": 3,
            "owner": 1,
            "hypervisorId": 11,
            "suspended": false,
            "protected": false,
            "updated": "2024-05-17T13:25:10+00:00",
            "created": "2024-05-16T16:56:12+00:00"
        },
        {
            "id": 28,
            "uuid": "3a63170a-2350-422d-8cfb-449ed6940414",
            "name": "OVS BHV 7",
            "commissioned": 3,
            "owner": 1,
            "hypervisorId": 12,
            "suspended": false,
            "protected": false,
            "updated": "2024-05-17T13:25:04+00:00",
            "created": "2024-05-16T18:13:44+00:00"
        },
        {
            "id": 29,
            "uuid": "f24aebac-016c-4139-afcf-5dbfeda54fc8",
            "name": "OVS BHV 1",
            "commissioned": 3,
            "owner": 1,
            "hypervisorId": 6,
            "suspended": false,
            "protected": false,
            "updated": "2024-05-17T13:25:00+00:00",
            "created": "2024-05-17T11:25:13+00:00"
        },
        {
            "id": 30,
            "uuid": "67486d4d-d974-45c3-a680-980bc84635d8",
            "name": "Test 10",
            "commissioned": 3,
            "owner": 1,
            "hypervisorId": 1,
            "suspended": false,
            "protected": false,
            "updated": "2024-06-07T16:41:45+00:00",
            "created": "2024-06-07T12:03:00+00:00"
        },
        {
            "id": 36,
            "uuid": "a3df9e3c-893e-4f42-ad90-cf34df155589",
            "name": "Frail Text",
            "commissioned": 3,
            "owner": 1,
            "hypervisorId": 13,
            "suspended": false,
            "protected": false,
            "updated": "2024-06-28T21:25:57+00:00",
            "created": "2024-06-28T13:39:55+00:00"
        },
        {
            "id": 37,
            "uuid": "a3b2e9f8-9b5c-44a3-bcb6-bbadf9bd83e2",
            "name": "Stark Brown",
            "commissioned": 3,
            "owner": 1,
            "hypervisorId": 13,
            "suspended": false,
            "protected": false,
            "updated": "2024-08-23T20:15:25+00:00",
            "created": "2024-06-28T21:36:23+00:00"
        },
        {
            "id": 38,
            "uuid": "8c6f63d1-ec53-4e1a-a52f-d50f03b05c70",
            "name": "",
            "commissioned": 0,
            "owner": 1,
            "hypervisorId": 14,
            "suspended": false,
            "protected": false,
            "updated": "2024-08-23T20:17:42+00:00",
            "created": "2024-08-23T20:17:42+00:00"
        },
        {
            "id": 39,
            "uuid": "539bff72-f6cd-4260-96f1-b7523fd890c5",
            "name": "Thorny Impression",
            "commissioned": 3,
            "owner": 1,
            "hypervisorId": 14,
            "suspended": false,
            "protected": false,
            "updated": "2024-08-23T20:20:32+00:00",
            "created": "2024-08-23T20:18:39+00:00"
        },
        {
            "id": 40,
            "uuid": "ce445459-c716-4f88-a7c6-a0ffd29eb9b2",
            "name": "Present Charge",
            "commissioned": 2,
            "owner": 1,
            "hypervisorId": 14,
            "suspended": false,
            "protected": false,
            "updated": "2024-08-23T20:57:22+00:00",
            "created": "2024-08-23T20:56:04+00:00"
        },
        {
            "id": 41,
            "uuid": "6fce272f-c6ea-45bd-bf24-d4d357d9a788",
            "name": "CP Test",
            "commissioned": 3,
            "owner": 1,
            "hypervisorId": 13,
            "suspended": false,
            "protected": false,
            "updated": "2024-08-27T11:10:48+00:00",
            "created": "2024-08-27T11:09:54+00:00"
        }
    ],
    "first_page_url": "https://192.168.3.11/api/v1/servers?page=1",
    "from": 1,
    "last_page": 2,
    "last_page_url": "https://192.168.3.11/api/v1/servers?page=2",
    "links": [
        {
            "url": null,
            "label": "« Previous",
            "active": false
        },
        {
            "url": "https://192.168.3.11/api/v1/servers?page=1",
            "label": "1",
            "active": true
        },
        {
            "url": "https://192.168.3.11/api/v1/servers?page=2",
            "label": "2",
            "active": false
        },
        {
            "url": "https://192.168.3.11/api/v1/servers?page=2",
            "label": "Next »",
            "active": false
        }
    ],
    "next_page_url": "https://192.168.3.11/api/v1/servers?page=2",
    "path": "https://192.168.3.11/api/v1/servers",
    "per_page": 20,
    "prev_page_url": null,
    "to": 20,
    "total": 27
}
🟠401401
Modified at 2025-01-20 21:49:10
Previous
Delete a server
Next
Modify a server name
Built with