Get Backup Server Details
To get the details for a particular backup server, use the following request:
GET /settings/backup_servers/:id.xml
GET /settings/backup_servers/:id.json
XML Request Example
curl -i -X GET -H 'Accept: application/json' -H 'Content-type: application/json' -u account_email:API_key --url http://onapp.test/settings/backup_servers/1526.xml
JSON Request Example
curl -i -X GET -H 'Accept: application/json' -H 'Content-type: application/json' -u account_email:API_key --url http://onapp.test/settings/backup_servers/1526.json
XML Output Example
<backup_server> <label>bk1</label> <created_at type="datetime">2012-01-04T1204T10:18:59+02:0059Z</created_at> <backups type="array"> <backup> <marked_for_delete type="boolean">false</marked_for_delete> <disk_id type="integer">4097</disk_id> <built_at nil="true"/> <operating_system_distro>rhel</operating_system_distro> <created_at type="datetime">2012-02-11T00:36:17Z</created_at> <template_id type="integer">211</template_id> <operating_system>linux</operating_system> <updated_at type="datetime">2012-03-05T13:42:15+02:0002-11T00:36:17Z</updated_at> <backup_type>months-autobackup</backup_type> <allowed_swap type="boolean">true</allowed_swap> <allow_resize_without_reboot type="boolean">true</allow_resize_without_reboot> <id type="integer">1526</id> <backup_server_id type="integer">1</backup_server_id> <allowed_hot_migrate type="boolean">true</allowed_hot_migrate> <backup_size nil="true"/> <min_disk_size nil="true"/> <identifier>gmkrf5k0s4hsnj</identifier> <locked type="boolean">true</locked> <built type="boolean">false</built> </backup> </backups> <updated_at type="datetime">2012-02-14T14:01:20Z</updated_at> <backup_ip_address>192.168.123.1</backup_ip_address> <backup_server_group_id nil="true"/>type="integer">28</backup_server_group_id> <id type="integer">1</id> <enabled type="boolean">true</enabled> <capacity type="integer">460</capacity> <ip_address>109.123.105.162</ip_address> </backup_server>
Where:
label – 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
id – the backup server ID
backups – a list of backups stored on this backup server ID with the following details:
template_id – the ID of the template the VS from which the backup was created was based on
operating_system – the operating system of the VA from which the backup was created
backup_server_group_id – the ID of the backup server zone the backup server belongs to
enabled – backup server parameter; if "enabled" = true, the backup server will be enabled; if enabled=false, the backup server will be disabled.
capacity – the backup server capacity
ip_address – the backup server IP
backup_server_ip_address - provisioning network IP address
To view the list of backups with their details, please refer to the Search Backups section.