- 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 hypervisor groups resources
Developing
GET
/compute/hypervisors/groups/{hypervisorGroupId}/resources
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 '/compute/hypervisors/groups/1/resources?results=20'Responses
🟢200Success
application/json
Body
Example
{
"current_page": 1,
"data": [
{
"hypervisor": {
"id": 1,
"name": "PHV 1 (RED)",
"enabled": true,
"prohibit": false,
"accept": false,
"commissioned": true
},
"resources": {
"servers": {
"units": "#",
"max": 0,
"allocated": 1,
"free": -1,
"percent": null
},
"memory": {
"units": "MB",
"max": 6004,
"allocated": 4096,
"free": 1908,
"percent": 68.2
},
"cpuCores": {
"units": "#",
"max": 4,
"allocated": 3,
"free": 1,
"percent": 75
},
"localStorage": {
"enabled": 1,
"name": "Local (Default mountpoint)",
"storageType": 0,
"units": "GB",
"max": 90,
"allocated": 25,
"free": 65,
"percent": 27.8
},
"otherStorage": [],
"network": {
"total": {
"ipv4": {
"free": 470
}
}
}
}
},
{
"hypervisor": {
"id": 2,
"name": "PHV 2 (BLUE)",
"enabled": true,
"prohibit": false,
"accept": false,
"commissioned": true
},
"resources": {
"servers": {
"units": "#",
"max": 0,
"allocated": 1,
"free": -1,
"percent": null
},
"memory": {
"units": "MB",
"max": 10000,
"allocated": 1024,
"free": 8976,
"percent": 10.2
},
"cpuCores": {
"units": "#",
"max": 28,
"allocated": 1,
"free": 27,
"percent": 3.6
},
"localStorage": {
"enabled": 1,
"name": "Local (Default mountpoint)",
"storageType": 0,
"units": "GB",
"max": 150,
"allocated": 10,
"free": 140,
"percent": 6.7
},
"otherStorage": [],
"network": {
"total": {
"ipv4": {
"free": 470
}
}
}
}
},
{
"hypervisor": {
"id": 3,
"name": "BHV 9",
"enabled": true,
"prohibit": false,
"accept": false,
"commissioned": true
},
"resources": {
"servers": {
"units": "#",
"max": 0,
"allocated": 2,
"free": -2,
"percent": null
},
"memory": {
"units": "MB",
"max": 27913,
"allocated": 2048,
"free": 25865,
"percent": 7.3
},
"cpuCores": {
"units": "#",
"max": 64,
"allocated": 2,
"free": 62,
"percent": 3.1
},
"localStorage": {
"enabled": 1,
"name": "Local (Default mountpoint)",
"storageType": 0,
"units": "GB",
"max": 400,
"allocated": 20,
"free": 380,
"percent": 5
},
"otherStorage": [],
"network": {
"total": {
"ipv4": {
"free": 470
}
}
}
}
},
{
"hypervisor": {
"id": 4,
"name": "BHV 8",
"enabled": true,
"prohibit": false,
"accept": false,
"commissioned": true
},
"resources": {
"servers": {
"units": "#",
"max": 0,
"allocated": 0,
"free": 0,
"percent": null
},
"memory": {
"units": "MB",
"max": 27913,
"allocated": 0,
"free": 27913,
"percent": 0
},
"cpuCores": {
"units": "#",
"max": 16,
"allocated": 0,
"free": 16,
"percent": 0
},
"localStorage": {
"enabled": 1,
"name": "Local (Default mountpoint)",
"storageType": 0,
"units": "GB",
"max": 1000,
"allocated": 0,
"free": 1000,
"percent": 0
},
"otherStorage": [],
"network": {
"total": {
"ipv4": {
"free": 0
}
}
}
}
},
{
"hypervisor": {
"id": 8,
"name": "BHV 3",
"enabled": true,
"prohibit": false,
"accept": false,
"commissioned": true
},
"resources": {
"servers": {
"units": "#",
"max": 0,
"allocated": 2,
"free": -2,
"percent": null
},
"memory": {
"units": "MB",
"max": 27913,
"allocated": 2048,
"free": 25865,
"percent": 7.3
},
"cpuCores": {
"units": "#",
"max": 120,
"allocated": 3,
"free": 117,
"percent": 2.5
},
"localStorage": {
"enabled": 1,
"name": "Local (Default mountpoint)",
"storageType": 1,
"units": "GB",
"max": 2000,
"allocated": 20,
"free": 1980,
"percent": 1
},
"otherStorage": [],
"network": {
"total": {
"ipv4": {
"free": 470
}
}
}
}
},
{
"hypervisor": {
"id": 9,
"name": "BHV 4",
"enabled": true,
"prohibit": false,
"accept": false,
"commissioned": true
},
"resources": {
"servers": {
"units": "#",
"max": 0,
"allocated": 0,
"free": 0,
"percent": null
},
"memory": {
"units": "MB",
"max": 13684,
"allocated": 0,
"free": 13684,
"percent": 0
},
"cpuCores": {
"units": "#",
"max": 4,
"allocated": 0,
"free": 4,
"percent": 0
},
"localStorage": {
"enabled": 1,
"name": "Local (Default mountpoint)",
"storageType": 0,
"units": "GB",
"max": 1000,
"allocated": 0,
"free": 1000,
"percent": 0
},
"otherStorage": [],
"network": {
"total": {
"ipv4": {
"free": 0
}
}
}
}
},
{
"hypervisor": {
"id": 10,
"name": "BHV 5",
"enabled": true,
"prohibit": false,
"accept": false,
"commissioned": true
},
"resources": {
"servers": {
"units": "#",
"max": 0,
"allocated": 0,
"free": 0,
"percent": null
},
"memory": {
"units": "MB",
"max": 13684,
"allocated": 0,
"free": 13684,
"percent": 0
},
"cpuCores": {
"units": "#",
"max": 4,
"allocated": 0,
"free": 4,
"percent": 0
},
"localStorage": {
"enabled": 1,
"name": "Local (Default mountpoint)",
"storageType": 0,
"units": "GB",
"max": 1000,
"allocated": 0,
"free": 1000,
"percent": 0
},
"otherStorage": [],
"network": {
"total": {
"ipv4": {
"free": 0
}
}
}
}
},
{
"hypervisor": {
"id": 11,
"name": "BHV 6",
"enabled": true,
"prohibit": false,
"accept": false,
"commissioned": true
},
"resources": {
"servers": {
"units": "#",
"max": 0,
"allocated": 1,
"free": -1,
"percent": null
},
"memory": {
"units": "MB",
"max": 27913,
"allocated": 1024,
"free": 26889,
"percent": 3.7
},
"cpuCores": {
"units": "#",
"max": 16,
"allocated": 1,
"free": 15,
"percent": 6.3
},
"localStorage": {
"enabled": 1,
"name": "Local (Default mountpoint)",
"storageType": 0,
"units": "GB",
"max": 1000,
"allocated": 10,
"free": 990,
"percent": 1
},
"otherStorage": [],
"network": {
"total": {
"ipv4": {
"free": 478
}
}
}
}
},
{
"hypervisor": {
"id": 12,
"name": "BHV 7",
"enabled": true,
"prohibit": false,
"accept": false,
"commissioned": true
},
"resources": {
"servers": {
"units": "#",
"max": 0,
"allocated": 1,
"free": -1,
"percent": null
},
"memory": {
"units": "MB",
"max": 27913,
"allocated": 1024,
"free": 26889,
"percent": 3.7
},
"cpuCores": {
"units": "#",
"max": 16,
"allocated": 1,
"free": 15,
"percent": 6.3
},
"localStorage": {
"enabled": 1,
"name": "Local (Default mountpoint)",
"storageType": 0,
"units": "GB",
"max": 1000,
"allocated": 10,
"free": 990,
"percent": 1
},
"otherStorage": [],
"network": {
"total": {
"ipv4": {
"free": 478
}
}
}
}
},
{
"hypervisor": {
"id": 13,
"name": "Ceph Hypervisor 1",
"enabled": true,
"prohibit": false,
"accept": false,
"commissioned": true
},
"resources": {
"servers": {
"units": "#",
"max": 0,
"allocated": 5,
"free": -5,
"percent": null
},
"memory": {
"units": "MB",
"max": 24000,
"allocated": 7168,
"free": 16832,
"percent": 29.9
},
"cpuCores": {
"units": "#",
"max": 64,
"allocated": 8,
"free": 56,
"percent": 12.5
},
"localStorage": {
"enabled": 1,
"name": "Local (Default mountpoint)",
"storageType": 1,
"units": "GB",
"max": 100,
"allocated": 50,
"free": 50,
"percent": 50
},
"otherStorage": [
{
"id": 1,
"name": "Ceph RBD",
"enabled": 0,
"path": null,
"units": "GB",
"storageType": 2,
"isDatastore": true,
"max": 10000,
"allocated": 35,
"free": 9965,
"percent": 0.4
},
{
"id": 4,
"name": "Ceph FS",
"enabled": 0,
"path": null,
"units": "GB",
"storageType": 2,
"isDatastore": true,
"max": 558349385,
"allocated": 5,
"free": 558349380,
"percent": 0
}
],
"network": {
"total": {
"ipv4": {
"free": 503
}
}
}
}
},
{
"hypervisor": {
"id": 14,
"name": "Ceph Hypervisor 2",
"enabled": true,
"prohibit": false,
"accept": false,
"commissioned": true
},
"resources": {
"servers": {
"units": "#",
"max": 0,
"allocated": 3,
"free": -3,
"percent": null
},
"memory": {
"units": "MB",
"max": 24000,
"allocated": 3072,
"free": 20928,
"percent": 12.8
},
"cpuCores": {
"units": "#",
"max": 64,
"allocated": 3,
"free": 61,
"percent": 4.7
},
"localStorage": {
"enabled": 1,
"name": "Local (Default mountpoint)",
"storageType": 1,
"units": "GB",
"max": 1000,
"allocated": 10,
"free": 990,
"percent": 1
},
"otherStorage": [
{
"id": 2,
"name": "Ceph RBD",
"enabled": 0,
"path": null,
"units": "GB",
"storageType": 2,
"isDatastore": true,
"max": 10000,
"allocated": 10,
"free": 9990,
"percent": 0.1
},
{
"id": 3,
"name": "Ceph EC",
"enabled": 0,
"path": null,
"units": "GB",
"storageType": 2,
"isDatastore": true,
"max": 13333333,
"allocated": 10,
"free": 13333323,
"percent": 0
}
],
"network": {
"total": {
"ipv4": {
"free": 33
}
}
}
}
}
],
"first_page_url": "https://192.168.3.11/api/v1/compute/hypervisors/groups/1/resources?page=1",
"from": 1,
"last_page": 1,
"last_page_url": "https://192.168.3.11/api/v1/compute/hypervisors/groups/1/resources?page=1",
"links": [
{
"url": null,
"label": "« Previous",
"active": false
},
{
"url": "https://192.168.3.11/api/v1/compute/hypervisors/groups/1/resources?page=1",
"label": "1",
"active": true
},
{
"url": null,
"label": "Next »",
"active": false
}
],
"next_page_url": null,
"path": "https://192.168.3.11/api/v1/compute/hypervisors/groups/1/resources",
"per_page": 20,
"prev_page_url": null,
"to": 11,
"total": 11
}🟠401401
Modified at 2025-01-20 21:49:10