This API has a deprecated equivalent from v7.0U1.
List Backup System Name
Returns a list of system names for which backup archives exist under locSpec.
Request
URLURL
https://{api_host}/api/appliance/recovery/backup/system-name?action=list
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"
Request Body
Request Body
{
"location": "string"
}
string
location
Required
Backup location URL.
string
location_password
Optional
Password for the given location. If unset authentication will not be used.
string
location_user
Optional
Username for the given location. If unset authentication will not be used.
Authentication
This operation uses the following authentication methods.
Response
Response
Response BodyResponse Body
200 OK returns
array of
string
of type application/json
list of system names The result will contain identifiers for the resource type: com.vmware.appliance.recovery.backup.system_name.
Errors
404
com.vmware.vapi.std.errors.not_found : if locSpec doesn’t 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
PowerCLI Client SDK Example
$RecoveryBackupLocationSpec = Initialize-RecoveryBackupLocationSpec -Location "MyLocation"
Invoke-ListBackupSystemName -RecoveryBackupLocationSpec $RecoveryBackupLocationSpec
PowerCLI Client SDK All Parameters Example
$RecoveryBackupLocationSpec = Initialize-RecoveryBackupLocationSpec -Location "MyLocation" -LocationUser "MyLocationUser" -LocationPassword "MyLocationPassword"
Invoke-ListBackupSystemName -RecoveryBackupLocationSpec $RecoveryBackupLocationSpec
cURL Command
curl -X POST -H "vmware-api-session-id: b00db39f948d13ea1e59b4d6fce56389" -H "Content-Type: application/json" -d '{"location":"string","location_password":"string","location_user":"string"}' https://{api_host}/api/appliance/recovery/backup/system-name?action=list
Vendor Extensions
This operation contains the following vendor extensions defined in the spec:
x-vmw-doc-deprecated-method: get
x-vmw-doc-deprecated-path: /rest/appliance/recovery/backup/system-name
x-vmw-doc-operation: list
Availability
Added in 7.0U2
