List Backup System Name Archive Deprecated
Returns information about backup archives corresponding to given backup location and system name, which match the Archive.FilterSpec.
Request
URLURL
https://{api_host}/rest/appliance/recovery/backup/system-name/{system_name}/archives
Path Parameters
Path Parameters
string
system_name
Required
System name identifier. The parameter must be an identifier for the resource type: com.vmware.appliance.recovery.backup.system_name.
Query Parameters
Query Parameters
string
filter_spec.comment_substring
Optional
Backup comment must contain this string to match the filter. If unset the filter will match backups with any comment.
string
filter_spec.end_timestamp
Optional
Backup must have been taken on or before this time to match the filter. If unset the filter will match most recent backups.
integer
filter_spec.max_results
Optional
Limit result to a max count of most recent backups. If unset it defaults to 128.
string
filter_spec.start_timestamp
Optional
Backup must have been taken on or after this time to match the filter. If unset the filter will match oldest backups.
string
loc_spec.location
Optional
Backup location URL.
string
loc_spec.location_password
Optional
Password for the given location. If unset authentication will not be used.
string
loc_spec.location_user
Optional
Username for the given location. If unset authentication will not be used.
Header Parameters
Header Parameters
string
vmware-api-session-id
Required
Required session ID, acquired from Create Session API under CIS product
vmware-api-session-id example
"b00db39f948d13ea1e59b4d6fce56389"
Authentication
This operation uses the following authentication methods.
Response
Response
Response BodyResponse Body
200 OK returns
RecoveryBackupSystemNameArchiveListResponseBody of type application/json
Commonly used information about the backup archives.
{
"value": [
{
"archive": "string",
"comment": "string",
"timestamp": "string",
"version": "string"
}
]
}
value
Optional
Commonly used information about the backup archives.
Errors
404
com.vmware.vapi.std.errors.not_found : if combination of locSpec and system name does not refer to an existing location on the backup server.
500
com.vmware.vapi.std.errors.error : if any error occurs during the execution of the operation.
default
‘Default’ means this response is used for all HTTP codes that are not covered individually for this operation.
Code Samples
cURL Command
curl -H "vmware-api-session-id: b00db39f948d13ea1e59b4d6fce56389" https://{api_host}/rest/appliance/recovery/backup/system-name/{system_name}/archives
Vendor Extensions
This operation contains the following vendor extensions defined in the spec:
x-vmw-doc-new-method: post
x-vmw-doc-new-path: /api/appliance/recovery/backup/system-name/{system_name}/archives?action=list
x-vmw-doc-operation: list
Availability
Added in 6.7
