V11 SP8

Preview a File (REST API: GET)


This operation allows you to preview a backed up file on your laptop computer.

Preview is currently supported for all images and Microsoft Office file types.

By default, you can preview files that have a maximum file size limit of 10 MB. For instructions on changing the file size limit, see Changing the File Size Limit for Preview.



GET <webservice>/action/preview?appid={appId}&path={path} HTTP/1.1
Host: <host name>
Accept: application/xml
Authtoken: <authentication token>

where <webservice> is the root path used to route the API requests to the Web Server.

For more information, see Available Web Services for REST API.

Request Parameters

Name Description Required
appId The subclient ID of the subclient that was used to backup the file. If the subclient ID is not known, use the GET Subclient API to retrieve it. Yes
path The path to the file on your laptop computer. Specify the path relative from the root.

Note: Special characters and spaces must be encoded before they are sent in the request. For example, spaces must be encoded with a plus sign: test+results.txt.


Request Headers

Name Description
Host The host name of the Web Server or Web Console used in the API request.
Accept The format of the response. Valid values are: application/xml or application/json.
Authtoken The authentication token received after successfully logging on. For details on receiving an authentication token, see Authentication.


Sample Request

GET <webservice>/action/preview?appid=4&path=C:\Images\Penguins.jpg HTTP/1.1
Host: client.mydomain.com
Accept: application/xml
Authtoken: QSDK 38568012f4d1e8ee1841d283a47aa3ba78e124ea58354b5fc6

Supported Error Codes

Code Status Description
400 Bad Request The request is missing required parameters or the file name has some unacceptable characters.
204 No Content Preview is not available for the file.
403 Forbidden User does not have permissions to preview or the preview is requested for a folder or an unsupported file type.
404 Not Found The specified file does not exist.