Download Backed up Data

Purpose

To download the backed up data files for your Zoho CRM account.

Endpoints

GET /{zgid}/backup/{job-id}/{file-name}

Request Details

Request URL

{download-domain}/v2/crm/{zgid}/backup/{job-id}/{file-name}

Header

Authorization: Zoho-oauthtoken d92d4xxxxxxxxxxxxx15f52

Scope

ZohoFiles.files.ALL

Possible operation types

ALL - Full access to backup files

To download the back up files, use the URLs from the Get backup download URLs API response. The response contains data_links and attachment_links.

For example, a typical download URL will look like this:
https://download-accl.zoho.com/v2/crm/123456789/backup/3652397000001763003/Data_001.zip
Here, 123456789 is the unique ID (zgid) of the org whose data you have backed up,
3652397000001763003 is the ID of the backup job, and
Data_001.zip is the file name.

Sample Request

Copiedcurl "https://download-accl.zoho.com/v2/crm/75734565104/backup/4876876000001781013/Data_001.zip"
-X GET
-H "Authorization: Zoho-oauthtoken 1000.8cb99dxxxxxxxxxxxxx9be93.9b8xxxxxxxxxxxxxxxf"

Note

The maximum size for the zip file is 1GB. If the data or attachment backup for the account exceeds 1GB, it will be available as multiple files of maximum 1GB size each.

Possible Errors

INVALID_REQUEST_METHODHTTP 400
The request method is incorrect
Resolution: Use the HTTP GET method to make this API call. Any other request method will result in this error.
URL_RULE_NOT_CONFIGUREDHTTP 401
Please check if the URL trying to access is a correct one
Resolution: The request URL specified is incorrect. Specify a valid request URL. Refer to request URL section above.
INVALID_OAUTHSCOPEHTTP 401
The access token you have used to make this API call does not have the required scope
Resolution: Generate a new access token with the required scopes for this API. Refer to the Scope section at the beginning of this page for the list of required scopes.
FORBIDDENHTTP 403
Permission denied
Resolution: The user does not have permission to download backed up files. Contact your system administrator.
No ContentHTTP 405
Method Not Allowed
Resolution: Use the HTTP GET method to make this API call. Any other request method will result in this error.
INTERNAL_ERRORHTTP 500
Unexpected and unhandled exception in the server
Resolution: Contact the support team at support@zohocrm.com.