Get Data Backup Download URLs

Purpose

To fetch the download URLs of the latest scheduled backup of the data in your Zoho CRM account. These URLs can be used to download both the backed-up data and attachments associated with your records.

Endpoints

  • GET /backup/urls

Request Details

Request URL

{api-domain}/crm/bulk/{version}/backup/urls

Header

Authorization: Zoho-oauthtoken d92d4xxxxxxxxxxxxx15f52

Scope

ZohoCRM.bulk.backup.ALL
(or)
ZohoCRM.bulk.backup.READ

Possible operation types

ALL - Full access to backup data
READ - Fetch information about a scheduled backup

Sample Request

Copiedcurl "https://www.zohoapis.com/crm/bulk/v8/backup/urls"
-X GET
-H "Authorization: Zoho-oauthtoken 1000.8cb99dxxxxxxxxxxxxx9be93.9b8xxxxxxxxxxxxxxxf"

Response JSON Keys

  • data_linksURL

    The download URL of the scheduled backup that contains module-specific data in individual CSV files, along with module metadata and record images.
    Example: "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.

  • attachment_linksURL

    The download URL of the scheduled backup that contains all the attachments of records in all the modules.
    Example: "https://download-accl.zoho.com/v2/crm/123456789/backup/3652397000001763003/Attachments_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
    Attachments_001.zip is the file name.

  • expiry_dateDateTime

    The expiry date of the backup links, after which the files will no longer be available for download.

Note

When there are no download links available, the system responds with a No content body with status code 204.

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.

  • OAUTH_SCOPE_MISMATCHHTTP 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.

  • NO_PERMISSIONHTTP 403

    Permission denied to read
    Resolution: The user does not have permission to read data backup history data. Contact your system administrator.

  • INVALID_URL_PATTERNHTTP 404

    The request URL is incorrect.
    Resolution: Specify a valid request URL. Refer to the request URL section at the beginning of this page for more details.

  • INTERNAL_ERRORHTTP 500

    Internal Server Error
    Resolution: Unexpected and unhandled exception in Server. Contact support team.

Sample Response

Copied{
    "urls": {
        "data_links": [
            "https://download-accl.zoho.com/v2/crm/757345985/backup/4876876000001594004/Data_001.zip"
        ],
        "attachment_links": [
            "https://download-accl.zoho.com/v2/crm/757345985/backup/4876876000001594004/Attachments_001.zip"
        ],
        "expiry_date": "2022-06-30T17:31:03+05:30"
    }
}