- Created by Unknown User (sraaum), last modified on Oct 21, 2015
API Essentials
API Key Generation
Autoscaling
Backups
- Add/Edit Note
- Convert Backup to Template
- Create Backup
- Delete Backup
- Get List of All VS Backups
- Get List of Incremental Backups
- Get List of Normal Backups
- Restore Disk from Backup
Credit
DNS
- Add DNS Record
- Add DNS Zone
- Delete DNS Record
- Delete DNS Zone
- Edit DNS Record
- Get DNS Zones
- Get List of DNS Zone Records
- Get List of Name Servers
Firewall Rules
Flex Cloud VM Control
Getting Started with Superb Flex Cloud
IP Addresses
Logs
Network Interfaces
Recipes
- Add Recipe
- Add Recipe Step
- Assign Recipe to Virtual Server
- Delete Recipe
- Delete Recipe Step
- Edit Recipe
- Edit Recipe Step
- Get All Recipes
- Get Recipe Steps
- Get Virtual Server Recipes
- Remove recipe from Virtual Server
- Run Recipe on Multiple Virtual Servers
- Swap Recipe Step Number
SSH Keys
Templates
Test Route
Troubleshooting API Issues
Viewing Activity Logs
Virtual Server Operating Systems
Virtual Servers
- Add Virtual Server
- Billing Statistics
- Build Virtual Server
- Delete Virtual Server
- Edit Virtual Server
- Get CPU Usage Statistics
- Get List of Virtual Machines
- Get statuses for All VMs
- Reboot Virtual Server
- Reset VS Password
- Shutdown Virtual Server
- Startup a Virtual Server
- Stop Virtual Server
VS Disks
GET /virtual_machines
Get a list of your virtual servers
Sections:
Response Parameters
add_to_marketplace — empty for VSs; used for edge servers only
admin_note — an optional note of the administrator
allowed_hot_migrate — true if the template, on which the VS is based, supports hot migration; otherwise false
allowed_swap — true if swap disk is allowed (depends on the template the VS is based on); otherwise false
booted — true if the VS is running, otherwise false
built — true if the VS is built, otherwise false
cpu_shares — CPU priority in percent's
cpu_sockets - the amount of CPU sockets per core. This parameter can be set for KVM hypervisors only by those users who have Enable CPU topology permission granted
cpu_threads - the amount of CPU threads per core. This parameter can be set for KVM hypervisors only by those users who have Enable CPU topology permission granted
cpu_units - the amount of CPU units per core if the CPU priority is replaced with CPU units in user billing plan.
cpus — the number of allocated CPU cores
created_at — the date in the [YYYY][MM][DD]T[hh][mm][ss]Z format
customer_network_id - ID of a customer network
deleted_at - time when the VS was deleted
edge_server_type - true if this is the edge server
enable_autoscale — true if autoscaling is allowed for this VS
enable_monitis - deprecated attribute; will be removed in upcoming release
firewall_notrack - true if the NOTRACK rule is set in iptables
hostname — the name of your host
hypervisor_id — the ID of the hypervisor used by this VS
id — the VS ID
identifier — the VS identifier
initial_root_password — the VS root password
initial_root_password_encrypted - true, if the root password is encrypted, otherwise false.
label — the VS label
local_remote_access_ip_address - IP address used for remote access
local_remote_access_port — the port ID used for console access
locked — true if the VS is locked; otherwise false
memory — the RAM size allocated to this VS
min_disk_size — the minimum disk size required to build a VS from a specified template
note — an optional reminder for this VS made by a user account
operating_system — operating system used by the VS
operating_system_distro — the distribution of the OS from which this VS is built
preferred_hvs - the array of preferable hypervisors based on HV zone that meet some VS configuration settings
recovery_mode — true if recovery mode allowed. Otherwise false
remote_access_password — the password for the remote access
service_password - service account password
state – parameter reserved for future use
storage_server_type - true if this is a storage server
strict_virtual_machine_id — the ID of a virtual server that will never reside on the same hypervisor with this VS
suspended — true if VS is suspended, otherwise false
template_id — the ID of the template the VS is based on
template_label — the name of the template from which this VS is built
updated_at — the date when the VS was updated in the [YYYY][MM][DD]T[hh][mm][ss]Z format
user_id — the ID of a user assigned to this VS
vip — true if the VS has VIP status (gives migration priority)
xen_id — the VS ID set by the virtualization engine
ip_addresses - an array of IP addresses assigned to this VS and their details:
address - IP address
broadcast - broadcast address
created_at - the date in the [YYYY][MM][DD]T[hh][mm][ss]Z format
customer_network_id - the ID of the customer VLAN the IP address belongs to
disallowed_primary - true if not allowed to be used as primary, otherwise false
gateway - gateway address
hypervisor_id - the ID of a hypervisor the IP address is associated with
id - the ID of the IP address
ip_address_pool_id - ID of the IP address pool the IP address is associated with
network_address - the address of the network
network_id - the ID of the network
pxe - true, if this address can be used for cloudbooting a hypervisor
updated_at - the date in the [YYYY][MM][DD]T[hh][mm][ss]Z format
user_id - the ID of the user this IP address is assigned to
free - true if free, otherwise false
netmask - netmask for the IP address
monthly_bandwidth_used - VS monthly bandwidth in KB
total_disk_size — the total disk size in GB of all disks assigned to VS
price_per_hour - server's price per hour
price_per_hour_powered_off - price per hour when server is powered off
support_incremental_backups - 1, if virtual server supports incremental backups, and 0 if it does not
cpu_priority - this is a new parameter reserved for further use; currently will have the same value as cpu_shares
JSON Request example
curl -i -X GET -H 'Accept: application/json' -H 'Content-type: application/json' -u user:userpass --url <api_url>/virtual_machines
JSON Response
[ { "virtual_machine": { "add_to_marketplace": null, "admin_note": null, "allowed_hot_migrate": true, "allowed_swap": true, "booted": false, "built": true, "cores_per_socket": 0, "cpu_shares": 1, "cpu_sockets": null, "cpu_threads": null, "cpu_units": 10, "cpus": 1, "created_at": "2015-08-11T01:52:43+00:00", "customer_network_id": null, "deleted_at": null, "edge_server_type": null, "enable_autoscale": null, "enable_monitis": null, "firewall_notrack": false, "hostname": "zaza", "hypervisor_id": 1, "id": 123, "identifier": "i9sd8x7fuofl70", "initial_root_password": "password", "initial_root_password_encrypted": false, "iso_id": null, "label": "tes_label", "local_remote_access_ip_address": "192.168.0.1", "local_remote_access_port": null, "locked": false, "memory": 528, "min_disk_size": 5, "note": null, "operating_system": "linux", "operating_system_distro": "rhel", "preferred_hvs": [ 5, 3, 8, 12, 11, 4, 7, 10, 6, 9 ], "recovery_mode": false, "remote_access_password": "password", "service_password": null, "state": "delivered", "storage_server_type": null, "strict_virtual_machine_id": null, "suspended": false, "template_id": 128, "template_label": "CentOS 7.1 x64", "updated_at": "2015-08-24T20:04:26+00:00", "user_id": 337, "vip": null, "xen_id": null, "ip_addresses": [ { "ip_address": { "address": "192.168.0.1", "broadcast": "192.168.0.1", "created_at": "2015-07-30T01:35:54+00:00", "customer_network_id": null, "disallowed_primary": false, "gateway": "192.168.0.1", "hypervisor_id": null, "id": 1234, "ip_address_pool_id": null, "network_address": "192.168.0.1", "network_id": 1, "pxe": false, "updated_at": "2015-08-11T01:52:43+00:00", "user_id": null, "free": false, "netmask": "255.255.252.0" } } ], "monthly_bandwidth_used": 421211, "total_disk_size": 9, "price_per_hour": 0.01038949, "price_per_hour_powered_off": 0.00236113, "support_incremental_backups": true, "cpu_priority": 1 } } ]
XML Request example
curl -i -X GET -H 'Accept: application/json' -H 'Content-type: application/json' -u user:userpass --url <api_url>/virtual_machines
XML Response example
<?xml version="1.0" encoding="UTF-8"?> <virtual_machines> <virtual_machine> <add_to_marketplace nil="true"></add_to_marketplace> <admin_note nil="true"></admin_note> <allowed_hot_migrate type="boolean">true</allowed_hot_migrate> <allowed_swap type="boolean">true</allowed_swap> <booted type="boolean">true</booted> <built type="boolean">true</built> <cpu_shares type="integer">1</cpu_shares> <cpu_sockets nil="true"/> <cpu_threads nil="true"/> <cpu_units type="integer">200</cpu_units> <cpus type="integer">1</cpus> <created_at type="datetime">2011-11-01T17:11:58+03:00</created_at> <customer_network_id nil="true"/> <deleted_at nil="true"/> <edge_server_type nil="true"/> <enable_autoscale type="boolean">true</enable_autoscale> <enable_monitis type="boolean">true</enable_monitis> <firewall_notrack type="boolean">false</firewall_notrack> <hostname>autobackup</hostname> <hypervisor_id type="integer">2</hypervisor_id> <id type="integer">000</id> <identifier>iskngs9dve0hdg</identifier> <initial_root_password>791791</initial_root_password> <initial_root_password_encrypted type="boolean">false</initial_root_password_encrypted> <label>YR_autobackup</label> <local_remote_access_ip_address>000.000.00.00</local_remote_access_ip_address> <local_remote_access_port type="integer">0000</local_remote_access_port> <locked type="boolean">false</locked> <memory type="integer">1632</memory> <min_disk_size type="integer">5</min_disk_size> <note nil="true"></note> <operating_system>linux</operating_system> <operating_system_distro>rhel</operating_system_distro> <preferred_hvs type="array"/> <recovery_mode type="boolean">false</recovery_mode> <remote_access_password>os3ajolb1buj</remote_access_password> <service_password nil="true"/> <state>new</state> <storage_server_type nil="true"/> <strict_virtual_machine_id nil="true"></strict_virtual_machine_id> <suspended type="boolean">false</suspended> <template_id type="integer">8</template_id> <template_label>CentOS 5.6 x86</template_label> <updated_at type="datetime">2015-03-04T12:06:21+02:00</updated_at> <user_id type="integer">5</user_id> <vip nil="true"></vip> <xen_id type="integer">12</xen_id> <ip_addresses type="array"> <ip_address> <address>000.000.000.000</address> <broadcast>000.000.000.000</broadcast> <created_at type="datetime">2011-10-10T12:31:12+03:00</created_at> <customer_network_id nil="true"/> <disallowed_primary type="boolean">false</disallowed_primary> <gateway>000.000.000.000</gateway> <hypervisor_id nil="true"/> <id type="integer">2</id> <ip_address_pool_id nil="true"/> <network_address>000.000.000.000</network_address> <network_id type="integer">1</network_id> <pxe type="boolean">false</pxe> <updated_at type="datetime">2011-11-01T17:39:13+03:00</updated_at> <user_id nil="true"/> <free type="boolean">false</free> <netmask>000.000.000.000</netmask> </ip_address> </ip_addresses> <monthly_bandwidth_used>0</monthly_bandwidth_used> <total_disk_size type="integer">6</total_disk_size> <price_per_hour type="float">0.0</price_per_hour> <price_per_hour_powered_off type="float">0.0</price_per_hour_powered_off> <support_incremental_backups type="boolean">false</support_incremental_backups> <cpu_priority type="integer">1</cpu_priority> </virtual_machine> ... <virtual_machine></virtual_machine> ... </virtual_machine>
- No labels