Page tree

Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

Children Display
alltrue
styleh3
pageSuperb Cloud API

GET /virtual_machines/:virtual_machine_id/status

Get the status of a specific VM

Sections:

Table of Contents
maxLevel4
minLevel2
includeResponse.*|JSON.*|XML.*|Explanation.*

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

Code Block
languagebash
themeRDark
 curl -i -X GET -H 'Accept: application/json' -H 'Content-type: application/json' -u user:password --url https://mycp.superb.net/api/<api_url>/virtual_machines/:virtual_machine_id/status.json

JSON Response

Code Block
 {
    "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

Code Block
languagebash
themeRDark
 curl -i -X GET -H 'Accept: application/xml' -H 'Content-type: application/xml' -u user:password --url https://mycp.superb.net/api/<api_url>/virtual_machines/:virtual_machine_id/status.xml

XML Response example

Code Block
languagexml
 <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>