REST API - list

appliance recovery backup system name: list

Returns a list of system names for which backup archives exist under loc_spec. This operation was added in vSphere API 6.7.

Request:

HTTP request

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

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

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.

Response:

HTTP Status Code: 200

Representation:

{
    "value"[
        "obj-103",
        "obj-103"
    ]
}

Response Type:

Name Type Description
bold = required
value string[] list of system names.

Errors:

HTTP Status Code Type Description
404 not_found if loc_spec doesn't refer to an existing location on the backup server.
500 error if any error occurs during the execution of the operation.