Query Backup List

Query Backup List

Returns the list of backup bundles available in /opt/vmware/vcloud-director/data/transfer/backups/

Request
URI
GET
https://{api_host}/api/1.0.0/backups
COPY
Query Parameters
string
filter
Optional

query filter. values may be "date=ge=some-date", "date=gt=some-date", "date=le=some-date", "date=lt=some-date" or "version==full-appliance-version"

string
sortAsc
Optional

sortAsc=field means to sort on field in ascending order. Only supported value is "date"

string
sortDesc
Optional

sortDesc=field means to sort on field in descending order. Only supported value is "date"

integer
page
Optional
Constraints: minimum: 1 default: 1

The number of pages to skip before starting to collect the result set. page sequence starts at 1.

integer
pageSize
Optional
Constraints: minimum: 1 maximum: 100 default: 20

The number of items that may be returned in a page.

Authentication
This operation uses the following authentication methods.
Responses
200

OK

Returns BackupList of type(s) application/json 
{
    "resultTotal": 0,
    "pageCount": 0,
    "pageSize": 0,
    "listOfBackupFiles": [
        {
            "name": "string",
            "location": "string",
            "size": 0,
            "date": "string",
            "version": "string"
        }
    ]
}
integer As int32 As int32
resultTotal
Optional

How many results there are in total (i.e., considering all pages).

integer As int32 As int32
pageCount
Optional

How many pages there are in total.

integer As int32 As int32
pageSize
Optional

Result count for page that was fetched.

array of object
listOfBackupFiles
Optional

List of Backup objects.


Code Samples
COPY
                    curl -H 'Authorization: <value>' https://{api_host}/api/1.0.0/backups
Availability
Added in 36.1
On This Page
Backup Operations
GET
Query Backup List
POST
Create Backup
GET
Get Backup Info
DELETE
Delete Backup
POST
Restore Primary Backup