- General
- Hypervisors
- Hypervisor Groups
- Servers
- Network
- Power
- Traffic
- Retrieve a serverGET
- Add, remove or modify a backup planPUT
- Build a serverPOST
- Change a server packagePUT
- Create a serverPOST
- Delete a serverDELETE
- Retrieve serversGET
- Modify a server namePUT
- Reset a server passwordPOST
- Retrieve a users serversGET
- Retrieve OS templates available to a serverGET
- Suspend a serverPOST
- Throttle a servers CPUPUT
- Retrieve a servers traffic statisticsGET
- Unsuspend a serverPOST
- Enable or disable VNC for a serverPOST
- Change OwnerPUT
- Modify primary traffic allowancePUT
- IP Blocks
- Backups
- DNS
- Media
- Packages
- Queue & Tasks
- SSH Keys
- Users
- 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
- External Relational ID
Retrieve a server
Developing
GET
/servers/{serverId}
Request
Authorization
Provide your bearer token in the
Authorization
header when making requests to protected resources.Example:
Authorization: Bearer ********************Path Params
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/1?remoteState=false'Responses
🟢200OK
application/json
Body
Example
{
"data": {
"id": 69,
"ownerId": 1,
"hypervisorId": 6,
"arch": 1,
"name": "Elliptical Way",
"selfService": 0,
"selfServiceSettings": [],
"hostname": null,
"commissionStatus": 3,
"uuid": "b9fd9092-7200-4a24-96d4-76aedd664274",
"state": "complete",
"migratable": true,
"timezone": "_default",
"migrateLevel": 0,
"deleteLevel": 0,
"configLevel": 0,
"backupLevel": 0,
"elevated": false,
"elevateId": null,
"elevate": false,
"destroyable": true,
"rebuild": false,
"suspended": false,
"protected": false,
"buildFailed": false,
"primaryNetworkDhcp4": false,
"primaryNetworkDhcp6": false,
"built": "2025-01-15T15:00:49+00:00",
"created": "2024-12-06T21:25:58+00:00",
"updated": "2025-01-15T23:17:49+00:00",
"traffic": {
"public": {
"countMethod": 1,
"currentPeriod": {
"start": "2025-01-06T00:00:00.000000Z",
"end": "2025-02-05T23:59:59.999999Z",
"limit": 20000
}
}
},
"settings": {
"osTemplateInstall": true,
"osTemplateInstallId": 49,
"encryptedPassword": "eyJpdiI6IkNtT0ZmUEQ4Q2ZuNW5yUWVXZUcvWWc9PSIsInZhbHVlIjoibHJmMTNHZXpqV3lneFUrZEZ3eThSWEZVbVk5TDlBYTJQbXpPbFRvcmd0OD0iLCJtYWMiOiI1NTNhMGVmNzBlZWViZWI3NjkyMmYzYmM3NWFjMDY3ZTlmZmE4ZDE3NDI2YzliMjY0ODM4YzQzMDViMWY3MTI1IiwidGFnIjoiIn0=",
"backupPlan": null,
"uefi": false,
"uefiType": 0,
"cloudInit": true,
"cloudInitType": 1,
"config": {
"cloud.init": {
"on.network": {
"netplan_routes_v4": true,
"netplan_routes_v6": true
},
"on.network.libvirtrouted": {
"netplan_routes_v4": true,
"netplan_routes_v6": true
},
"on.all": {
"user.data": {
"runcmd": [
"DEBIAN_FRONTEND=noninteractive /usr/bin/apt-get --option=Dpkg::Options::=--force-confold --option=Dpkg::options::=--force-unsafe-io --assume-yes --quiet update",
"DEBIAN_FRONTEND=noninteractive /usr/bin/apt-get --option=Dpkg::Options::=--force-confold --option=Dpkg::options::=--force-unsafe-io --assume-yes --quiet install qemu-guest-agent",
"/usr/bin/systemctl enable qemu-guest-agent",
"/usr/bin/systemctl start qemu-guest-agent",
"DEBIAN_FRONTEND=noninteractive /usr/bin/apt-get --option=Dpkg::Options::=--force-confold --option=Dpkg::options::=--force-unsafe-io --assume-yes --quiet dist-upgrade"
]
}
},
"on.password": {
"user.data": {
"runcmd": [
"/usr/bin/sed -i \"s/#PermitRootLogin prohibit-password/PermitRootLogin yes/g\" /etc/ssh/sshd_config",
"/usr/bin/sed -i \"s/PasswordAuthentication no/PasswordAuthentication yes/g\" /etc/ssh/sshd_config",
"/usr/bin/systemctl restart sshd"
]
}
},
"on.sshkey": {
"user.data": []
}
}
},
"userConfig": [],
"bootOrder": [
"hd",
"cdrom"
],
"tpmType": 0,
"networkBoot": false,
"bootMenu": 1,
"customISO": 1,
"securityDriver": 3,
"memBalloon": {
"model": 1,
"autoDeflate": 0,
"freePageReporting": 0
},
"hyperv": {
"enabled": false,
"passthrough": false,
"relaxed": 0,
"vapic": 0,
"spinlocks": 0,
"vpindex": 0,
"runtime": 0,
"synic": 0,
"stimer": 0,
"reset": 0,
"vendorId": 0,
"frequencies": 0,
"reenlightenment": 0,
"tlbflush": 0,
"ipi": 0,
"evmcs": 0,
"vendorIdValue": "KVM VM",
"spinlocksValue": 8191,
"clockEnabled": 0
},
"extended": {
"cpuFlags": {
"topoext": "1",
"svm": "1",
"vmx": "1"
}
},
"machineType": "inherit",
"pciPorts": 16,
"resources": {
"memory": 1024,
"storage": 11,
"traffic": 20000,
"cpuCores": 2
}
},
"cpu": {
"cores": 2,
"type": "inherit",
"typeExact": "host-model",
"shares": 1024,
"throttle": 0,
"topology": {
"enabled": false,
"sockets": 1,
"cores": 1,
"threads": 1,
"dies": 1
}
},
"customXML": {
"domain": {
"xml": "",
"enabled": false
},
"os": {
"xml": "",
"enabled": false
},
"devices": {
"xml": "",
"enabled": false
},
"features": {
"xml": "",
"enabled": false
},
"clock": {
"xml": "",
"enabled": false
},
"cpuTune": {
"xml": "",
"enabled": false
}
},
"qemuCommandline": [],
"qemuAgent": {
"os": {
"screen": "iVBORw0KGgoAAAANSUhEUgAAAJYAAABTCAAAAABYT6E5AAAABGdBTUEAALGPC/xhBQAAACBjSFJNAAB6JgAAgIQAAPoAAACA6AAAdTAAAOpgAAA6mAAAF3CculE8AAAAAmJLR0QA/4ePzL8AAAAHdElNRQfpARESACl1ShbSAAAB0klEQVRo3u3VS2/TQBAA4NlZr9eP+N04DmmKqxZFBQRC6oX/wN9G4s6l0ENFKQQoSVw7deT4xaFpRTkgkNKIivksreWd9e5oVqsFIH+N/UmUrdrrz9//tMaMxK8rSaEgAICGGnAAuGpAv+sy8f3wUYnBttibW2Wz33X9qfayOJhVXvydx8nzYLDMjcfZTrZTdH1tlHXxQbWXx1PhGD23lYVymD7LDHt7st7SKWGlxSguWRvtvq70yWjqST8YnmilCxB9GzdD8zwcnZrClKGZIna81jzMpWE97OfKWH0DArj24shac7VYlJuJNy9qgd4ZDOczYaXmhcLNeXQKgyJBP80VN40mbmp1vixYkMu5lXU/gK1Vjc+PwVwY1dNj++Ndb+u/ga0eAAbXr1UA2E0XA3Z18m4N/3mW/0UkIu4Aoio6jAP05E3EtRGYcJABbjgn5dVRrTpJ6G0t+btIme1e5IbNB2VwVn8qpB4Xvfe6G791TjabFla5Y1iG7etfz3WXMVW1jGU7kBKeMDBs4H1w1c9qteFqMdaqDTZc1AtE1mDVqnUN2HC+NW5FC20/Kctmw0ndQ7fuZ0IIIYQQQgghhBBCCCGEEEIIIYQQQgghhNwTPwDlF4AYGPA7/gAAACV0RVh0ZGF0ZTpjcmVhdGUAMjAyNS0wMS0xN1QxODowMDo0MSswMDowMA+ZFQkAAAAldEVYdGRhdGU6bW9kaWZ5ADIwMjUtMDEtMTdUMTg6MDA6NDErMDA6MDB+xK21AAAAAElFTkSuQmCC"
}
},
"media": {
"isoMounted": false,
"isoType": "local",
"isoName": "",
"isoFilename": "",
"isoUrl": "",
"isoDownload": false
},
"backupPlan": {
"id": null,
"name": null
},
"vnc": {
"ip": "192.168.4.2",
"port": 5903,
"enabled": false
},
"network": {
"interfaces": [
{
"id": 69,
"order": 1,
"enabled": true,
"tag": 4618706442,
"name": "ens3",
"type": "public",
"driver": 1,
"processQueues": null,
"mac": "00:E7:FB:01:87:14",
"ipv4ToMac": null,
"ipv6ToMac": null,
"inTrafficCount": true,
"outTrafficCount": false,
"inAverage": 0,
"inPeak": 0,
"inBurst": 0,
"outAverage": 0,
"outPeak": 0,
"outBurst": 0,
"ipFilter": false,
"vlans": [],
"ipFilterType": null,
"portIsolated": false,
"ipv4_resolver_1": 1,
"ipv4_resolver_2": 2,
"ipv6_resolver_1": 1,
"ipv6_resolver_2": 2,
"networkProfile": 0,
"dhcpV4": 0,
"dhcpV6": 0,
"firewallEnabled": false,
"hypervisorNetwork": 6,
"isNat": false,
"nat": false,
"firewall": [],
"hypervisorConnectivity": {
"id": 6,
"type": "simpleBridge",
"bridge": "br0",
"mtu": null,
"primary": true,
"default": true
},
"ipWhitelist": [],
"actions": [],
"ipv4": [
{
"id": 33,
"order": 1,
"enabled": true,
"blockId": 1,
"address": "192.168.4.32",
"gateway": "192.168.4.1",
"netmask": "255.255.254.0",
"resolver1": "8.8.8.8",
"resolver2": "8.8.4.4",
"rdns": null,
"mac": null
},
{
"id": 36,
"order": 2,
"enabled": true,
"blockId": 1,
"address": "192.168.4.35",
"gateway": "192.168.4.1",
"netmask": "255.255.254.0",
"resolver1": "8.8.8.8",
"resolver2": "8.8.4.4",
"rdns": null,
"mac": null
}
],
"ipv6": [
{
"id": 502,
"block": {
"id": 5,
"name": "V6 For BHV 1,3"
},
"order": 1,
"enabled": true,
"addresses": [],
"addressesDetailed": [],
"subnet": "2001:db8:abcd:12:2::",
"cidr": 80,
"exhausted": false,
"gateway": "2001:db8:abcd:12::1",
"resolver1": "2001:4860:4860::8888",
"resolver2": "2001:4860:4860::8844",
"routeNet": false
},
{
"id": 505,
"block": {
"id": 5,
"name": "V6 For BHV 1,3"
},
"order": 1,
"enabled": true,
"addresses": [],
"addressesDetailed": [],
"subnet": "2001:db8:abcd:12:5::",
"cidr": 80,
"exhausted": false,
"gateway": "2001:db8:abcd:12::1",
"resolver1": "2001:4860:4860::8888",
"resolver2": "2001:4860:4860::8844",
"routeNet": false
},
{
"id": 506,
"block": {
"id": 5,
"name": "V6 For BHV 1,3"
},
"order": 1,
"enabled": true,
"addresses": [],
"addressesDetailed": [],
"subnet": "2001:db8:abcd:12:6::",
"cidr": 80,
"exhausted": false,
"gateway": "2001:db8:abcd:12::1",
"resolver1": "2001:4860:4860::8888",
"resolver2": "2001:4860:4860::8844",
"routeNet": false
},
{
"id": 507,
"block": {
"id": 5,
"name": "V6 For BHV 1,3"
},
"order": 1,
"enabled": true,
"addresses": [],
"addressesDetailed": [],
"subnet": "2001:db8:abcd:12:7::",
"cidr": 80,
"exhausted": false,
"gateway": "2001:db8:abcd:12::1",
"resolver1": "2001:4860:4860::8888",
"resolver2": "2001:4860:4860::8844",
"routeNet": false
},
{
"id": 508,
"block": {
"id": 5,
"name": "V6 For BHV 1,3"
},
"order": 1,
"enabled": true,
"addresses": [],
"addressesDetailed": [],
"subnet": "2001:db8:abcd:12:8::",
"cidr": 80,
"exhausted": false,
"gateway": "2001:db8:abcd:12::1",
"resolver1": "2001:4860:4860::8888",
"resolver2": "2001:4860:4860::8844",
"routeNet": false
},
{
"id": 509,
"block": {
"id": 5,
"name": "V6 For BHV 1,3"
},
"order": 1,
"enabled": true,
"addresses": [],
"addressesDetailed": [],
"subnet": "2001:db8:abcd:12:9::",
"cidr": 80,
"exhausted": false,
"gateway": "2001:db8:abcd:12::1",
"resolver1": "2001:4860:4860::8888",
"resolver2": "2001:4860:4860::8844",
"routeNet": false
}
]
}
],
"secondaryInterfaces": [
{
"id": 4,
"enabled": true,
"order": 1,
"tag": 3933491695,
"name": "eth1",
"type": "private",
"driver": 1,
"processQueues": null,
"mac": "00:F0:4A:C6:3F:08",
"ipv4ToMac": null,
"ipv6ToMac": null,
"inTrafficCount": true,
"outTrafficCount": false,
"inAverage": 0,
"inPeak": 0,
"inBurst": 0,
"outAverage": 0,
"outPeak": 0,
"outBurst": 0,
"ipFilter": true,
"vlans": [],
"ipFilterType": "4-6",
"portIsolated": false,
"ipv4_resolver_1": 1,
"ipv4_resolver_2": 2,
"ipv6_resolver_1": 1,
"ipv6_resolver_2": 2,
"networkProfile": 0,
"dhcpV4": 0,
"dhcpV6": 0,
"firewallEnabled": false,
"hypervisorNetwork": 6,
"isNat": false,
"nat": false,
"firewall": [],
"hypervisorConnectivity": {
"id": 6,
"type": "simpleBridge",
"bridge": "br0",
"mtu": null,
"primary": true,
"default": true
},
"ipWhitelist": [],
"actions": [],
"ipv4": [
{
"id": 34,
"order": 1,
"enabled": true,
"address": "192.168.4.33",
"gateway": "192.168.4.1",
"netmask": "255.255.254.0",
"resolver1": "8.8.8.8",
"resolver2": "8.8.4.4",
"rdns": null,
"mac": null
},
{
"id": 35,
"order": 2,
"enabled": true,
"address": "192.168.4.34",
"gateway": "192.168.4.1",
"netmask": "255.255.254.0",
"resolver1": "8.8.8.8",
"resolver2": "8.8.4.4",
"rdns": null,
"mac": null
}
],
"ipv6": [
{
"id": 503,
"block": {
"id": 5,
"name": "V6 For BHV 1,3"
},
"order": 1,
"enabled": true,
"addresses": [],
"addressesDetailed": [],
"subnet": "2001:db8:abcd:12:3::",
"cidr": 80,
"exhausted": false,
"gateway": "2001:db8:abcd:12::1",
"resolver1": "2001:4860:4860::8888",
"resolver2": "2001:4860:4860::8844",
"routeNet": false
},
{
"id": 504,
"block": {
"id": 5,
"name": "V6 For BHV 1,3"
},
"order": 1,
"enabled": true,
"addresses": [],
"addressesDetailed": [],
"subnet": "2001:db8:abcd:12:4::",
"cidr": 80,
"exhausted": false,
"gateway": "2001:db8:abcd:12::1",
"resolver1": "2001:4860:4860::8888",
"resolver2": "2001:4860:4860::8844",
"routeNet": false
}
]
}
]
},
"storage": [
{
"_id": 80,
"id": 1,
"cache": null,
"bus": null,
"capacity": 11,
"drive": "a",
"datastoreDiskId": null,
"filesystem": null,
"iops": {
"read": null,
"write": null
},
"bytes": {
"read": null,
"write": null
},
"type": "qcow2",
"profile": 1,
"status": 3,
"enabled": true,
"primary": true,
"created": "2024-12-06T21:25:58+00:00",
"updated": "2025-01-07T22:26:16+00:00",
"datastore": [],
"name": "b9fd9092-7200-4a24-96d4-76aedd664274_1",
"filename": "b9fd9092-7200-4a24-96d4-76aedd664274_1.img",
"hypervisorStorageId": null,
"local": true,
"locationType": "mountpoint",
"path": "/home/vf-data/disk"
}
],
"hypervisorAssets": [],
"hypervisor": {
"id": 6,
"ip": "192.168.4.2",
"hostname": null,
"port": 8892,
"maintenance": false,
"groupId": 2,
"group": {
"name": "Test",
"icon": null
},
"timezone": "Europe/London",
"forceIPv6": false,
"vncListenType": 1,
"displayName": null,
"cpuSet": null,
"nfType": 4,
"backupStorageType": 2,
"defaultDiskType": "inherit",
"defaultDiskCacheType": "inherit",
"defaultCPU": "inherit",
"defaultMachineType": "inherit",
"created": "2024-03-30T09:53:38+00:00",
"updated": "2024-12-06T21:25:54+00:00",
"name": "BHV 1",
"dataDir": "/home/vf-data",
"resources": {
"servers": {
"units": "#",
"max": 0,
"allocated": 5,
"free": -5,
"percent": null
},
"memory": {
"units": "MB",
"max": 29419,
"allocated": 7168,
"free": 22251,
"percent": 24.4
},
"cpuCores": {
"units": "#",
"max": 128,
"allocated": 6,
"free": 122,
"percent": 4.7
},
"localStorage": {
"enabled": 1,
"name": "Local (Default mountpoint)",
"storageType": 1,
"units": "GB",
"max": 1000,
"allocated": 141,
"free": 859,
"percent": 14.1
},
"otherStorage": []
}
},
"owner": {
"id": 1,
"admin": true,
"extRelationId": null,
"name": "Jon Doe",
"email": "jon@doe.com",
"timezone": "Europe/London",
"suspended": false,
"twoFactorAuth": false,
"created": "2024-03-12T22:22:09+00:00",
"updated": "2025-01-15T11:01:18+00:00"
},
"sshKeys": [
{
"id": 1,
"ownerId": 1,
"type": "OpenSSH",
"name": "Test Key",
"public": "ssh-rsa AAAAB3NzaC1yc2EAAAADAQABAAACAQC+JdL4fWELBWGAknSu0PwVpDDOlORxy9z7eVnZphZXBzYLMnux+ZogVLns6+O6NDE8JmWvP9RIg3SIga7RDOkW9UCdLzRu0jF2ALL7CK1huo1Ih0PDM9ZbFDy2Fd7a4DTvUX6923fQyW0PWRtyL11R4c9NUqzejKp5kW8vHfPQjzwb1hGIKvkSYkI0Auq4JJhlvjjnoK7Z8t5mpDrVfNTrVqevPgsW5Xwnq8R+02XywrY+Q/wnpxDs4Ujb2aA61A0x5J0xcZQpTQHoJNj77J3VmPI7Ry7Q8hPbTSLGZbN+gODr0lOaL5TdbvM3bnus5JvoqgRoszzPcTiNMZAe3v9UM8hiXise54b8rsc2M9MQ4olPu7TrROZbcw+9q4m6cV+dfVU/NRFkf27YRa4oZNKehHsMiupDyoISgSl4qSB8YXAWsX03oC/gzpB2YJIqEL1Y/SmKYEhgr0cplkvGZy6C/Q9cJHyHlMPtEBPexgcjXC9QrDZ4n2cmde3TuSRMctawcat7Nuq08C8fGHaGHr8iAeage3o/ODVOt0rhBu69PknzQeVBdlwK3+p1dH6PnMzNNBhWyNZT/NqB2eS6K8lYpOQ47byXPwYsRLvStUjpZRdikOT7D31T5g8FwOThQ+6WX+xfMD7CSLsSKCn/FhlinbVbG2IhCLH3B30Akw5bUw==",
"enabled": true,
"created": "2024-03-13T20:28:32+00:00"
}
],
"sharedUsers": [],
"tasks": {
"active": false,
"lastOn": "2025-01-15 15:00:49",
"actions": {
"pending": []
}
},
"remoteState": false
}
}🟠401401
Modified at 2025-01-21 10:31:04