List Backups

Description

List available backups for the specified server. The {from-inclusive} and {to-exclusive} parts of the request URL must specify a date and time interval for backup retrieval.

Syntax

GET baseURL/ve/{ve-name}/backups/{from-inclusive}/{to-exclusive}

See Date and Time Format for the information on date and time formatting.

Request Parameters

None

Response

Element

Attribute

Description

ve-backups

 

Container for backups.

backup

 

Container for backup information. This element may appear more than once (one for each backup).

 

im-backup-id

Backup ID (used internally)

Type: int

 

cloud-backup-id

Cloud backup ID. Use this ID when restoring a server from a backup, getting backup information, or deleting a backup.

Type: string

 

schedule-name

Backup schedule name.

Scheduled backups have this attribute with a value specifying the schedule used. On-demand backup does not have it. This can be used as an indication of whether this is a scheduled or on-demand backup.

Type: string

 

started

Backup start date and time.

Type: string

 

ended

Backup end date and time.

Type: string

 

successful

Specifies whether the backup was successful.

Type: boolean

 

backup-size

Backup file size.

Type: int

 

backup-node-name

Name of the backup node.

Type: string

Example

Request

GET https://c2u-web:4465/paci/v1.0/ve/Web60/backups/1970-01-01%2000%3A00%20%2B0300/2017-12-30%2010%3A37%20%2B0300

Response

<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<ve-backups>
    <backup im-backup-id="3700" cloud-backup-id="{985b50e0-4f7b-4f46-b97e-b5ceb55ce1cb}" started="2017-12-07 04:05:53.114847-05" ended="2017-12-07 04:08:59.258621-05" successful="true" backup-size="537418715" backup-node-name="vz-bkp001" ve-state="STARTED"/>
</ve-backups>