List Backup System Name Archive
If vSphere APIs begin with /rest (vs /api), any maps are consumed/returned instead as arrays of objects, each containing a key and a value property field.
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
Parameters
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
filter_spec
Required
Specification of matching backups for which information should be returned.
Header Parameters
Header Parameters
string
vmware-api-session-id
Required
Required session ID, obtained by first calling Create Session API
Example: b00db39f948d13ea1e59b4d6fce56389
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.
cURL Command
curl -H "vmware-api-session-id: b00db39f948d13ea1e59b4d6fce56389" https://{api_host}/rest/appliance/recovery/backup/system-name/{system_name}/archives?filter_spec=string&loc_spec=string
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. | com.vmware.vapi.std.errors.error : if any error occurs during the execution of the operation.
