REST API - get

appliance recovery backup system name archive: get

Returns the information for backup corresponding to given backup location and system name. This operation was added in vSphere API 6.7.

Request:

HTTP request

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

?spec.location=http%3A%2F%2Fmyurl.com
&spec.location_password=secret+string
&spec.location_user=string

Path Parameters

Name	Type	Description
Required
system_name	string	System name identifier.
archive	string	Archive identifier.

Request Query Parameters:

Name	Type	Description
bold = required
spec	location_spec	LocationSpec Structure.
spec.location	URI	Backup location URL. This attribute was added in vSphere API 6.7.
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.
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.

Response:

HTTP Status Code: 200

Representation:

{
    "value" : {
        "system_name" : "obj-103",
        "parts" : [
            "string",
            "string"
        ],
        "location" : "http://myurl.com",
        "comment" : "string",
        "version" : "string",
        "timestamp" : "2015-01-01T22:13:05.651Z"
    }
}

Response Type:

Name	Type	Description
bold = required
value	info	Info Structure.
value.timestamp	date_time	Time when this backup was completed. This attribute was added in vSphere API 6.7.
value.location	URI	Backup location URL. This attribute was added in vSphere API 6.7.
value.parts	string[]	List of parts included in the backup. This attribute was added in vSphere API 6.7.
value.version	string	The version of the appliance represented by the backup. This attribute was added in vSphere API 6.7.
value.system_name	string	The system name identifier of the appliance represented by the backup. 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`. 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`.
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 backup does not exist.
500	error	if any error occurs during the execution of the operation.