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/backups/files

An array of backups is returned. If there are no backups, an empty array is returned.

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

Response Parameters:

allowed_resize_without_reboot – true if resizing CPU & RAM is allowed without restarting the storage server backed up

allowed_hot_migrate – true if hot migration is allowed for the storage server backed up

allowed_swap – true if swap disk is allowed for storage server backed up, otherwise false

backup_server_id – the ID of the backup server on which the backup is stored

backup_size – the disk space taken by this backup in kB

backup_type – normal or incremental

built – true if the storage server backed up has been built

built_at – the date when the disk backup was built

created_at – the date when the record in the database was created

updated_at – the date when this record in database was updated

data_store_type - data store type: lvm, vmware or solidfire

id – the ID of this backup

identifier - disk identifier

image_type - backup type (currently only tar is available)

initiated - period when backup is initiated: days, weeks, months, or years

locked – true if the storage server backed up has been locked

marked_for_delete – the backup is marked for deletion (for auto-backups)

min_disk_size – the minimum disk size

operating_system_distro – the OS distribution of the storage server backed up

operating_system – the OS of the storage server backed up

target_id - ID of a backup target

target_type - target for which the backup was taken; For normal backups it is a disk. For incremental backups it's virtual server.

template_id – the ID of a template from which the storage server backed up was built

user_id - the ID of a user the storage server belongs to

volume_id - data store ID

JSON Request example

Code Block
languagebash
themeRDark
 curl -i -X GET -H 'Accept: application/json' -H 'Content-type: application/json' -u user:userpass --url https://mycp.superb.net/api/virtual_machines/:virtual_machine_id/backups/files.json

JSON Response

Code Block
languagejs
{
    "backup": {
        "allow_resize_without_reboot": true,
        "allowed_hot_migrate": true,
        "allowed_swap": true,
        "backup_server_id": 1,
        "backup_size": 0,
        "built": false,
        "built_at": null,
        "created_at": "2015-08-20T21:37:54+00:00",
        "data_store_type": "lvm",
        "id": 6250,
        "identifier": "jijk18gqcjlh6m",
        "initiated": "manual",
        "iqn": null,
        "locked": true,
        "marked_for_delete": false,
        "min_disk_size": 0,
        "min_memory_size": 384,
        "note": null,
        "operating_system": "linux",
        "operating_system_distro": "rhel",
        "target_id": 489,
        "target_type": "VirtualMachine",
        "template_id": 128,
        "updated_at": "2015-08-20T21:37:54+00:00",
        "user_id": 337,
        "volume_id": null,
        "backup_type": "incremental",
        "disk_id": null
    }
}

XML Request example

Code Block
languagebash
themeRDark
 curl -i -X GET -H 'Accept: application/xml' -H 'Content-type: application/xml' -u user:userpass --url https://mycp.superb.net/api/virtual_machines/:virtual_machine_id/backups/files.xml

XML Response example

Code Block
languagexml
 <?xml version="1.0" encoding="UTF-8"?>
<backups type="array">
 <backup>
  <allow_resize_without_reboot type="boolean">false</allow_resize_without_reboot>
  <allowed_hot_migrate type="boolean">true</allowed_hot_migrate>
  <allowed_swap type="boolean">true</allowed_swap>
  <backup_server_id nil="true"/>
  <backup_size type="integer">1121652</backup_size>
  <built type="boolean">true</built>
  <built_at type="datetime">2013-12-18T11:00:47+00:00</built_at>
  <created_at type="datetime">2013-12-18T10:59:41+00:00</created_at>
  <data_store_type>lvm</data_store_type>
  <id type="integer">698</id>
  <identifier>y5cc19dv7bsdrk</identifier>
  <initiated>manual</initiated>
  <iqn nil="true"/>
  <locked type="boolean">false</locked>
  <marked_for_delete type="boolean">false</marked_for_delete>
  <min_disk_size type="integer">5</min_disk_size>
  <min_memory_size type="integer">128</min_memory_size>
  <note>Stuarts backup</note>
  <operating_system>linux</operating_system> 
  <operating_system_distro>ubuntu</operating_system_distro>
  <target_id type="integer">74</target_id>
  <target_type>VirtualMachine</target_type>
  <template_id type="integer">6</template_id>
  <updated_at type="datetime">2013-12-18T11:00:47+00:00</updated_at>
  <user_id type="integer">8</user_id>
  <volume_id nil="true"/>
  <backup_type>incremental</backup_type>
  <disk_id nil="true"/>
 </backup>
</backups>