- 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/:virtual_machine_id/status
Get the status of a specific VM
Sections:
Response Parameters
id - virtual server ID
identifier — the VS identifier
hostname — the name of your host
template_id — the ID of the template the VS is based on
built — true if the VS is built, otherwise false
locked — true if the VS is locked; otherwise false
booted — true if the VS is running, otherwise false
operating_system — operating system used by the VS
suspended — true if VS is suspended, otherwise false
enable_autoscale — true if autoscaling is allowed for this VS
state – virtual server state
JSON Request example
curl -i -X GET -H 'Accept: application/json' -H 'Content-type: application/json' -u user:password --url <api_url>/virtual_machines/:virtual_machine_id/status.json
JSON Response
{ "virtual_machine": { "id": 489, "identifier": "p9sd8x7fuofl70", "hostname": "zaza", "template_id": 128, "built": true, "locked": false, "booted": true, "operating_system": "linux", "suspended": false, "enable_autoscale": null, "state": "delivered" } }
XML Request example
curl -i -X GET -H 'Accept: application/xml' -H 'Content-type: application/xml' -u user:password --url <api_url>/virtual_machines/:virtual_machine_id/status.xml
XML Response example
<virtual_machines type="array"> <virtual_machine> <id type="integer">48</id> <identifier>b266b5h5et39iy</identifier> <hostname>qaaoxp</hostname> <template_id type="integer">111</template_id> <built type="boolean">true</built> <locked type="boolean">false</locked> <booted type="boolean">true</booted> <operating_system>windows</operating_system> <suspended type="boolean">false</suspended> <enable_autoscale type="boolean">false</enable_autoscale> <state>new</state> </virtual_machine> </virtual_machines>
- No labels