Get List of Backup Servers

GET /settings/backup_servers.xml
GET /settings/backup_servers.json

Returns the array of backup servers.

XML Output example

<?xml version="1.0" encoding="UTF-8"?>
<backup_servers type="array">
<backup_server>
<label>bk1</label>
<created_at type="datetime">2012-01-04T10:18:59Z</created_at>
<updated_at type="datetime">2012-01-16T14:11:30Z</updated_at>
<backup_server_group_id type="integer">28</backup_server_group_id>
<id type="integer">1</id>
<backup_ip_address>192.168.123.1</backup_ip_address>
<enabled type="boolean">true</enabled>
<backups type="array">
<backup>
<marked_for_delete type="boolean">false</marked_for_delete>
<disk_id type="integer">3908</disk_id>
<built_at type="datetime">2012-02-09T16:05:21Z</built_at>
<operating_system_distro>rhel</operating_system_distro>
<created_at type="datetime">2012-02-09T16:03:45Z</created_at>
<template_id type="integer">233</template_id>
<operating_system>linux</operating_system>
<updated_at type="datetime">2012-02-09T16:05:21Z</updated_at>
<backup_type>normal</backup_type>
<allowed_swap type="boolean">true</allowed_swap>
<allow_resize_without_reboot type="boolean">false</allow_resize_without_reboot>
<id type="integer">1508</id>
<backup_server_id type="integer">1</backup_server_id>
<allowed_hot_migrate type="boolean">false</allowed_hot_migrate>
<backup_size>175264</backup_size>
<min_disk_size type="integer">5</min_disk_size>
<identifier>pkg0v4k4n34ym8</identifier>
<locked type="boolean">false</locked>
<built type="boolean">true</built>
</backup>
</backup_server>
</backup_servers> 


Explanation of the data returned:

Backup server parameters:

label – the backup server label

created_at – the date in the [YYYY][MM][DD]T[hh][mm][ss]Z format

updated_at – the date in the [YYYY][MM][DD]T[hh][mm][ss]Z format

backup_server_group_id – the ID of a backup server group the backup server belongs to

id – the backup server ID

backup_server_ip_address – provisioning network IP address

enabled – backup server parameter; if "enabled" = true, the backup server is enabled; if enabled = false, the backup server is disabled.

Backup parameters:

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

disk_id – the ID of a disk backed up

built_at – the date in the [YYYY][MM][DD]T[hh][mm][ss]Z format

operating_system_distro – the OS distribution of the VS from which the backup was created

created_at – the date in the [YYYY][MM][DD]T[hh][mm][ss]Z format

template_id – the ID of the template the VS is based on

updated_at – the date in the [YYYY][MM][DD]T[hh][mm][ss]Z format

backup_type – disk backup type (normal, Days auto-backup, Weeks auto-backup, Months auto-backup, Years auto-backup)

allowed_swap – true if the template to which the backup can be restored will allow swap, otherwise false.

allow_resize_without_reboot – true if the template to which the backup can be restored will support resize without reboot option, otherwise false

id – the backup ID

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

allowed_hot_migrate – true if the template to which the backup can be restored will support hot migration, otherwise false.

backup_size – the size of the backup

min_disk_size – minimum disk size required for restoring a backup

identifier – the backup identifier

locked – true if the backup is being built, otherwise false

built – true if the backup is already built, otherwise false