REST API - list

appliance recovery backup system name archive: list

Returns information about backup archives corresponding to given backup location and system name, which match the appliance.recovery.backup.system_name.archive.filter_spec. This operation was added in vSphere API 6.7.

Request:

HTTP request

GET https://{server}/rest/appliance/recovery/backup/system-name/{system_name}/archives

?filter_spec.comment_substring=string
&filter_spec.end_timestamp=2015-01-01T22%3A13%3A05.651Z
&filter_spec.start_timestamp=2015-01-01T22%3A13%3A05.651Z
&filter_spec.max_results=1
&loc_spec.location=http%3A%2F%2Fmyurl.com
&loc_spec.location_password=secret+string
&loc_spec.location_user=string

Path Parameters

Name Type Description
Required
system_name string System name identifier.

Request Query Parameters:

Name Type Description
bold = required
loc_spec location_spec LocationSpec Structure.
loc_spec.location URI Backup location URL. This attribute was added in vSphere API 6.7.

loc_spec.location_user string Username for the given location. This attribute was added in vSphere API 6.7.

Optional. If unset authentication will not be used.

loc_spec.location_password secret Password for the given location. This attribute was added in vSphere API 6.7.

Optional. If unset authentication will not be used.

filter_spec filter_spec Specification of matching backups for which information should be returned.
filter_spec.start_timestamp date_time Backup must have been taken on or after this time to match the filter. This attribute was added in vSphere API 6.7.

Optional. If unset the filter will match oldest backups.

filter_spec.end_timestamp date_time Backup must have been taken on or before this time to match the filter. This attribute was added in vSphere API 6.7.

Optional. If unset the filter will match most recent backups.

filter_spec.comment_substring string Backup comment must contain this string to match the filter. This attribute was added in vSphere API 6.7.

Optional. If unset the filter will match backups with any comment.

filter_spec.max_results long Limit result to a max count of most recent backups. This attribute was added in vSphere API 6.7.

Optional. If unset it defaults to 128.

Response:

HTTP Status Code: 200

Representation:

{
    "value"[
        {
            "archive""obj-103",
            "comment""string",
            "version""string",
            "timestamp""2015-01-01T22:13:05.651Z"
        },
        {
            "archive""obj-103",
            "comment""string",
            "version""string",
            "timestamp""2015-01-01T22:13:05.651Z"
        }
    ]
}

Response Type:

Name Type Description
bold = required
value summary[] Commonly used information about the backup archives.
value[].archive string Backup archive identifier. This attribute was added in vSphere API 6.7.

When clients pass a value of this structure as a parameter, the field must be an identifier for the resource type: com.vmware.appliance.recovery.backup.system_name.archive. When operations return a value of this structure as a result, the field will be an identifier for the resource type: com.vmware.appliance.recovery.backup.system_name.archive.

value[].timestamp date_time Time when this backup was started. This attribute was added in vSphere API 6.7.

value[].version string The version of the appliance represented by the backup archive. This attribute was added in vSphere API 6.7.

value[].comment string Custom comment added by the user for this backup. This attribute was added in vSphere API 6.7.

Errors:

HTTP Status Code Type Description
404 not_found if combination of loc_spec and system name does not refer to an existing location on the backup server.
500 error if any error occurs during the execution of the operation.